<!-- Auto-generated from Telnyx OpenAPI specs. Do not edit. -->

Telnyx Numbers Services - JavaScript

Installation

npm install telnyx@6.74.2

Setup

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
  publicKey: process.env['TELNYX_PUBLIC_KEY'], // Required for client.webhooks.unwrap() (webhook verification)
});

All examples below assume client is already initialized as shown above.

Error Handling

All API calls can fail with network errors, rate limits (429), validation errors (422), or authentication errors (401). Always handle errors in production code:

try {
  const result = await client.messages.send({ to: '+13125550001', from: '+13125550002', text: 'Hello' });
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    // 429: rate limited — wait, then retry the request (bounded exponential backoff)
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
    // ...retry the call here (give up after a few attempts)
  } else if (err instanceof Telnyx.APIError) {
    console.error(`API error ${err.status}: ${err.message}`);
    if (err.status === 422) {
      console.error('Validation error — check required fields and formats');
    }
  }
  throw err; // Re-throw: a failed request must never look like success to the caller
}

Common error codes: 401 invalid API key, 403 insufficient permissions, 404 resource not found, 422 validation error (check field formats), 429 rate limited (retry with exponential backoff).

Important Notes

• Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

List your voice channels for non-US zones

Returns the non-US voice channels for your account. voice channels allow you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.

GET /channel_zones

// Automatically fetches more pages as needed.
for await (const channelZoneListResponse of client.channelZones.list()) {
  console.log(channelZoneListResponse.id);
}

Returns: channels (int64), countries (array[string]), created_at (string), id (string), name (string), record_type (enum: channel_zone), updated_at (string)

Update voice channels for non-US Zones

Update the number of Voice Channels for the Non-US Zones. This allows your account to handle multiple simultaneous inbound calls to Non-US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume.

PUT /channel_zones/{channel_zone_id} — Required: channels

const channelZone = await client.channelZones.update('channel_zone_id', { channels: 0 });

console.log(channelZone.id);

Returns: channels (int64), countries (array[string]), created_at (string), id (string), name (string), record_type (enum: channel_zone), updated_at (string)

List dynamic emergency addresses

Returns the dynamic emergency addresses according to filters

GET /dynamic_emergency_addresses

// Automatically fetches more pages as needed.
for await (const dynamicEmergencyAddress of client.dynamicEmergencyAddresses.list()) {
  console.log(dynamicEmergencyAddress.id);
}

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

Create a dynamic emergency address.

Creates a dynamic emergency address, the validated physical location used when provisioning dynamic emergency endpoints.

POST /dynamic_emergency_addresses — Required: house_number, street_name, locality, administrative_area, postal_code, country_code

Optional: created_at (string), extended_address (string), house_suffix (string), id (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

const dynamicEmergencyAddress = await client.dynamicEmergencyAddresses.create({
  administrative_area: 'TX',
  country_code: 'US',
  house_number: '600',
  locality: 'Austin',
  postal_code: '78701',
  street_name: 'Congress',
});

console.log(dynamicEmergencyAddress.data);

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

Get a dynamic emergency address

Returns the dynamic emergency address based on the ID provided

GET /dynamic_emergency_addresses/{id}

const dynamicEmergencyAddress = await client.dynamicEmergencyAddresses.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(dynamicEmergencyAddress.data);

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

Delete a dynamic emergency address

Deletes the dynamic emergency address based on the ID provided

DELETE /dynamic_emergency_addresses/{id}

const dynamicEmergencyAddress = await client.dynamicEmergencyAddresses.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(dynamicEmergencyAddress.data);

Returns: administrative_area (string), country_code (enum: US, CA, PR), created_at (string), extended_address (string), house_number (string), house_suffix (string), id (string), locality (string), postal_code (string), record_type (string), sip_geolocation_id (string), status (enum: pending, activated, rejected), street_name (string), street_post_directional (string), street_pre_directional (string), street_suffix (string), updated_at (string)

List dynamic emergency endpoints

Returns the dynamic emergency endpoints according to filters

GET /dynamic_emergency_endpoints

// Automatically fetches more pages as needed.
for await (const dynamicEmergencyEndpoint of client.dynamicEmergencyEndpoints.list()) {
  console.log(dynamicEmergencyEndpoint.dynamic_emergency_address_id);
}

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

Create a dynamic emergency endpoint.

Creates a dynamic emergency endpoint, associating a callback number and location with a device for emergency calling.

POST /dynamic_emergency_endpoints — Required: dynamic_emergency_address_id, callback_number, caller_name

Optional: created_at (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

const dynamicEmergencyEndpoint = await client.dynamicEmergencyEndpoints.create({
  callback_number: '+13125550000',
  caller_name: 'Jane Doe Desk Phone',
  dynamic_emergency_address_id: '0ccc7b54-4df3-4bca-a65a-3da1ecc777f0',
});

console.log(dynamicEmergencyEndpoint.data);

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

Get a dynamic emergency endpoint

Returns the dynamic emergency endpoint based on the ID provided

GET /dynamic_emergency_endpoints/{id}

const dynamicEmergencyEndpoint = await client.dynamicEmergencyEndpoints.retrieve(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(dynamicEmergencyEndpoint.data);

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

Delete a dynamic emergency endpoint

Deletes the dynamic emergency endpoint based on the ID provided

DELETE /dynamic_emergency_endpoints/{id}

const dynamicEmergencyEndpoint = await client.dynamicEmergencyEndpoints.delete(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(dynamicEmergencyEndpoint.data);

Returns: callback_number (string), caller_name (string), created_at (string), dynamic_emergency_address_id (string), id (string), record_type (string), sip_from_id (string), status (enum: pending, activated, rejected), updated_at (string)

List your voice channels for US Zone

Returns the US Zone voice channels for your account. voice channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.

GET /inbound_channels

const inboundChannels = await client.inboundChannels.list();

console.log(inboundChannels.data);

Returns: channels (integer), record_type (string)

Update voice channels for US Zone

Update the number of Voice Channels for the US Zone. This allows your account to handle multiple simultaneous inbound calls to US numbers. Use this endpoint to increase or decrease your capacity based on expected call volume.

PATCH /inbound_channels — Required: channels

const inboundChannel = await client.inboundChannels.update({ channels: 7 });

console.log(inboundChannel.data);

Returns: channels (integer), record_type (string)

List All Numbers using Channel Billing

Retrieve a list of all phone numbers using Channel Billing, grouped by Zone.

GET /list

const response = await client.list.retrieveAll();

console.log(response.data);

Returns: number_of_channels (integer), numbers (array[object]), zone_id (string), zone_name (string)

List Numbers using Channel Billing for a specific Zone

Retrieve a list of phone numbers using Channel Billing for a specific Zone.

GET /list/{channel_zone_id}

const response = await client.list.retrieveByZone('channel_zone_id');

console.log(response.data);

Returns: number_of_channels (integer), numbers (array[object]), zone_id (string), zone_name (string)

Get voicemail

Returns the voicemail settings for a phone number

GET /phone_numbers/{phone_number_id}/voicemail

const voicemail = await client.phoneNumbers.voicemail.retrieve('123455678900');

console.log(voicemail.data);

Returns: enabled (boolean), greeting (object), pin (string)

Create voicemail

Create voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode custom_greeting together with a media_name that points to an audio file uploaded through the Media Storage API, or mode default to use the standard system greeting.

POST /phone_numbers/{phone_number_id}/voicemail

Optional: enabled (boolean), greeting (object), pin (string)

const voicemail = await client.phoneNumbers.voicemail.create('123455678900');

console.log(voicemail.data);

Returns: enabled (boolean), greeting (object), pin (string)

Update voicemail

Update voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode custom_greeting together with a media_name that points to an audio file uploaded through the Media Storage API, or mode default to use the standard system greeting.

PATCH /phone_numbers/{phone_number_id}/voicemail

Optional: enabled (boolean), greeting (object), pin (string)

const voicemail = await client.phoneNumbers.voicemail.update('123455678900');

console.log(voicemail.data);

Returns: enabled (boolean), greeting (object), pin (string)