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 externalConnectionPhoneNumber of client.externalConnections.phoneNumbers.list('id')) {
  console.log(externalConnectionPhoneNumber.civic_address_id);
}

{
  "data": [
    {
      "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
      "telephone_number": "<string>",
      "number_id": "<string>",
      "civic_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "displayed_country_code": "<string>",
      "acquired_capabilities": [
        "FirstPartyAppAssignment"
      ]
    }
  ],
  "meta": {
    "total_pages": 3,
    "page_number": 2,
    "total_results": 55,
    "page_size": 25
  }
}

GET

external_connections

{id}

phone_numbers

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 externalConnectionPhoneNumber of client.externalConnections.phoneNumbers.list('id')) {
  console.log(externalConnectionPhoneNumber.civic_address_id);
}

{
  "data": [
    {
      "ticket_id": "542c3bca-d247-42bc-8fe7-e01d16ecd761",
      "telephone_number": "<string>",
      "number_id": "<string>",
      "civic_address_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "location_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "displayed_country_code": "<string>",
      "acquired_capabilities": [
        "FirstPartyAppAssignment"
      ]
    }
  ],
  "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 phone numbers (deepObject style). Supports filtering by phone_number, civic_address_id, and location_id with eq/contains operations.

Show child attributes

filter[phone_number]

object

Show child attributes

filter[phone_number][eq]

string

The phone number to filter by (exact match)

Example:

"+19705555098"

filter[phone_number][contains]

string

The phone number to filter by (partial match)

Example:

"+1970"

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"

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 details with relation to an external connection · object[]

Show child attributes

data.ticket_id

string<uuid>

Uniquely identifies the resource.

Example:

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

data.telephone_number

string

Phone number in E164 format.

data.number_id

string

Phone number ID from the Telnyx API.

data.civic_address_id

string<uuid>

Identifies the civic address assigned to the phone number.

data.location_id

string<uuid>

Identifies the location assigned to the phone number.

data.displayed_country_code

string

The iso country code that will be displayed to the user when they receive a call from this phone number.

data.acquired_capabilities

enum<string>[]

The capabilities that are available for this phone number on Microsoft Teams.

Available options:

FirstPartyAppAssignment,

InboundCalling,

Office365,

OutboundCalling,

UserAssignment

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

List all phone numbers

Authorizations

Path Parameters

Query Parameters

Response