Telnyx Numbers Config - JavaScript

Installation

npm install [email protected]

Setup

import Telnyx from 'telnyx';

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

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 and retry with exponential backoff
    const retryAfter = err.headers?.['retry-after'] || 1;
    await new Promise(r => setTimeout(r, retryAfter * 1000));
  } 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');
    }
  }
}

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

Phone numbers must be in E.164 format (e.g., +13125550001). Include the + prefix and country code. No spaces, dashes, or parentheses.
Pagination: List methods return an auto-paginating iterator. Use for await (const item of result) { ... } to iterate through all pages automatically.

Bulk update phone number profiles

POST /messagingnumbersbulkupdates — Required: messagingprofile_id, numbers

Optional: assign_only (boolean)

const messagingNumbersBulkUpdate = await client.messagingNumbersBulkUpdates.create({
  messaging_profile_id: '00000000-0000-0000-0000-000000000000',
  numbers: ['+18880000000', '+18880000001', '+18880000002'],
});

console.log(messagingNumbersBulkUpdate.data);

Returns: failed (array[string]), orderid (uuid), pending (array[string]), recordtype (enum: messagingnumbersbulk_update), success (array[string])

Retrieve bulk update status

GET /messagingnumbersbulkupdates/{orderid}

const messagingNumbersBulkUpdate = await client.messagingNumbersBulkUpdates.retrieve('order_id');

console.log(messagingNumbersBulkUpdate.data);

Returns: failed (array[string]), orderid (uuid), pending (array[string]), recordtype (enum: messagingnumbersbulk_update), success (array[string])

List mobile phone numbers with messaging settings

GET /mobilephonenumbers/messaging

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

Returns: countrycode (string), createdat (date-time), features (object), id (string), messagingproduct (string), messagingprofileid (string | null), organizationid (string), phonenumber (string), recordtype (enum: messagingphonenumber, messagingsettings), tags (array[string]), traffictype (string), type (enum: longcode), updated_at (date-time)

Retrieve a mobile phone number with messaging settings

GET /mobilephonenumbers/{id}/messaging

const messaging = await client.mobilePhoneNumbers.messaging.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(messaging.data);

List phone numbers

GET /phone_numbers

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

Returns: activatedat (object), billinggroupid (string | null), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string | null), connectionname (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), deletionlockenabled (boolean), emergencyaddressid (string | null), emergencyenabled (boolean), emergencystatus (enum: active, deprovisioning, disabled, provisioning, provisioning-failed), externalpin (string | null), hdvoiceenabled (boolean), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), messagingprofileid (string | null), messagingprofilename (string | null), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline, tollfree, shortcode, longcode), purchasedat (string), recordtype (string), sourcetype (object), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), t38faxgatewayenabled (boolean), tags (array[string]), updated_at (string)

Verify ownership of phone numbers

Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account.

POST /phonenumbers/actions/verifyownership — Required: phone_numbers

const response = await client.phoneNumbers.actions.verifyOwnership({
  phone_numbers: ['+15551234567'],
});

console.log(response.data);

Returns: found (array[object]), notfound (array[string]), recordtype (string)

Lists the phone numbers jobs

GET /phone_numbers/jobs

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

Returns: createdat (string), etc (date-time), failedoperations (array[object]), id (uuid), pendingoperations (array[object]), phonenumbers (array[object]), recordtype (string), status (enum: pending, inprogress, completed, failed, expired), successfuloperations (array[object]), type (enum: updateemergencysettings, deletephonenumbers, updatephonenumbers), updatedat (string)

Delete a batch of numbers

Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call.

POST /phonenumbers/jobs/deletephonenumbers — Required: phonenumbers

const response = await client.phoneNumbers.jobs.deleteBatch({
  phone_numbers: ['+19705555098', '+19715555098', '32873127836'],
});

console.log(response.data);

Update the emergency settings from a batch of numbers

Creates a background job to update the emergency settings of a collection of phone numbers. At most one thousand numbers can be updated per API call.

POST /phonenumbers/jobs/updateemergencysettings — Required: emergencyenabled, phone_numbers

Optional: emergencyaddressid (string | null)

const response = await client.phoneNumbers.jobs.updateEmergencySettingsBatch({
  emergency_enabled: true,
  phone_numbers: ['+19705555098', '+19715555098', '32873127836'],
});

console.log(response.data);

Update a batch of numbers

Creates a new background job to update a batch of numbers. At most one thousand numbers can be updated per API call. At least one of the updateable fields must be submitted.

POST /phonenumbers/jobs/updatephonenumbers — Required: phonenumbers

Optional: billinggroupid (string), connectionid (string), customerreference (string), deletionlockenabled (boolean), externalpin (string), hdvoice_enabled (boolean), tags (array[string]), voice (object)

const response = await client.phoneNumbers.jobs.updateBatch({
  phone_numbers: ['1583466971586889004', '+13127367254'],
});

console.log(response.data);

Retrieve a phone numbers job

GET /phone_numbers/jobs/{id}

const job = await client.phoneNumbers.jobs.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(job.data);

List phone numbers with messaging settings

GET /phone_numbers/messaging

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

Returns: countrycode (string), createdat (date-time), eligiblemessagingproducts (array[string]), features (object), health (object), id (string), messagingproduct (string), messagingprofileid (string | null), organizationid (string), phonenumber (string), recordtype (enum: messagingphonenumber, messagingsettings), tags (array[string]), traffictype (string), type (enum: long-code, toll-free, short-code, longcode, tollfree, shortcode), updated_at (date-time)

Slim List phone numbers

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.

GET /phone_numbers/slim

// Automatically fetches more pages as needed.
for await (const phoneNumberSlimListResponse of client.phoneNumbers.slimList()) {
  console.log(phoneNumberSlimListResponse.id);
}

Returns: activatedat (object), billinggroupid (string), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string), countryisoalpha2 (string), createdat (string), customerreference (string), emergencyaddressid (string), emergencyenabled (boolean), emergencystatus (enum: active, deprovisioning, disabled, provisioning, provisioning-failed), externalpin (string), hdvoiceenabled (boolean), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline, tollfree, shortcode, longcode), purchasedat (string), recordtype (string), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending, requirement-info-pending, requirement-info-under-review, requirement-info-exception, provision-pending), t38faxgatewayenabled (boolean), updated_at (string)

List phone numbers with voice settings

GET /phone_numbers/voice

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

Returns: callforwarding (object), callrecording (object), cnamlisting (object), connectionid (string), customerreference (string), emergency (object), id (string), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), phonenumber (string), recordtype (string), techprefixenabled (boolean), translatednumber (string), usagepayment_method (enum: pay-per-minute, channel)

Retrieve a phone number

GET /phone_numbers/{id}

const phoneNumber = await client.phoneNumbers.retrieve('1293384261075731499');

console.log(phoneNumber.data);

Update a phone number

PATCH /phone_numbers/{id}

Optional: addressid (string), billinggroupid (string), connectionid (string), customerreference (string), externalpin (string), hdvoiceenabled (boolean), id (string), tags (array[string])

const phoneNumber = await client.phoneNumbers.update('1293384261075731499');

console.log(phoneNumber.data);

Delete a phone number

DELETE /phone_numbers/{id}

const phoneNumber = await client.phoneNumbers.delete('1293384261075731499');

console.log(phoneNumber.data);

Returns: activatedat (object), billinggroupid (string), callforwardingenabled (boolean), callrecordingenabled (boolean), calleridnameenabled (boolean), cnamlistingenabled (boolean), connectionid (string), connectionname (string), createdat (string), customerreference (string), deletionlockenabled (boolean), emergencyaddressid (string), emergencyenabled (boolean), externalpin (string), hdvoiceenabled (boolean), id (string), messagingprofileid (string), messagingprofilename (string), phonenumber (string), phonenumbertype (enum: local, tollfree, mobile, national, sharedcost, landline), purchasedat (string), recordtype (string), status (enum: purchase-pending, purchase-failed, port-pending, port-failed, active, deleted, emergency-only, ported-out, port-out-pending), t38faxgatewayenabled (boolean), tags (array[string]), updated_at (string)

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

PATCH /phonenumbers/{id}/actions/bundlestatuschange — Required: bundleid

const response = await client.phoneNumbers.actions.changeBundleStatus('1293384261075731499', {
  bundle_id: '5194d8fc-87e6-4188-baa9-1c434bbe861b',
});

console.log(response.data);

Enable emergency for a phone number

POST /phonenumbers/{id}/actions/enableemergency — Required: emergencyenabled, emergencyaddress_id

const response = await client.phoneNumbers.actions.enableEmergency('1293384261075731499', {
  emergency_address_id: '53829456729313',
  emergency_enabled: true,
});

console.log(response.data);

Retrieve a phone number with messaging settings

GET /phone_numbers/{id}/messaging

const messaging = await client.phoneNumbers.messaging.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(messaging.data);

Update the messaging profile and/or messaging product of a phone number

PATCH /phone_numbers/{id}/messaging

Optional: messagingproduct (string), messagingprofile_id (string), tags (array[string])

const messaging = await client.phoneNumbers.messaging.update('550e8400-e29b-41d4-a716-446655440000');

console.log(messaging.data);

Retrieve a phone number with voice settings

GET /phone_numbers/{id}/voice

const voice = await client.phoneNumbers.voice.retrieve('1293384261075731499');

console.log(voice.data);

Update a phone number with voice settings

PATCH /phone_numbers/{id}/voice

Optional: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mediafeatures (object), techprefixenabled (boolean), translatednumber (string), usagepaymentmethod (enum: pay-per-minute, channel)

const voice = await client.phoneNumbers.voice.update('1293384261075731499');

console.log(voice.data);

List Mobile Phone Numbers

GET /v2/mobilephonenumbers

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

Returns: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), connectionid (string | null), connectionname (string | null), connectiontype (string | null), countryisoalpha2 (string), createdat (date-time), customerreference (string | null), id (string), inbound (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), mobilevoiceenabled (boolean), noisesuppression (enum: inbound, outbound, both, disabled), outbound (object), phonenumber (string), recordtype (string), simcardid (uuid), status (string), tags (array[string]), updated_at (date-time)

Retrieve a Mobile Phone Number

GET /v2/mobilephonenumbers/{id}

const mobilePhoneNumber = await client.mobilePhoneNumbers.retrieve('550e8400-e29b-41d4-a716-446655440000');

console.log(mobilePhoneNumber.data);

Update a Mobile Phone Number

PATCH /v2/mobilephonenumbers/{id}

Optional: callforwarding (object), callrecording (object), calleridnameenabled (boolean), cnamlisting (object), connectionid (string | null), customerreference (string | null), inbound (object), inboundcallscreening (enum: disabled, rejectcalls, flagcalls), noise_suppression (boolean), outbound (object), tags (array[string])

const mobilePhoneNumber = await client.mobilePhoneNumbers.update('550e8400-e29b-41d4-a716-446655440000');

console.log(mobilePhoneNumber.data);

telnyx-numbers-config-javascript

Installation

Similar popular skills

Also in this package

Agent compatibility

Repository health

Skill metadata

Package contents

History

SKILL.md

Telnyx Numbers Config - JavaScript

Installation

Setup

Error Handling

Important Notes

Bulk update phone number profiles

Retrieve bulk update status

List mobile phone numbers with messaging settings

Retrieve a mobile phone number with messaging settings

List phone numbers

Verify ownership of phone numbers

Lists the phone numbers jobs

Delete a batch of numbers

Update the emergency settings from a batch of numbers

Update a batch of numbers

Retrieve a phone numbers job

List phone numbers with messaging settings

Slim List phone numbers

List phone numbers with voice settings

Retrieve a phone number

Update a phone number

Delete a phone number

Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)

Enable emergency for a phone number

Retrieve a phone number with messaging settings

Update the messaging profile and/or messaging product of a phone number

Retrieve a phone number with voice settings

Update a phone number with voice settings

List Mobile Phone Numbers

Retrieve a Mobile Phone Number

Update a Mobile Phone Number