Telnyx Other APIs — Documentation Index
Account and billing, video, fax, SETI, OAuth, and platform APIs. 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/other-apis-llms-full-txt.md
Subsections
Focused per-subsection files (index + full content):Account & Billing
- Usage Reports: Generate usage and billing reports for Telnyx services. Export voice, messaging, numbers, and IoT SIM usage for any date range as CSV or via the API.
- Session Analysis: Analyze SIP session quality with Telnyx Session Analysis. Pull call detail records, MOS scores, and packet metrics to diagnose voice quality issues.
- On-Demand Reports: Generate usage reports using natural language queries. Describe the chart or breakdown you need, and the system builds it for you.
Video
- Getting Started: Telnyx’s video documentation is the perfect place to start learning about our platform. With step-by-step guides, you’ll be up and running in no time!
- Getting Started: Telnyx JavaScript Video SDK — add real-time video calling to web apps and websites with a small TypeScript-friendly library and a few lines of code.
- Room and Events: Telnyx’s video JavaScript SDK lets you manage room events and
- Tutorial: Learn how to add video to your web page with Telnyx’s easy-to-use
- Android SDK: Telnyx Android Video Client SDK — add real-time video and audio calling to native Android apps with a few lines of Kotlin or Java code.
- iOS SDK: Telnyx iOS Video Client SDK — add real-time video calls and messaging to iPhone and iPad apps with a few lines of Swift code and minimal setup.
Fax
- Getting Started: Get started with Telnyx Programmable Fax — buy a fax-enabled number, configure your connection, and send your first fax with the API or portal.
- Quickstart: Quickstart for Telnyx Programmable Fax. Send and receive faxes worldwide from your app in minutes — no fax machine, no software, just the Telnyx API.
- Receiving Webhooks: Receive Telnyx Programmable Fax webhooks for status updates on inbound and outbound faxes. Covers event types, payload, and signature verification.
- Sending Commands: Telnyx’s Programmable Fax offers an easy way to send faxes from
- Send a fax via API: Send a fax with the Telnyx Programmable Fax API. Step-by-step tutorial with code examples to submit a fax, track delivery, and handle webhooks.
- Receive a fax via API: Receive faxes from anywhere in the world with the Telnyx Programmable Fax API. Configure a fax-enabled number and handle inbound media URLs in your app.
- Email to fax: Telnyx’s Programmable Fax allows you to send faxes from your email.
API Reference (Other APIs)
AutoRechargePreferences
- List auto recharge preferences: Returns the payment auto recharge preferences.
- Update auto recharge preferences: Update payment auto recharge preferences.
Notifications
- List notification channels: List notification channels.
- Create a notification channel: Create a notification channel.
- Get a notification channel: Get a notification channel.
- Update a notification channel: Update a notification channel.
- Delete a notification channel: Delete a notification channel.
- List all Notifications Events Conditions: Returns a list of your notifications events conditions.
- List all Notifications Events: Returns a list of your notifications events.
- List all Notifications Profiles: Returns a list of your notifications profiles.
- Create a notification profile: Create a notification profile.
- Get a notification profile: Get a notification profile.
- Update a notification profile: Update a notification profile.
- Delete a notification profile: Delete a notification profile.
- List notification settings: List notification settings.
- Add a Notification Setting: Add a notification setting.
- Get a notification setting: Get a notification setting.
- Delete a notification setting: Delete a notification setting.
Addresses
- List all addresses: Returns a list of your addresses.
- Creates an address: Creates an address.
- Retrieve an address: Retrieves the details of an existing address.
- Deletes an address: Deletes an existing address.
- Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.
- Validate an address: Validates an address for emergency services.
Billing
Authentication Providers
- List all SSO authentication providers: Returns a list of your SSO authentication providers.
- Creates an authentication provider: Creates an authentication provider.
- Retrieve an authentication provider: Retrieves the details of an existing authentication provider.
- Update an authentication provider: Updates settings of an existing authentication provider.
- Deletes an authentication provider: Deletes an existing authentication provider.
IP Addresses
- List all Access IP Addresses
- Create new Access IP Address
- Retrieve an access IP address
- Delete access IP address
IP Ranges
Managed Accounts
- Lists accounts managed by the current user.: Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.
- Create a new managed account.: Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.
- Retrieve a managed account: Retrieves the details of a single managed account.
- Update a managed account: Update a single managed account.
- Disables a managed account: Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be…
- Enables a managed account: Enables a managed account and its sub-users to use Telnyx services.
- Update the amount of allocatable global outbound channels allocated to a specific managed account.: Update the amount of allocatable global outbound channels allocated to a specific managed account.
- Display information about allocatable global outbound channels for the current user.: Display information about allocatable global outbound channels for the current user. Only usable by account managers.
Organization Users
- List organization users: Returns a list of the users in your organization.
- Get organization user: Returns a user in your organization.
- Delete organization user: Deletes a user in your organization.
- Get organization users groups report: Returns a report of all users in your organization with their group memberships. This endpoint returns all users without pagination and always includes group i…
Billing Groups
- List all billing groups
- Create a billing group
- Get a billing group
- Update a billing group
- Delete a billing group
Detail Records
- Search detail records: Search for any detail record across the Telnyx Platform
MDR Detailed Reports
- Get all MDR detailed report requests: Retrieves all MDR detailed report requests for the authenticated user
- Create a new MDR detailed report request: Creates a new MDR detailed report request with the specified filters
- Get a specific MDR detailed report request: Retrieves a specific MDR detailed report request by ID
- Delete a MDR detailed report request: Deletes a specific MDR detailed report request by ID
CDR Reports
- Get all CDR report requests: Retrieves all CDR report requests for the authenticated user
- Create a new CDR report request: Creates a new CDR report request with the specified filters
- Get a specific CDR report request: Retrieves a specific CDR report request by ID
- Delete a CDR report request: Deletes a specific CDR report request by ID
- Get available CDR report fields: Retrieves all available fields that can be used in CDR reports
MDR Usage Reports
- List MDR usage reports: Fetch all previous requests for MDR usage reports.
- Create a new legacy usage V2 MDR report request: Creates a new legacy usage V2 MDR report request with the specified filters
- Get an MDR usage report: Fetch single MDR usage report by id.
- Delete a V2 legacy usage MDR report request: Deletes a specific V2 legacy usage MDR report request by ID
- Fetch all Messaging usage reports: Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown
- Create MDR Usage Report: Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period.
- Retrieve messaging report: Fetch a single messaging usage report by id
- Delete MDR Usage Report: Delete messaging usage report by id
- Generate and fetch MDR Usage Report: Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polli…
Telco Data Usage Reports
- List telco data usage reports: Retrieve a paginated list of telco data usage reports
- Submit telco data usage report: Submit a new telco data usage report
- Get telco data usage report by ID: Retrieve a specific telco data usage report by its ID
- Delete telco data usage report: Delete a specific telco data usage report by its ID
Speech to text Usage Reports
- Get speech to text usage report: Generate and fetch speech to text usage report synchronously. This endpoint will both generate and fetch the speech to text report over a specified time period.
CDR Usage Reports
- List CDR usage reports: Fetch all previous requests for cdr usage reports.
- Create a new legacy usage V2 CDR report request: Creates a new legacy usage V2 CDR report request with the specified filters
- Get a CDR usage report: Fetch single cdr usage report by id.
- Delete a V2 legacy usage CDR report request: Deletes a specific V2 legacy usage CDR report request by ID
- Generates and fetches CDR Usage Reports: Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is ne…
Usage Reports (BETA)
- Get Telnyx product usage data (BETA): Get Telnyx usage data by product, broken out by the specified dimensions
- Get Usage Reports query options (BETA): Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions
Speech to Text Batch Reports
- Get all Speech to Text batch report requests: Retrieves all Speech to Text batch report requests for the authenticated user
- Create a new Speech to Text batch report request: Creates a new Speech to Text batch report request with the specified filters
- Get a specific Speech to Text batch report request: Retrieves a specific Speech to Text batch report request by ID
- Delete a Speech to Text batch report request: Deletes a specific Speech to Text batch report request by ID
MDR Detail Reports
- Fetch all Mdr records: Fetch all Mdr records
WDR Detail Reports
- Fetches all Wdr records: Fetch all Wdr records
Session Analysis
- Get metadata overview: Returns all available record types and supported query parameters for session analysis.
- Get record type metadata: Returns detailed metadata for a specific record type, including relationships and examples.
- Get session analysis: Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages.
Webhooks
- List webhook deliveries: Lists webhook_deliveries for the authenticated user
- Find webhook_delivery details by ID: Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.
Audit Logs
- List Audit Logs: Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes.
User Tags
- List User Tags: List all user tags.
UserAddresses
- List all user addresses: Returns a list of your user addresses.
- Creates a user address: Creates a user address.
- Retrieve a user address: Retrieves the details of an existing user address.
Integration Secrets
- List integration secrets: Retrieve a list of all integration secrets configured by the user.
- Create a secret: Create a new secret with an associated identifier that can be used to securely integrate with other services.
- Delete an integration secret: Delete an integration secret given its ID.
Room Compositions
- View a list of room compositions.
- Create a room composition.: Asynchronously create a room composition.
- View a room composition.
- Delete a room composition.: Synchronously delete a room composition.
Room Participants
Room Recordings
- View a list of room recordings.
- Delete several room recordings in a bulk.
- View a room recording.
- Delete a room recording.: Synchronously delete a Room Recording.
Room Sessions
- View a list of room sessions.
- View a room session.
- End a room session.: Note: this will also kick all participants currently present in the room
- Kick participants from a room session.
- Mute participants in room session.
- Unmute participants in room session.
- View a list of room participants.
Rooms
- View a list of rooms.
- Create a room.: Synchronously create a Room.
- View a room.
- Update a room.: Synchronously update a Room.
- Delete a room.: Synchronously delete a Room. Participants from that room will be kicked out, they won’t be able to join that room anymore, and you won’t be charged anymore for…
- View a list of room sessions.
Rooms Client Tokens
- Create Client Token to join a room.: Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after
token_ttl_secs, a Refres… - Refresh Client Token to join a room.: Synchronously refresh an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after
token_ttl_secs.
SETI Observability
- Retrieve Black Box Test Results: Returns the results of the various black box tests
Programmable Fax Applications
- List all Fax Applications: This endpoint returns a list of your Fax Applications inside the ‘data’ attribute of the response. You can adjust which applications are listed by using filter…
- Creates a Fax Application: Creates a new Fax Application based on the parameters sent in the request. The application name and webhook URL are required. Once created, you can assign phon…
- Retrieve a Fax Application: Return the details of an existing Fax Application inside the ‘data’ attribute of the response.
- Update a Fax Application: Updates settings of an existing Fax Application based on the parameters of the request.
- Deletes a Fax Application: Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers.
Programmable Fax Commands
- View a list of faxes
- Send a fax: Send a fax. Files have size limits and page count limit validations. If a file is bigger than 50MB or has more than 350 pages it will fail with `file_size_limi…
- View a fax
- Delete a fax
- Cancel a fax: Cancel the outbound fax that is in one of the following states:
queued,media.processed,originatedorsending - Refresh a fax: Refreshes the inbound fax’s media_url when it has expired
Callbacks
OAuth Discovery
- Authorization server metadata: OAuth 2.0 Authorization Server Metadata (RFC 8414)
- Protected resource metadata: OAuth 2.0 Protected Resource Metadata for resource discovery
OAuth Protocol
- OAuth authorization endpoint: OAuth 2.0 authorization endpoint for the authorization code flow
- Get OAuth consent token: Retrieve details about an OAuth consent token
- Token introspection: Introspect an OAuth access token to check its validity and metadata
- JSON Web Key Set: Retrieve the JSON Web Key Set for token verification
- Dynamic client registration: Register a new OAuth client dynamically (RFC 7591)
- OAuth token endpoint: Exchange authorization code, client credentials, or refresh token for access token
OAuth Clients
- List OAuth clients: Retrieve a paginated list of OAuth clients for the authenticated user
- Create OAuth client: Create a new OAuth client
- Get OAuth client: Retrieve a single OAuth client by ID
- Update OAuth client: Update an existing OAuth client
- Delete OAuth client: Delete an OAuth client
OAuth Grants
- List OAuth grants: Retrieve a paginated list of OAuth grants for the authenticated user
- Get OAuth grant: Retrieve a single OAuth grant by ID
- Revoke OAuth grant: Revoke an OAuth grant