Telnyx Numbers — Documentation Index
Phone number search and ordering, porting, regulatory requirements, and identity. One section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Full content for this section: https://developers.telnyx.com/development/llms/numbers-llms-full-txt.md
Subsections
Focused per-subsection files (index + full content):- Global Phone Numbers (full)
- Porting (full)
- Regulatory & Documents (full)
- Identity (full)
- Number Reputation (full)
Global Phone Numbers
- Getting started with Telnyx phone number APIs: The following concepts must be understood to purchase phone numbers.
- 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.
- 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
Porting
- Port in orders: Transfer your existing phone numbers to Telnyx by creating and submitting port-in orders
- Port-in requirements: View and fulfill the regulatory requirements on Telnyx port-in orders, including LOA submission, account details, and country-specific compliance documents.
- Allowed FOC dates: Request and set a specific Firm Order Commitment (FOC) date for your Telnyx port-in order to control when phone numbers transfer to your account.
- Cancel port order: Cancel a port-in order that is no longer needed before it completes
- On-demand activations: Port your phone numbers at your convenience with flexible activation windows
- Port-in order notifications: We understand the importance of being able to track the progress
- Port-in events: View events for your port-in orders and republish notifications for specific events
- Porting additional steps: Handle additional steps that may be required before submitting a porting order
- Extensions: Port phone number extensions (extended numbers) alongside a route number for German porting orders
- Messaging + porting: Track and manage messaging activation when porting US and Canada phone numbers
- Bundles with porting: Associate bundles with porting phone numbers so bundle pricing is automatically applied when the port completes
- Port-in blocks: Port consecutive phone number blocks from another carrier, with control over which numbers activate immediately
- Port-out orders: Manage port-out requests when another carrier initiates a transfer for phone numbers on your Telnyx account
- Port out order notifications: Receive Telnyx port-out notifications to track when numbers leave your account. Configure email or webhook alerts for port-out status updates and approvals.
- Port-out events: View events for your port-out orders and republish notifications for specific events
Regulatory & Documents
- Regulatory Requirements: Tutorial for viewing and fulfilling regulatory requirements on phone number orders.
- Requirement groups: Manage and reuse regulatory requirements across multiple phone number orders by creating requirement groups
- Action requirements: Complete action requirements for international phone number orders that cannot be fulfilled through standard documentation
- Documents: Upload and manage documents used for regulatory requirements and identity verification
Identity
- Number lookup using Telnyx APIs: Lookup a phone number and retrieve information. Start building on Telnyx today.
- Telnyx verify quickstart: Telnyx Verify helps to deliver a 2FA token to any mobile number and
- DTMF confirmation: Verify phone number ownership with a single keypress. No codes - press 1 to confirm.
- Custom templates: Create and manage custom verification message templates for branded OTP communications with Telnyx Verify.
- Webhooks: Receive and verify Telnyx Verify webhooks for SMS, voice, WhatsApp, and PSD2 verifications. Includes payload structure, signing, and retry behavior.
- Security Best Practices: Protect your verification flows from fraud, abuse, and common attack vectors with these security best practices for Telnyx Verify.
- Rate Limiting & Fraud Prevention: Protect Telnyx Verify integrations from SMS pumping and toll fraud. Add server-side rate limits, geo-fencing, anomaly detection, and cost controls.
Number Reputation
- Overview: Monitor the spam reputation of your outbound calling phone numbers with Telnyx Number Reputation.
- Quickstart: Step-by-step guide to set up Number Reputation and start monitoring your phone numbers’ spam scores.
- Pricing: Number Reputation pricing — enterprise monitoring, per-check reputation queries, and per-check remediation.
- Letter of Authorization: Render, sign, upload, and manage the Letter of Authorization that Telnyx needs before activating Number Reputation.
- Reputation Settings: Enable, configure, and manage Number Reputation monitoring for your enterprise.
- Phone Numbers: Associate phone numbers for monitoring, query spam scores and risk levels, and manage ongoing reputation tracking.
- Remediation: Submit spam-flagged phone numbers for re-evaluation, then poll the request to track per-number remediation results.
API Reference (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
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.
- 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.
- Retrieve all comments
- Create a comment
- Retrieve a comment
- Mark a comment as read
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
- Update requirement group for a sub number order
- List requirement groups
- Create a new requirement group
- Get a single requirement group by ID
- Update requirement values in requirement group
- Delete a requirement group by ID
- Submit a Requirement Group for Approval
Advanced Number Orders
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
Phone Number Blocks Background Jobs
- Lists the phone number blocks jobs
- Retrieves a phone number blocks job
- 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
- 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 voice settings
- Update a phone number with 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
CSV Downloads
Bulk Phone Number Operations
- Lists the phone numbers jobs
- Retrieve a phone numbers job
- 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
Phone Number Porting
- Run a portability check: Runs a portability check, returning the results immediately.
Porting Orders
- List all porting orders: Returns a list of your porting order.
- Create a porting order: Creates a new porting order object.
- Retrieve a porting order: Retrieves the details of an existing porting order.
- Edit a porting order: Edits the details of an existing porting order.
- Delete a porting order: Deletes an existing porting order. This operation is restrict to porting orders in draft state.
- Submit a porting order.: Confirm and submit your porting order.
- Cancel a porting order: Cancel a porting order
- Activate every number in a porting order asynchronously.: Activate each number in a porting order asynchronously. This operation is limited to US FastPort orders only.
- Share a porting order: Creates a sharing token for a porting order. The token can be used to share the porting order with non-Telnyx users.
- List allowed FOC dates: Returns a list of allowed FOC dates for a porting order.
- List all comments of a porting order: Returns a list of all comments of a porting order.
- Create a comment for a porting order: Creates a new comment for a porting order.
- List all porting phone numbers: Returns a list of your porting phone numbers.
- List all associated phone numbers: Returns a list of all associated phone numbers for a porting order. Associated phone numbers are used for partial porting in GB to specify which phone numbers…
- Create an associated phone number: Creates a new associated phone number for a porting order. This is used for partial porting in GB to specify which phone numbers should be kept or disconnected.
- Delete an associated phone number: Deletes an associated phone number from a porting order.
- List all phone number blocks: Returns a list of all phone number blocks of a porting order.
- Create a phone number block: Creates a new phone number block.
- Delete a phone number block: Deletes a phone number block.
- List all phone number extensions: Returns a list of all phone number extensions of a porting order.
- Create a phone number extension: Creates a new phone number extension.
- Delete a phone number extension: Deletes a phone number extension.
- List all phone number configurations: Returns a list of phone number configurations paginated.
- Create a list of phone number configurations: Creates a list of phone number configurations.
- List LOA configurations: List the LOA configurations.
- Create a LOA configuration: Create a LOA configuration.
- Retrieve a LOA configuration: Retrieve a specific LOA configuration.
- Update a LOA configuration: Update a specific LOA configuration.
- Delete a LOA configuration: Delete a specific LOA configuration.
- Preview a LOA configuration: Preview a specific LOA configuration.
- Preview the LOA configuration parameters: Preview the LOA template that would be generated without need to create LOA configuration.
- Download a porting order loa template: Download a porting order loa template
- List additional documents: Returns a list of additional documents for a porting order.
- Create a list of additional documents: Creates a list of additional documents for a porting order.
- Delete an additional document: Deletes an additional document for a porting order.
- List porting order requirements: Returns a list of all requirements based on country/number type for this porting order.
- List verification codes: Returns a list of verification codes for a porting order.
- Send the verification codes: Send the verification code for all porting phone numbers.
- Verify the verification code for a list of phone numbers: Verifies the verification code for a list of phone numbers.
- List action requirements for a porting order: Returns a list of action requirements for a specific porting order.
- Initiate an action requirement: Initiates a specific action requirement for a porting order.
- List available carriers in the UK: List available carriers in the UK.
- List all porting events: Returns a list of all porting events.
- Show a porting event: Show a specific porting event.
- Republish a porting event: Republish a specific porting event.
- List porting related reports: List the reports generated about porting operations.
- Create a porting related report: Generate reports about porting operations.
- Retrieve a report: Retrieve a specific report generated.
- List all porting activation jobs: Returns a list of your porting activation jobs.
- Retrieve a porting activation job: Returns a porting activation job.
- Update a porting activation job: Updates the activation time of a porting activation job.
- List all exception types: Returns a list of all possible exception types for a porting order.
- Retrieve the associated V1 sub_request_id and port_request_id: Retrieve the associated V1 sub_request_id and port_request_id
Number Portout
- List portout requests: Returns the portout requests according to filters
- Get a portout request: Returns the portout request based on the ID provided
- List all comments for a portout request: Returns a list of comments for a portout request.
- Create a comment on a portout request: Creates a comment on a portout request.
- List supporting documents on a portout request: List every supporting documents for a portout request.
- Create a list of supporting documents on a portout request: Creates a list of supporting documents on a portout request.
- Update Status: Authorize or reject portout request
- List all port-out events: Returns a list of all port-out events.
- Show a port-out event: Show a specific port-out event.
- Republish a port-out event: Republish a specific port-out event.
- List eligible port-out rejection codes for a specific order: Given a port-out ID, list rejection codes that are eligible for that port-out
- List port-out related reports: List the reports generated about port-out operations.
- Create a port-out related report: Generate reports about port-out operations.
- Retrieve a report: Retrieve a specific report generated.
Requirements
- List all requirements: List all requirements with filtering, sorting, and pagination
- Retrieve a document requirement: Retrieve a document requirement record
Requirement Types
- List all requirement types: List all requirement types ordered by created_at descending
- Retrieve a requirement types: Retrieve a requirement type by id
Verified Numbers
- List all Verified Numbers: Gets a paginated list of Verified Numbers.
- Request phone number verification: Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems.
- Retrieve a verified number
- Delete a verified number
- Submit verification code
Documents
- List all document links: List all documents links ordered by created_at descending.
- List all documents: List all documents ordered by created_at descending.
- Upload a document: Upload a document.<br /><br />Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.
- Retrieve a document: Retrieve a document.
- Update a document: Update a document.
- Delete a document: Delete a document.<br /><br />A document can only be deleted if it’s not linked to a service. If it is linked to a service, it must be unlinked prior to deleti…
- Download a document: Download a document.
- Generate a temporary download link for a document: Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.
Bundles
- Retrieve Bundles: Get all allowed bundles.
- Get Bundle By Id: Get a single bundle by ID.
User Bundles
- Get User Bundles: Get a paginated list of user bundles.
- Create User Bundles: Creates multiple user bundles for the user.
- Get Unused User Bundles: Returns all user bundles that aren’t in use.
- Get User Bundle by Id: Retrieves a user bundle by its ID.
- Deactivate User Bundle: Deactivates a user bundle by its ID.
- Get User Bundle Resources: Retrieves the resources of a user bundle by its ID.
Voicemail
- Get voicemail: Returns the voicemail settings for a phone number
- Create voicemail: Create voicemail settings for a phone number
- Update voicemail: Update voicemail settings for a phone number
Voice Channels
- 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 <a…
- 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 en…
- 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…
- 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…
- List All Numbers using Channel Billing: Retrieve a list of all phone numbers using Channel Billing, grouped by Zone.
- List Numbers using Channel Billing for a specific Zone: Retrieve a list of phone numbers using Channel Billing for a specific Zone.
Dynamic Emergency Addresses
- List dynamic emergency addresses: Returns the dynamic emergency addresses according to filters
- Create a dynamic emergency address.: Creates a dynamic emergency address.
- Get a dynamic emergency address: Returns the dynamic emergency address based on the ID provided
- Delete a dynamic emergency address: Deletes the dynamic emergency address based on the ID provided
Dynamic Emergency Endpoints
- List dynamic emergency endpoints: Returns the dynamic emergency endpoints according to filters
- Create a dynamic emergency endpoint.: Creates a dynamic emergency endpoints.
- Get a dynamic emergency endpoint: Returns the dynamic emergency endpoint based on the ID provided
- Delete a dynamic emergency endpoint: Deletes the dynamic emergency endpoint based on the ID provided
Number Lookup
- Lookup phone number data: Returns information about the provided phone number.
Verify
- Trigger Call verification
- Trigger Flash call verification
- Trigger SMS verification
- Trigger WhatsApp verification
- Retrieve verification
- Verify verification code by ID
- List verifications by phone number
- Verify verification code by phone number
- List all Verify profiles: Gets a paginated list of Verify profiles.
- Create a Verify profile: Creates a new Verify profile to associate verifications with.
- Retrieve Verify profile: Gets a single Verify profile.
- Update Verify profile
- Delete Verify profile
- Retrieve Verify profile message templates: List all Verify profile message templates.
- Create message template: Create a new Verify profile message template.
- Update message template: Update an existing Verify profile message template.
Enterprises
- List enterprises: Return the enterprises you own, paginated. The default page size is 20; the maximum is 250.
- Create an enterprise: Create the legal entity (enterprise) that represents your business on the Telnyx platform.
- Get an enterprise: Retrieve a single enterprise by id. Returns
404if the id does not exist or does not belong to your account. - Replace an enterprise: Replace the enterprise’s mutable fields. Only mutable fields may be sent. Server-assigned and immutable fields (
id,record_type,created_at,updated_at… - Delete an enterprise: Soft-delete an enterprise.
Terms of Service
- Agree to the Phone Number Reputation Terms of Service: Records the authenticated user’s agreement to the current Phone Number Reputation ToS. No body required. Idempotent.
Reputation
- Get phone-number reputation settings for an enterprise: Phone Number Reputation tracks how your outbound caller-IDs are perceived (spam risk, engagement, etc.) across the call-screening ecosystem. This endpoint read…
- Enable phone-number reputation for an enterprise: Activate Phone Number Reputation for the given enterprise. Requires an uploaded Letter of Authorization document (the
loa_document_idreferences the Telnyx D… - Disable phone-number reputation for an enterprise: Disable Phone Number Reputation. All registered numbers are de-registered as a cascade. The enterprise itself is unaffected. Returns
204on success,404if… - Change the reputation refresh frequency: Update how often Telnyx refreshes the reputation data for this enterprise’s registered numbers. The new frequency takes effect on the next scheduled refresh.
- Render a phone-number reputation Letter of Authorization: Render the LOA for this enterprise as a PDF. The enterprise identity, address, and authorized-representative contact are taken from the enterprise record; the…
- Replace the reputation Letter of Authorization document: Point the enterprise’s reputation settings at a new signed LOA document. This resets LOA approval to
pending; the new document must be approved before additi… - List reputation-monitored phone numbers for an enterprise: Paginated list of phone numbers registered for reputation monitoring under this enterprise. The response includes the latest reputation snapshot per number whe…
- Register phone numbers for reputation monitoring: Add up to 100 phone numbers to reputation monitoring on this enterprise. Each must be in E.164 format (
+1NPANXXXXXXfor US/CA) and belong to your Telnyx phon… - Get a single reputation-monitored phone number: Retrieve one registered number with its latest reputation snapshot. The
phone_numberpath parameter is in E.164 format and must be URL-encoded (e.g. `%2B1949… - Remove a phone number from reputation monitoring: Stop tracking the reputation of this phone number. The number itself remains in your inventory; only the reputation registration is removed.
- List reputation-monitored phone numbers across all enterprises: Convenience alias for
GET /v2/enterprises/{enterprise_id}/reputation/numbersthat returns numbers across every enterprise you own. Useful when you don’t want… - Get a reputation-monitored number (no enterprise_id required): Convenience alias for
GET /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}. - Remove a phone number from reputation monitoring (no enterprise_id required): Convenience alias for
DELETE /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}. - List reputation remediation requests for an enterprise: Paginated list of remediation requests for this enterprise. List items omit per-number results and webhook URLs to keep the response small; call GET by id for…
- Submit phone numbers for reputation remediation: Submit a batch of phone numbers belonging to this enterprise for reputation remediation. The request is accepted asynchronously: this endpoint returns
202wi… - Get a reputation remediation request: Retrieve the full detail of a remediation request, including current status, per-number results (once available), and submission metadata.