Telnyx

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);
}

{
  "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,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

external_connections

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);
}

{
  "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,
    "page_number": 2,
    "total_results": 55,
    "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

filter[connection_name]

object

Show child attributes

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.

Example:

"My Connection"

filter[external_sip_connection]

enum<string>

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

Available options:

zoom,

operator_connect

Example:

"zoom"

filter[id]

string

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

Example:

"1930241863466354012"

filter[created_at]

string

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

Example:

"2022-12-31"

filter[phone_number]

object

Phone number filter for connections. Note: Despite the 'contains' name, this requires a full E164 match per the original specification.

Show child attributes

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.

Example:

"+15555555555"

page

object

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

Show child attributes

page[size]

integer

default:250

The size of the page

Required range: 1 <= x <= 250

page[number]

integer

default:1

The page number to load

Required range: x >= 1

Response

Successful response

data

External Connection · object[]

Show child attributes

data.id

string<int64>

Uniquely identifies the resource.

Example:

"1293384261075731499"

data.record_type

string

Identifies the type of the resource.

Example:

"external_connection"

data.active

boolean

default:true

Specifies whether the connection can be used.

Example:

false

data.credential_active

boolean

default:false

If the credential associated with this service is active.

Example:

true

data.external_sip_connection

enum<string>

default:zoom

The service that will be consuming this connection.

Available options:

zoom,

operator_connect

Example:

"zoom"

data.tags

string[]

Tags associated with the connection.

Example:

["tag1", "tag2"]

data.webhook_event_url

string<uri>

The URL where webhooks related to this connection will be sent. Must include a scheme, such as 'https'.

Example:

"https://example.com"

data.webhook_event_failover_url

string<uri> | null

default:""

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.

Example:

"https://failover.example.com"

data.webhook_api_version

enum<string>

default:1

Determines which webhook format will be used, Telnyx API v1 or v2.

Available options:

1,

2

Example:

"1"

data.webhook_timeout_secs

integer | null

Specifies how many seconds to wait before timing out a webhook.

Required range: 0 <= x <= 30

Example:

25

data.inbound

object

Show child attributes

data.inbound.channel_limit

integer

When set, this will limit the number of concurrent inbound calls to phone numbers associated with this connection.

Example:

10

data.outbound

object

Show child attributes

data.outbound.channel_limit

integer

When set, this will limit the number of concurrent outbound calls to phone numbers associated with this connection.

Example:

10

data.outbound.outbound_voice_profile_id

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

"2018-02-02T22:25:27.521Z"

data.updated_at

string

ISO 8601 formatted date indicating when the resource was updated.

Example:

"2018-02-02T22:25:27.521Z"

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List all External Connections

Authorizations

Query Parameters

Response