Skip to main content

List all External Connections

GET 
/external_connections

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.

Request

Query Parameters

    page[number] integer

    Possible values: >= 1

    Default value: 1

    The page number to load

    page[size] integer

    Possible values: >= 1 and <= 250

    Default value: 250

    The size of the page

    filter[connection_name][contains] string

    If present, connections with connection_name containing the given value will be returned. Matching is not case-sensitive. Requires at least three characters.

    filter[external_sip_connection] string

    Possible values: [zoom, operator_connect]

    If present, connections with external_sip_connection matching the given value will be returned.

    filter[id] string

    If present, connections with id matching the given value will be returned.

    filter[created_at] string

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

    filter[phone_number][contains] string

    If present, connections associated with the given phone_number will be returned. A full match is necessary with a e164 format.

Responses

200: Successful response

400: Bad request

401: Unauthorized

404: Resource not found

Request samples


curl -L 'https://api.telnyx.com/v2/external_connections' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples


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