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 releaseListResponse of client.externalConnections.releases.list('id')) {
  console.log(releaseListResponse.tenant_id);
}

{
  "data": [
    {
      "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
      "tenant_id": "ea175aba-f47c-4702-9400-efaa42688048",
      "status": "pending",
      "error_message": "<string>",
      "telephone_numbers": [
        {
          "phone_number": "<string>",
          "number_id": "<string>"
        }
      ],
      "created_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

external_connections

{id}

releases

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 releaseListResponse of client.externalConnections.releases.list('id')) {
  console.log(releaseListResponse.tenant_id);
}

{
  "data": [
    {
      "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
      "tenant_id": "ea175aba-f47c-4702-9400-efaa42688048",
      "status": "pending",
      "error_message": "<string>",
      "telephone_numbers": [
        {
          "phone_number": "<string>",
          "number_id": "<string>"
        }
      ],
      "created_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "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.

Path Parameters

string<int64>

required

Identifies the resource.

Example:

"1293384261075731499"

Query Parameters

filter

object

Filter parameter for releases (deepObject style). Supports filtering by status, civic_address_id, location_id, and phone_number with eq/contains operations.

Show child attributes

filter[status]

object

Show child attributes

filter[status][eq]

enum<string>[]

The status of the release to filter by

Available options:

pending_upload,

pending,

in_progress,

complete,

failed,

expired,

unknown

Example:

["pending", "in_progress"]

filter[civic_address_id]

object

Show child attributes

filter[civic_address_id][eq]

string

The civic address ID to filter by

Example:

"19990261512338516954"

filter[location_id]

object

Show child attributes

filter[location_id][eq]

string

The location ID to filter by

Example:

"19995665508264022121"

filter[phone_number]

object

Phone number filter operations. Use 'eq' for exact matches or 'contains' for partial matches.

Show child attributes

filter[phone_number][eq]

string<E164>

The phone number to filter by

Example:

"+1234567890"

filter[phone_number][contains]

string

The partial phone number to filter by. Requires 3-15 digits.

Example:

"+123"

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

Phone Number Release · object[]

Show child attributes

data.ticket_id

string<uuid>

Uniquely identifies the resource.

Example:

"542c3bca-d247-42bc-8fe7-e01d16ecd761"

data.tenant_id

string<uuid>

Example:

"ea175aba-f47c-4702-9400-efaa42688048"

data.status

enum<string>

default:pending_upload

Represents the status of the release on Microsoft Teams.

Available options:

pending_upload,

pending,

in_progress,

complete,

failed,

expired,

unknown

Example:

"pending"

data.error_message

string

A message set if there is an error with the upload process.

data.telephone_numbers

TnReleaseEntry · object[]

Show child attributes

data.telephone_numbers.phone_number

string

Phone number in E164 format.

data.telephone_numbers.number_id

string

Phone number ID from the Telnyx API.

data.created_at

string

ISO 8601 formatted date indicating when the resource was created.

Example:

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

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List all Releases

Authorizations

Path Parameters

Query Parameters

Response