External Connections

List all External Connections

Changed on

This endpoint returns a list of your External Connections inside the 'data' attribute of the response. External Connections are used by Telnyx customers to seamless configure SIP trunking integrations with Telnyx Partners, through External Voice Integrations in Mission Control Portal.

get/external_connections

Request

  • Base URL
    https://api.telnyx.com/v2
  • URL
    https://api.telnyx.com/v2/external_connections
  • Auth
    HTTP bearer

Query parameters

external_sip_connection'zoom' | 'operator_connect'

If present, connections with <code>external_sip_connection</code> matching the given value will be returned.

idstring

If present, connections with <code>id</code> matching the given value will be returned.

created_atstring

If present, connections with <code>created_at</code> date matching the given YYYY-MM-DD date will be returned.

Filter parameter for external connections (deepObject style). Supports filtering by connection_name, external_sip_connection, id, created_at, and phone_number.

{
  "connection_name": {
    "contains": "My Connection"
  },
  "external_sip_connection": "zoom",
  "id": "1930241863466354012",
  "created_at": "2022-12-31",
  "phone_number": {
    "contains": "+15555555555"
  }
}
sizeinteger

The size of the page

numberinteger

The page number to load

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

Successful response

Example response

{
  "data": [
    {
      "id": "1930241863466354012",
      "record_type": "external_connection",
      "external_sip_connection": "zoom",
      "credential_active": false,
      "active": false,
      "created_at": "2022-06-29T19:23:59Z",
      "updated_at": "2022-06-29T19:39:47Z",
      "outbound": {
        "outbound_voice_profile_id": "1911630617284445511"
      }
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

Changes

  • a72569d69430Revision changes
    • breaking

      the response property / became optional for the status

    • breaking

      the response property / became optional for the status

    • warning

      deleted the query request parameter page[number]

    • warning

      deleted the query request parameter page[size]

    • info

      added the new optional query request parameter page