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 connectionListResponse of client.connections.list()) {
  console.log(connectionListResponse.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "ip_connection",
      "active": true,
      "anchorsite_override": "Latency",
      "connection_name": "string",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "webhook_event_url": "https://example.com",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_api_version": "1",
      "outbound_voice_profile_id": "1293384261075731499"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

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 connectionListResponse of client.connections.list()) {
  console.log(connectionListResponse.id);
}

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "ip_connection",
      "active": true,
      "anchorsite_override": "Latency",
      "connection_name": "string",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "webhook_event_url": "https://example.com",
      "webhook_event_failover_url": "https://failover.example.com",
      "webhook_api_version": "1",
      "outbound_voice_profile_id": "1293384261075731499"
    }
  ],
  "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

Consolidated filter parameter (deepObject style). Originally: filter[connection_name], filter[fqdn], filter[outbound_voice_profile_id], filter[outbound.outbound_voice_profile_id]

Show child attributes

filter[connection_name]

object

Filter by connection_name using nested operations

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.

filter[fqdn]

string

If present, connections with an fqdn that equals the given value will be returned. Matching is case-sensitive, and the full string must match.

filter[outbound_voice_profile_id]

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

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

sort

enum<string>

default:created_at

Specifies the sort order for results. By default sorting direction is ascending. To have the results sorted in descending order add the - prefix.

That is:

connection_name: sorts the result by the connection_name field in ascending order.
-connection_name: sorts the result by the connection_name field in descending order.

If not given, results are sorted by created_at in descending order.

Available options:

created_at,

connection_name,

active

Example:

"connection_name"

Response

Successful response with a list of connections.

data

Connection · object[]

Show child attributes

data.id

string<int64>

Identifies the specific resource.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

data.record_type

string

Identifies the type of the resource.

Example:

"ip_connection"

data.active

boolean

Defaults to true

Example:

true

data.anchorsite_override

enum<string>

default:Latency

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

Available options:

Latency,

Chicago, IL,

Ashburn, VA,

San Jose, CA,

Sydney, Australia,

Amsterdam, Netherlands,

London, UK,

Toronto, Canada,

Vancouver, Canada,

Frankfurt, Germany

Example:

"Amsterdam, Netherlands"

data.connection_name

string

Example:

"string"

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"

data.webhook_event_url

string<uri> | null

The URL where webhooks related to this connection will be sent.

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.

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

string<int64>

Identifies the associated outbound voice profile.

Example:

"1293384261075731499"

data.tags

string[]

Tags associated with the connection.

Example:

["tag1", "tag2"]

AI

Real-Time Communications

WebRTC

Messaging

Numbers & Identity

Connectivity & Networking

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List connections

Authorizations

Query Parameters

Response