List all 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.

GET /external_connections

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const externalConnection of client.externalConnections.list()) {
  console.log(externalConnection.id);
}

200

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

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

filter · object

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

Show child attributes

page · object

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

Show child attributes

Response

200

application/json

Successful response

data · External Connection · object[]

Show child attributes

meta · Pagination Meta · object

Show child attributes