Telnyx

JavaScript

import Telnyx from 'telnyx';

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

const phoneNumber = await client.externalConnections.phoneNumbers.retrieve('1234567889', { id: 'id' });

console.log(phoneNumber.data);

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

GET

external_connections

{id}

phone_numbers

{phone_number_id}

JavaScript

import Telnyx from 'telnyx';

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

const phoneNumber = await client.externalConnections.phoneNumbers.retrieve('1234567889', { id: 'id' });

console.log(phoneNumber.data);

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

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"

phone_number_id

string

required

A phone number's ID via the Telnyx API

Example:

"1234567889"

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

List all phone numbers Update a phone number

⌘I

AI

Real-Time Communications

WebRTC

Messaging

Identity

Storage & Data

Account & Billing

Other Products

SETI

OAuth

Retrieve a phone number

Authorizations

Path Parameters

Response