> Fetch clean Markdown by appending `.md` to any page URL under https://signalwire.com/docs or requesting it with the HTTP header `Accept: text/markdown`. The root index at https://signalwire.com/docs/llms.txt lists the available documentation indexes. # List FreeSWITCH connectors GET https://%7BYour_Space_Name%7D.signalwire.com/api/fabric/resources/freeswitch_connectors Returns the project's FreeSWITCH Connector resources, which route communications to connected FreeSWITCH deployments. Use it to discover connectors before retrieving or changing one. Use a [Relay Application](/docs/apis/rest/relay-application/list-relay-applications) when a Relay Server SDK process handles events, or a [SIP Gateway](/docs/apis/rest/sip-gateway/list-sip-gateways) for calls sent to an external SIP destination. #### Permissions The API token used to authenticate must have the following scope(s) enabled to make a successful request: _Voice_, _Messaging_, _Fax_, or _Video_. [Learn more about API scopes](/docs/platform/your-signalwire-api-space). Reference: https://signalwire.com/docs/apis/rest/freeswitch-connector/list-freeswitch-connectors ## Authentication - `Authorization` header (basic auth, required) — SignalWire Basic Authentication using Project ID and API Token. The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password. Example: ``` Authorization: Basic base64(project_id:token) ``` ## Response ### 200 The request has succeeded. - `links` (FreeswitchConectorPaginationResponse, required) — Object containing pagination links - `data` (list of FreeswitchConnectorResponse, required) — An array of objects containing a list of FreeSWITCH connector data ## Errors ### 401 Unauthorized Error Access is unauthorized. - `error` (enum, required) - Allowed values: `Unauthorized` ### 404 Not Found Error The server cannot find the requested resource. - `error` (enum, required) - Allowed values: `Not Found` ### 500 Internal Server Error An internal server error occurred. - `error` (enum, required) - Allowed values: `Internal Server Error` ## Types ### FreeswitchConectorPaginationResponse - `self` (string, required) — The link of the current page - `first` (string, required) — The link of the first page - `next` (string, optional) — The link of the next page - `prev` (string, optional) — The link of the previous page ### FreeswitchConnectorResponse - `id` (string, required) — Unique ID of the FreeSWITCH Connector. - `project_id` (string, required) — Unique ID of the Project. - `display_name` (string, required) — Display name of the FreeSWITCH Connector Fabric Resource - `type` (enum, required) — Type of the Fabric Resource - Allowed values: `freeswitch_connector` - `created_at` (datetime, required) — Date and time when the resource was created. - `updated_at` (datetime, required) — Date and time when the resource was updated. - `freeswitch_connector` (FreeswitchConnector, required) — FreeSWITCH Connector data. ### FreeswitchConnector - `id` (string, required) — Unique ID of a FreeSWITCH Connector. - `name` (string, optional) — Name of the FreeSWITCH Connector - `caller_id` (string, optional, nullable) — Caller ID for the connector - `send_as` (string, optional, nullable) — Send as identifier ## Examples **Response** ```json { "links": { "self": "https://devspace.signalwire.com/api/fabric/resources/freeswitch_connectors?page_number=0&page_size=50&type=freeswitch_connector", "first": "https://devspace.signalwire.com/api/fabric/resources/freeswitch_connectors?page_size=50&type=freeswitch_connector", "next": "https://devspace.signalwire.com/api/fabric/resources/freeswitch_connectors?page_number=1&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=freeswitch_connector", "prev": "https://devspace.signalwire.com/api/fabric/resources/freeswitch_connectors?page_number=0&page_size=50&page_token=PAbff61159-faab-48b3-959a-3021a8f5beca&type=freeswitch_connector" }, "data": [ { "id": "993ed018-9e79-4e50-b97b-984bd5534095", "project_id": "1313fe58-5e14-4c11-bbe7-6fdfa11fe780", "display_name": "Main FreeSWITCH Server", "type": "freeswitch_connector", "created_at": "2024-05-06T12:20:00Z", "updated_at": "2024-05-06T12:20:00Z", "freeswitch_connector": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "Booking Assistant", "caller_id": "123456", "send_as": "123456" } } ] } ``` **SDK Code** ```python import requests url = "https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors" response = requests.get(url, auth=("", "")) print(response.json()) ``` ```javascript const url = 'https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors'; const credentials = btoa(":"); const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors" req, _ := http.NewRequest("GET", url, nil) req.SetBasicAuth("", "") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request.basic_auth("", "") response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors") .basicAuth("", "") .asString(); ``` ```php request('GET', 'https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors', [ 'headers' => [ ], 'auth' => ['', ''], ]); echo $response->getBody(); ``` ```csharp using RestSharp; using RestSharp.Authenticators; var client = new RestClient("https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors"); client.Authenticator = new HttpBasicAuthenticator("", ""); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let credentials = Data(":".utf8).base64EncodedString() let headers = ["Authorization": "Basic \(credentials)"] let request = NSMutableURLRequest(url: NSURL(string: "https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```