Telnyx Numbers: Regulatory & Documents — Documentation Index
Regulatory & Documents documentation within the Numbers section of the Telnyx developer docs (https://developers.telnyx.com). This file: https://developers.telnyx.com/docs/development/llms/numbers-regulatory-documents-llms-txt.md · Root index: https://developers.telnyx.com/llms.txt
Regulatory
- 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
- Documents: Upload and manage documents used for regulatory requirements and identity verification
API Reference (Regulatory & Documents)
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
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.
- 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…
- Retrieve a document: Retrieve a document.
- Update a document: Update a document.
- 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.
Regulatory Requirements
- Retrieve regulatory requirements: Returns regulatory requirements for number ordering, porting, or other supported actions. Results can be filtered by phone number, requirement group, country,…
Requirement Groups
- List requirement groups: Returns regulatory requirement groups for the account. Results can be filtered by country, number type, action, approval status, and customer reference.
- Create a new requirement group: Creates a regulatory requirement group for a country, number type, and ordering or porting action. Optional customer-reference and requirement values are retai…
- Delete a requirement group by ID: Deletes the regulatory requirement group identified by
id. The response contains the deleted requirement-group representation. - Get a single requirement group by ID: Returns the regulatory requirement group identified by
id, including its requirement values and current approval status. - Update requirement values in requirement group: Updates the customer reference or regulatory requirement values on the specified requirement group. The response contains the updated group.
- Submit a Requirement Group for Approval: Submits the specified regulatory requirement group for approval. The response contains the requirement group with its resulting approval status.
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.
- Delete a verified number: Remove a verified number from your account.
- Retrieve a verified number: Retrieve the details of a verified number on your account.
- Submit verification code: Submit the verification code received via the selected verification method to verify a phone number.
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.
- Deactivate User Bundle: Deactivates a user bundle by its ID.
- Get User Bundle by Id: Retrieves 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
- Update voicemail: Update voicemail settings for a phone number
- Create voicemail: Create 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.
- Delete a dynamic emergency address: Deletes the dynamic emergency address based on the ID provided
- Get a dynamic emergency address: Returns 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.
- Delete a dynamic emergency endpoint: Deletes the dynamic emergency endpoint based on the ID provided
- Get a dynamic emergency endpoint: Returns the dynamic emergency endpoint based on the ID provided