Telnyx Numbers Javascript

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

Telnyx Numbers - JavaScript

Installation

npm install telnyx

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 availablePhoneNumbers = await client.availablePhoneNumbers.list();
} catch (err) {
  if (err instanceof Telnyx.APIConnectionError) {
    console.error('Network error — check connectivity and retry');
  } else if (err instanceof Telnyx.RateLimitError) {
    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.

Reference Use Rules

Do not invent Telnyx parameters, enums, response fields, or webhook fields.

• If the parameter, enum, or response field you need is not shown inline in this skill, read references/api-details.md before writing code.
• Before using any operation in ## Additional Operations, read the optional-parameters section and the response-schemas section.

Core Tasks

Search available phone numbers

Number search is the entrypoint for provisioning. Agents need the search method, key query filters, and the fields returned for candidate numbers.

client.availablePhoneNumbers.list() — GET /available_phone_numbers

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

console.log(availablePhoneNumbers.data);

Response wrapper:

• items: availablePhoneNumbers.data
• pagination: availablePhoneNumbers.meta

Primary item fields:

• phoneNumber
• recordType
• quickship
• reservable
• bestEffort
• costInformation

Create a number order

Number ordering is the production provisioning step after number selection.

client.numberOrders.create() — POST /number_orders

const numberOrder = await client.numberOrders.create({
    phoneNumbers: [{"phone_number": "+18005550101"}],
});

console.log(numberOrder.data);

Primary response fields:

• numberOrder.data.id
• numberOrder.data.status
• numberOrder.data.phoneNumbersCount
• numberOrder.data.requirementsMet
• numberOrder.data.messagingProfileId
• numberOrder.data.connectionId

Check number order status

Order status determines whether provisioning completed or additional requirements are still blocking fulfillment.

client.numberOrders.retrieve() — GET /number_orders/{number_order_id}

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

console.log(numberOrder.data);

Primary response fields:

• numberOrder.data.id
• numberOrder.data.status
• numberOrder.data.requirementsMet
• numberOrder.data.phoneNumbersCount
• numberOrder.data.phoneNumbers
• numberOrder.data.connectionId

---

Important Supporting Operations

Use these when the core tasks above are close to your flow, but you need a common variation or follow-up step.

Create a number reservation

Create or provision an additional resource when the core tasks do not cover this flow.

client.numberReservations.create() — POST /number_reservations

const numberReservation = await client.numberReservations.create({
    phoneNumbers: [{"phone_number": "+18005550101"}],
});

console.log(numberReservation.data);

Primary response fields:

• numberReservation.data.id
• numberReservation.data.status
• numberReservation.data.createdAt
• numberReservation.data.updatedAt
• numberReservation.data.customerReference
• numberReservation.data.errors

Retrieve a number reservation

Fetch the current state before updating, deleting, or making control-flow decisions.

client.numberReservations.retrieve() — GET /number_reservations/{number_reservation_id}

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

console.log(numberReservation.data);

Primary response fields:

• numberReservation.data.id
• numberReservation.data.status
• numberReservation.data.createdAt
• numberReservation.data.updatedAt
• numberReservation.data.customerReference
• numberReservation.data.errors

List Advanced Orders

Inspect available resources or choose an existing resource before mutating it.

client.advancedOrders.list() — GET /advanced_orders

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

console.log(advancedOrders.data);

Response wrapper:

• items: advancedOrders.data

Primary item fields:

• id
• status
• areaCode
• comments
• countryCode
• customerReference

Create Advanced Order

Create or provision an additional resource when the core tasks do not cover this flow.

client.advancedOrders.create() — POST /advanced_orders

const advancedOrder = await client.advancedOrders.create();

console.log(advancedOrder.id);

Primary response fields:

• advancedOrder.id
• advancedOrder.status
• advancedOrder.areaCode
• advancedOrder.comments
• advancedOrder.countryCode
• advancedOrder.customerReference

Update Advanced Order

Modify an existing resource without recreating it.

client.advancedOrders.updateRequirementGroup() — PATCH /advanced_orders/{advanced-order-id}/requirement_group

const response = await client.advancedOrders.updateRequirementGroup(
  '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
);

console.log(response.id);

Primary response fields:

• response.id
• response.status
• response.areaCode
• response.comments
• response.countryCode
• response.customerReference

Get Advanced Order

Fetch the current state before updating, deleting, or making control-flow decisions.

client.advancedOrders.retrieve() — GET /advanced_orders/{order_id}

const advancedOrder = await client.advancedOrders.retrieve('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');

console.log(advancedOrder.id);

Primary response fields:

• advancedOrder.id
• advancedOrder.status
• advancedOrder.areaCode
• advancedOrder.comments
• advancedOrder.countryCode
• advancedOrder.customerReference

List available phone number blocks

Inspect available resources or choose an existing resource before mutating it.

client.availablePhoneNumberBlocks.list() — GET /available_phone_number_blocks

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

console.log(availablePhoneNumberBlocks.data);

Response wrapper:

• items: availablePhoneNumberBlocks.data
• pagination: availablePhoneNumberBlocks.meta

Primary item fields:

• phoneNumber
• costInformation
• features
• range
• recordType
• regionInformation

Retrieve all comments

Inspect available resources or choose an existing resource before mutating it.

client.comments.list() — GET /comments

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

console.log(comments.data);

Response wrapper:

• items: comments.data
• pagination: comments.meta

Primary item fields:

• id
• body
• createdAt
• updatedAt
• commentRecordId
• commentRecordType

---

Additional Operations

Use the core tasks above first. The operations below are indexed here with exact SDK methods and required params; use references/api-details.md for full optional params, response schemas, and lower-frequency webhook payloads. Before using any operation below, read the optional-parameters section and the response-schemas section so you do not guess missing fields.

Other Webhook Events

---

For exhaustive optional parameters, full response schemas, and complete webhook payloads, see references/api-details.md.

Numbers (JavaScript) — API Details

<!-- Auto-generated reference file. Do not edit. -->

Table of Contents

• Response Schemas
• Optional Parameters
• Webhook Payload Fields

Response Schemas

Returned by: List Advanced Orders, Create Advanced Order, Update Advanced Order, Get Advanced Order

Returned by: List available phone number blocks

Returned by: List available phone numbers

Returned by: Retrieve all comments

Returned by: Create a comment, Retrieve a comment, Mark a comment as read, Get country coverage

Returned by: Get coverage for a specific country

Returned by: List customer service records, Create a customer service record, Get a customer service record

Returned by: Verify CSR phone number coverage

Returned by: List inexplicit number orders, Create an inexplicit number order, Retrieve an inexplicit number order

Returned by: Create an inventory coverage request

Returned by: List mobile network operators

Returned by: List network coverage locations

Returned by: List number block orders, Create a number block order, Retrieve a number block order

Returned by: Retrieve a list of phone numbers associated to orders, Retrieve a single phone number within a number order., Update requirements for a single phone number within a number order.

Returned by: List number orders, Create a number order, Retrieve a number order, Update a number order

Returned by: List number reservations, Create a number reservation, Retrieve a number reservation, Extend a number reservation

Returned by: Retrieve the features for a list of numbers

Returned by: Lists the phone number blocks jobs, Deletes all numbers associated with a phone number block, Retrieves a phone number blocks job

Returned by: List sub number orders, Retrieve a sub number order, Update a sub number order's requirements, Cancel a sub number order

Returned by: Create a sub number orders report, Retrieve a sub number orders report

Optional Parameters

Create Advanced Order — client.advancedOrders.create()

Update Advanced Order — client.advancedOrders.updateRequirementGroup()

Create a comment — client.comments.create()

Create an inexplicit number order — client.inexplicitNumberOrders.create()

Create a number block order — client.numberBlockOrders.create()

Update requirements for a single phone number within a number order. — client.numberOrderPhoneNumbers.updateRequirements()

Create a number order — client.numberOrders.create()

Update a number order — client.numberOrders.update()

Create a number reservation — client.numberReservations.create()

Update a sub number order's requirements — client.subNumberOrders.update()

Create a sub number orders report — client.subNumberOrdersReport.create()

Webhook Payload Fields

numberOrderStatusUpdate