​

Telnyx Numbers: Global Phone Numbers — Documentation Index

Global Phone Numbers documentation within the Numbers section of the Telnyx developer docs (https://developers.telnyx.com). This file: https://developers.telnyx.com/development/llms/numbers-global-phone-numbers-llms-txt.md · Root index: https://developers.telnyx.com/llms.txt

​

Coverage

• Getting started with Telnyx phone number APIs: The following concepts must be understood to purchase phone numbers.

​

Searching

• Number search: Search the Telnyx phone number inventory for available local, toll-free, and international numbers by area code, country, features, or rate-center filters.

​

Ordering

• Number reservations: Reserve Telnyx phone numbers before purchase so they aren’t sold to another customer. Create, list, and release number reservations via the API or portal.
• Number orders: Step-by-step tutorial showing how to search inventory, create a number order, and provision phone numbers programmatically through the Telnyx API.
• Advanced Orders: Submit and track Advanced Order Requests when phone number searches return zero results - request Telnyx to acquire unavailable numbers on your behalf.
• Bulk orders: Order phone numbers in bulk by specifying quantity and search criteria without selecting specific numbers upfront

​

API Reference (Global Phone Numbers)

​

Country Coverage

• Get country coverage: Get country coverage
• Get coverage for a specific country: Get coverage for a specific country

​

Inventory Level

• Create an inventory coverage request: Creates an inventory coverage request. If locality, npa or national_destination_code is used in groupBy, and no region or locality filters are used, the whole…

​

Phone Number Search

• List available phone number blocks: Searches the Telnyx inventory for available contiguous phone-number blocks. Results can be filtered by locality, country, national destination code, and number…
• List available phone numbers: Searches the Telnyx inventory for available phone numbers. Filters support number patterns, location, number type, features, reservability, and other inventory…

​

numbers features

• Retrieve the features for a list of numbers: Retrieve the features for a list of numbers

​

Phone Number Reservations

• List number reservations: Gets a paginated list of phone number reservations.
• Create a number reservation: Creates a Phone Number Reservation for multiple numbers.
• Retrieve a number reservation: Gets a single phone number reservation.
• Extend a number reservation: Extends reservation expiry time on all phone numbers.

​

Phone Number Orders

• List number orders: Get a paginated list of number orders.
• Create a number order: Creates a phone number order.
• Retrieve a number order: Get an existing phone number order.
• Update a number order: Updates a phone number order.
• Retrieve a list of phone numbers associated to orders: Get a list of phone numbers associated to orders.
• Retrieve a single phone number within a number order.: Get an existing phone number in number order.
• Update requirements for a single phone number within a number order.: Updates requirements for a single phone number within a number order.
• List sub number orders: Get a paginated list of sub number orders.
• Retrieve a sub number order: Get an existing sub number order.
• Update a sub number order’s requirements: Updates a sub number order.
• Cancel a sub number order: Allows you to cancel a sub number order in ‘pending’ status.
• Retrieve all comments: Returns comments associated with number-order records. Results can be filtered by record type and record ID and include pagination metadata.
• Create a comment: Creates a comment associated with a supported number-order record. The response contains the created comment.
• Retrieve a comment: Returns the comment identified by id, including its associated record and comment metadata.
• Mark a comment as read: Marks the specified comment as read. The response contains the updated read state for the comment.
• Create a sub number orders report: Create a CSV report for sub number orders. The report will be generated asynchronously and can be downloaded once complete.
• Retrieve a sub number orders report: Get the status and details of a sub number orders report.
• Download a sub number orders report: Download the CSV file for a completed sub number orders report. The report status must be ‘success’ before the file can be downloaded.

​

Phone Number Block Orders

• List number block orders: Get a paginated list of number block orders.
• Create a number block order: Creates a phone number block order.
• Retrieve a number block order: Get an existing phone number block order.

​

Requirement Groups

• Update requirement group for a phone number order: Associates an existing requirement group with a phone number in a number order. The response contains the updated number-order phone-number details.
• Update requirement group for a sub number order: Associates an existing requirement group with the specified sub number order. The response contains the updated sub number order requirement-group relationship.

​

Advanced Number Orders

• List Advanced Orders: Returns the advanced number orders associated with the account. Each result includes the order configuration and its current state.
• Create Advanced Order: Creates an advanced number order from the requested order configuration. The response contains the resulting advanced order and its initial state.
• Update Advanced Order: Updates the requirement-group configuration for the specified advanced number order. The response contains the updated advanced order.
• Get Advanced Order: Returns the advanced number order identified by order_id, including its configuration and current state.

​

Inexplicit Number Orders

• List inexplicit number orders: Get a paginated list of inexplicit number orders.
• Create an inexplicit number order: Create an inexplicit number order to programmatically purchase phone numbers without specifying exact numbers.
• Retrieve an inexplicit number order: Get an existing inexplicit number order by ID.

​

Callbacks

• Number Order Status Update

​

Phone Number Blocks Background Jobs

• Lists the phone number blocks jobs: Returns background jobs that operate on phone-number blocks. Results can be filtered by job type and status, sorted by creation time, and include pagination me…
• Retrieves a phone number blocks job: Returns the status and details of the phone-number-block background job identified by id.
• Deletes all numbers associated with a phone number block: Creates a new background job to delete all the phone numbers associated with the given block. We will only consider the phone number block as deleted after all…

​

Phone Number Configurations

• List phone numbers: Returns phone numbers associated with the account. Results support pagination, sorting, and filters for number attributes, status, source, connections, billing…
• Delete a phone number: Deletes the specified phone number from the account. The response contains the phone number’s final deleted representation.
• Retrieve a phone number: Returns the detailed configuration and current state of the phone number identified by id.
• Update a phone number: Updates the configurable settings of the specified phone number. The response contains the complete updated phone-number representation.
• Change the bundle status for a phone number (set to being in a bundle or remove from a bundle): Adds the specified phone number to a bundle or removes it from a bundle according to the requested status change. The response contains the phone number with i…
• Enable emergency for a phone number: Associates emergency-service settings with the specified phone number. The operation returns the updated phone-number configuration when completed immediately…
• Retrieve a phone number with voice settings: Returns the specified phone number together with its current voice configuration.
• Update a phone number with voice settings: Updates the voice configuration for the specified phone number. The response contains the phone number with its updated voice settings.
• 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.
• Slim List phone numbers: List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit.
• List phone numbers with voice settings: Returns account phone numbers together with their voice settings. Results support pagination, sorting, and filters for number, connection name, customer refere…

​

CSV Downloads

• List CSV downloads: Returns CSV export jobs created for account phone numbers, including each export’s current status and pagination metadata.
• Create a CSV download: Starts generation of a CSV export for phone numbers matching the supplied filters. The csv_format parameter selects the output format, and the response conta…
• Retrieve a CSV download: Returns the current status and download details for the CSV export identified by id.

​

Bulk Phone Number Operations

• Lists the phone numbers jobs: Returns background jobs that operate on phone numbers. Results can be filtered by job type and sorted by creation time, and include pagination metadata.
• Retrieve a phone numbers job: Returns the status and details of the phone-number background job identified by id.
• 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.
• 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.
• 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…

​

Regulatory Requirements

• Retrieve regulatory requirements for a list of phone numbers: Retrieve the regulatory requirements that apply to a list of phone numbers.