List FreeSWITCH connectors

GET

https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors

GET

/api/fabric/resources/freeswitch_connectors

curl https://{your_space_name}.signalwire.com/api/fabric/resources/freeswitch_connectors \
     -u "<project_id>:<api_token>"

{
  "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"
      }
    }
  ]
}

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 when a Relay Server SDK process handles events, or a SIP Gateway 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.

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).

Authentication

AuthorizationBasic

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)

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

The request has succeeded.

linksobject

Object containing pagination links

datalist of objects

An array of objects containing a list of FreeSWITCH connector data

Errors

401

Unauthorized Error

404

Not Found Error

500

Internal Server Error