Skip to content
Changelog

Report a bug

Telnyx integration: operations for AI agents

Telnyx connects to Type.com as an integration. This page lists the 1409 operations documented for Claude and Codex in Type.com: 667 read, 524 write, 218 destructive.

About Telnyx

Telnyx is a communications platform offering voice, messaging, and data services through a global private network.

Categories: Email & Messaging

How to connect Telnyx to Type.com

Access
Organization connection: one shared account for the workspace.
MCP
Selected AI voice-generation operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

1409 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

1409 operations listed.

OAuth Discovery

  • Read

    Authorization server metadata

    OAuth 2.0 Authorization Server Metadata (RFC 8414)

  • Read

    Protected resource metadata

    OAuth 2.0 Protected Resource Metadata for resource discovery

Brands

  • Read

    List Brands

    This endpoint is used to list all brands associated with your organization.

  • Read

    Get Brand Feedback By Id

    Get feedback about a brand by ID. This endpoint can be used after creating or revetting a brand. Possible values for .category[].id: TAXID - Data mismatch related to tax id and its associated properties.

  • Read

    Get Brand SMS OTP Status

    Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification. This endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process.

  • Read

    Get Brand

    Returns the details of a 10DLC brand by its brandId, including the count of campaigns associated with the brand.

  • Read

    List External Vettings

    Get list of valid external vetting record for a given brand

  • Read

    Get Brand SMS OTP Status by Brand ID

    Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID.

  • Write

    Create Brand

    This endpoint is used to create a new brand. A brand is an entity created by The Campaign Registry (TCR) that represents an organization or a company. It is this entity that TCR created campaigns will be associated with.

  • Write

    Resend brand 2FA email

    Requests a new two-factor authentication email for the specified 10DLC brand. Complete verification through the link delivered to the brand contact before continuing registration.

  • Write

    Order Brand External Vetting

    Order new external vetting for a brand. Duplicate orders for the same evpId and vettingClass return 400 with code 10012 if a successful vetting exists within the last 180 days, or one is currently being processed. Failed vettings can be retried immediately.

  • Write

    Trigger Brand SMS OTP

    Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification.

  • Destructive

    Update Brand

    Update a brand's attributes by brandId.

  • Destructive

    Delete Brand

    Delete Brand. This endpoint is used to delete a brand. Note the brand cannot be deleted if it contains one or more active campaigns, the campaigns need to be inactive and at least 3 months old due to billing purposes.

  • Destructive

    Import External Vetting Record

    This operation can be used to import an external vetting record from a TCR-approved vetting provider. If the vetting provider confirms validity of the record, it will be saved with the brand and will be considered for future campaign qualification.

  • Destructive

    Revet Brand

    This operation allows you to revet the brand. However, revetting is allowed once after the successful brand registration and thereafter limited to once every 3 months.

  • Destructive

    Verify Brand SMS OTP

    Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification. Verification Flow: 1. User receives OTP via SMS after triggering 2. User submits the OTP pin through this endpoint 3.

Campaign

  • Read

    List Campaigns

    Retrieve a list of campaigns associated with a supplied brandId.

  • Read

    Get Campaign Cost

    Retrieve the campaign cost associated with a given 10DLC use case, including any carrier fees.

  • Read

    Get campaign

    Retrieve campaign details by campaignId.

  • Read

    Get Campaign Mno Metadata

    Get the campaign metadata for each MNO it was submitted to.

  • Read

    Get campaign operation status

    Retrieve campaign's operation status at MNO level.

  • Read

    Get OSR campaign attributes

    Retrieve the OSR attributes assigned to a 10DLC campaign.

  • Read

    Get Sharing Status

    Returns whether the campaign is configured for partner sharing and the current sharing state.

  • Read

    Qualify By Usecase

    This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case.

  • Write

    Accept Shared Campaign

    Manually accept a campaign shared with Telnyx

  • Write

    Submit campaign appeal for manual review

    Submits an appeal for rejected native campaigns in TELNYXFAILED or MNOREJECTED status. The appeal is recorded for manual compliance team review and the campaign status is reset to TCRACCEPTED.

  • Write

    Submit Campaign

    Before creating a campaign, use the Qualify By Usecase endpoint to ensure that the brand you want to assign a new campaign to is qualified for the desired use case of that campaign. Please note: After campaign creation, you'll only be able to edit the campaign's sample messages.

  • Destructive

    Update campaign

    Update a campaign's properties by campaignId. Please note: only sample messages are editable.

  • Destructive

    Deactivate campaign

    Terminate a campaign. Note that once deactivated, a campaign cannot be restored.

Enum

  • Read

    Get Enum

    Returns the accepted values for the selected 10DLC enumeration endpoint. Use these values when constructing brand and campaign requests.

Shared Campaigns

  • Read

    List shared partner campaigns

    Get all partner campaigns you have shared to Telnyx in a paginated fashion This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted. In other words, shared but pending campaigns are currently omitted from the response from this endpoint.

  • Read

    Get Sharing Status

    Returns the partner-sharing state for the specified campaign.

  • Read

    List Shared Campaigns

    Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion. This endpoint is currently limited to only returning shared campaigns that Telnyx has accepted.

  • Read

    Get Single Shared Campaign

    Retrieve campaign details by campaignId.

  • Write

    Update Single Shared Campaign

    Update campaign details by campaignId. Please note: Only webhook urls are editable.

Bulk Phone Number Campaigns

  • Read

    Get Assignment Task Status

    Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by taskId.

  • Read

    Get Phone Number Status

    Check the status of the individual phone number/campaign assignments associated with the supplied taskId.

  • Write

    Assign Messaging Profile To Campaign

    This endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign.

Phone Number Campaigns

  • Read

    List phone number campaigns

    Returns phone-number-to-campaign assignments for the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

  • Read

    Get Single Phone Number Campaign

    Retrieve an individual phone number/campaign assignment by phoneNumber.

  • Write

    Create New Phone Number Campaign

    Assigns a phone number to a 10DLC campaign. The assignment controls which registered campaign is used for traffic from that number.

  • Destructive

    Update Phone Number Campaign

    Replaces the 10DLC campaign assignment for the specified phone number.

  • Destructive

    Delete Phone Number Campaign

    This endpoint allows you to remove a campaign assignment from the supplied phoneNumber.

IP Addresses

  • Read

    List all Access IP Addresses

    Retrieve a paginated list of access IP addresses configured on your account.

  • Read

    Retrieve an access IP address

    Retrieve the details of a specific access IP address.

  • Write

    Create new Access IP Address

    Create a new access IP address entry on your account.

  • Destructive

    Delete access IP address

    Delete an access IP address entry from your account.

IP Ranges

  • Read

    List all Access IP Ranges

    Retrieve a paginated list of access IP ranges configured on your account.

  • Write

    Create new Access IP Range

    Create a new access IP range on your account.

  • Destructive

    Delete access IP ranges

    Delete an access IP range from your account.

SIM Cards

  • Read

    List SIM card data usage notifications

    Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters.

  • Read

    Get a single SIM card data usage notification

    Get a single SIM Card Data Usage Notification.

  • Read

    Get all SIM cards

    Get all SIM cards belonging to the user that match the given filters.

  • Read

    Validate SIM cards registration codes

    It validates whether SIM card registration codes are valid or not.

  • Read

    Get SIM card

    Returns the details regarding a specific SIM card.

  • Read

    Get activation code for an eSIM

    It returns the activation code for an eSIM. This API is only available for eSIMs. If the given SIM is a physical SIM card, or has already been installed, an error will be returned.

  • Read

    Get SIM card device details

    It returns the device details where a SIM card is currently being used.

  • Read

    Get SIM card public IP definition

    It returns the public IP requested for a SIM card.

  • Read

    List wireless connectivity logs

    This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.

  • Write

    Purchase eSIMs

    Purchases and registers the specified amount of eSIMs to the current user's account. If simcardgroupid is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used.

  • Write

    Register SIM cards

    Register the SIM cards associated with the provided registration codes to the current user's account. If simcardgroupid is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.

  • Write

    Create a new SIM card data usage notification

    Creates a new SIM card data usage notification.

  • Write

    Updates information for a SIM Card Data Usage Notification

    Updates information for a SIM Card Data Usage Notification.

  • Write

    Request bulk disabling voice on SIM cards.

    This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group. For each SIM Card a SIM Card Action will be generated. The status of the SIM Card Actions can be followed through the List SIM Card Action API.

  • Write

    Request bulk enabling voice on SIM cards.

    This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group. For each SIM Card a SIM Card Action will be generated. The status of the SIM Card Actions can be followed through the List SIM Card Action API.

  • Write

    Request bulk setting SIM card public IPs.

    This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards. For each SIM Card a SIM Card Action will be generated. The status of the SIM Card Action can be followed through the List SIM Card Action API.

  • Write

    Update a SIM card

    Updates the specified SIM card's attributes and returns the updated SIM card.

  • Write

    Request a SIM card disable

    This API disables a SIM card, disconnecting it from the network and making it impossible to consume data. The API will trigger an asynchronous operation called a SIM Card Action. Transitioning to the disabled state may take a period of time.

  • Write

    Request disabling voice on a SIM card

    This API disables voice calling on a SIM card. The SIM card will no longer be able to make or receive calls. The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.

  • Write

    Request a SIM card enable

    This API enables a SIM card, connecting it to the network and making it possible to consume data. To enable a SIM card, it must be associated with a SIM card group. The API will trigger an asynchronous operation called a SIM Card Action.

  • Write

    Request enabling voice on a SIM card

    This API enables voice calling on a SIM card. When a connectionid is provided, the SIM is associated with the specified Mobile Voice Connection. The connection must be owned by the same user and of type mobilevoice .

  • Write

    Request removing a SIM card public IP

    This API removes an existing public IP from a SIM card. The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.

  • Write

    Request setting a SIM card public IP

    This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card. The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API.

  • Write

    Request setting a SIM card to standby

    The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data. To set a SIM card to standby, it must be associated with SIM card group.

  • Destructive

    Delete SIM card data usage notifications

    Delete the SIM Card Data Usage Notification.

  • Destructive

    Deletes a SIM card

    The SIM card will be decommissioned, removed from your account and you will stop being charged. The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data.

Addresses

  • Read

    List all addresses

    Returns a paginated list of the addresses on your account, with support for filtering and sorting.

  • Read

    Validate an address

    Validates an address for emergency services.

  • Read

    Retrieve an address

    Retrieves the details of an existing address.

  • Write

    Creates an address

    Creates a new address on your account from the provided details, for use with services that require a physical address such as emergency calling and regulatory compliance. By default, the new record is validated for emergency use at creation time.

  • Write

    Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers…

    Accept the validated address suggestion for this address, replacing the original values, and finish uploading the numbers associated with it to Microsoft for Operator Connect.

  • Destructive

    Deletes an address

    Permanently deletes the specified address from your account.

Advanced Number Orders

  • Read

    List Advanced Orders

    Returns the advanced number orders associated with the account. Each result includes the order configuration and its current state.

  • Read

    Get Advanced Order

    Returns the advanced number order identified by orderid, including its configuration and current state.

  • Write

    Create Advanced Order

    Creates an advanced number order from the requested order configuration. The response contains the resulting advanced order and its initial state.

  • Write

    Update Advanced Order

    Updates the requirement-group configuration for the specified advanced number order. The response contains the updated advanced order.

Anthropic Messages

  • Write

    Create a message (Anthropic-compatible)

    Send a message to a language model using the Anthropic Messages API format. This endpoint is compatible with the Anthropic Messages API and may be used with the Anthropic JS or Python SDK by setting the base URL to https://api.telnyx.com/v2/ai/anthropic.

Assistants

  • Read

    List assistants

    Retrieve a list of all AI Assistants configured by the user.

  • Read

    List deleted assistants

    List the organization's soft-deleted assistants in the Recently Deleted list. Each entry includes deletedat and permanentlydeletedat, the point after which the assistant is erased automatically and can no longer be restored.

  • Read

    Get All Tags

    Retrieve all tags that have been applied to your AI assistants.

  • Read

    List assistant tests with pagination

    Retrieves a paginated list of assistant tests with optional filtering capabilities

  • Read

    Get all test suite names

    Retrieves a list of all distinct test suite names available to the current user

  • Read

    Get test suite run history

    Retrieves paginated history of test runs for a specific test suite with filtering options

  • Read

    Get assistant test by ID

    Retrieves detailed information about a specific assistant test

  • Read

    Get test run history for a specific test

    Retrieves paginated execution history for a specific assistant test with filtering options

  • Read

    Get specific test run details

    Retrieves detailed information about a specific test run execution

  • Read

    Get an assistant

    Retrieve an AI Assistant configuration by assistantid.

  • Read

    Get Canary Deploy

    Endpoint to get a canary deploy configuration for an assistant. Retrieves the current canary deploy configuration with all version IDs and their traffic percentages for the specified assistant.

  • Read

    Get a deleted assistant

    Retrieve a soft-deleted assistant from the Recently Deleted list by assistantid, including its deletedat and permanentlydeletedat timestamps. This is a read-only view; the assistant cannot be modified while it remains deleted.

  • Read

    List scheduled events

    Get scheduled events for an assistant with pagination and filtering

  • Read

    Get a scheduled event

    Returns the details of a single scheduled event configured for the specified assistant.

  • Read

    Get assistant texml

    Get an assistant texml by assistantid.

  • Read

    Get all versions of an assistant

    Retrieves all versions of a specific assistant with complete configuration and metadata. An assistant keeps at most 10 versions, including the main version. When an update takes it past that limit, the oldest versions are permanently deleted.

  • Read

    Get a specific assistant version

    Retrieves a specific version of an assistant by assistantid and versionid

  • Read

    List Tools

    Retrieve a list of the custom AI tools configured on your account.

  • Read

    Get Tool

    Retrieve the details of a specific AI tool.

  • Write

    Create an assistant

    Creates a new AI assistant from the provided configuration, including its model, instructions, and attached tools, and returns the created assistant.

  • Write

    Import assistants from external provider

    Import assistants from external providers. Any assistant that has already been imported will be overwritten with its latest version from the importing provider.

  • Write

    Create a new assistant test

    Creates a comprehensive test configuration for evaluating AI assistant performance

  • Write

    Trigger test suite execution

    Executes all tests within a specific test suite as a batch operation

  • Write

    Trigger a manual test run

    Initiates immediate execution of a specific assistant test

  • Write

    Update an assistant

    Updates the specified AI assistant's attributes and returns the updated assistant. The request can also control how the change is promoted across assistant versions.

  • Write

    Create Canary Deploy

    Endpoint to create a canary deploy configuration for an assistant. Creates a new canary deploy configuration with multiple version IDs and their traffic percentages for A/B testing or gradual rollouts of assistant versions.

  • Write

    Assistant Chat

    This endpoint allows a client to send a chat message to a specific AI Assistant. The assistant processes the message and returns a relevant reply based on the current conversation context.

  • Write

    Assistant Sms Chat

    Send an SMS message for an assistant. This endpoint: 1. Validates the assistant exists and has messaging profile configured 2. If shouldcreateconversation is true, creates a new conversation with metadata 3. Sends the SMS message (If text is set, this will be sent.

  • Write

    Assistant WhatsApp Chat

    Start a WhatsApp conversation with a customer from the business side. This endpoint: 1. Validates that from is a WhatsApp number on your account whose messaging profile has this assistant configured 2. Creates a new whatsappchat conversation with the provided metadata 3.

  • Write

    Clone Assistant

    Clone an existing assistant, excluding telephony and messaging settings.

  • Write

    Enhance Assistant Instructions

    Enhance an assistant's instructions using an LLM. The endpoint reads the assistant's current instructions and tools, then streams back improved instructions as they are generated.

  • Write

    Restore an assistant

    Restore a soft-deleted assistant from the Recently Deleted list. The assistant becomes fully active again with its versions and TeXML application as they were at deletion time. Restoring does not re-enable numbers or connections that were released separately after the deletion.

  • Write

    Create a scheduled event

    Create a scheduled event for an assistant

  • Write

    Add Assistant Tag

    Add a tag to an AI assistant. Tags help you organize and filter your assistants.

  • Write

    Test Assistant Tool

    Executes a test invocation of the specified webhook tool for the assistant and returns the outcome, so you can verify the webhook's behavior before relying on it in conversations.

  • Write

    Update a specific assistant version

    Updates the configuration of a specific assistant version. Can not update main version

  • Write

    Promote an assistant version to main

    Promotes a specific version to be the main/current version of the assistant. This will delete any existing canary deploy configuration and send all live production traffic to this version.

  • Write

    Create Tool

    Create a new custom AI tool that can be attached to AI assistants.

  • Write

    Update Tool

    Update the configuration of an existing AI tool.

  • Destructive

    Update an assistant test

    Updates an existing assistant test configuration with new settings

  • Destructive

    Delete an assistant test

    Permanently removes an assistant test and all associated data

  • Destructive

    Delete an assistant

    Delete an AI Assistant by assistantid. By default this performs a soft delete: the assistant moves to the Recently Deleted list and stays restorable for 30 days, after which it is permanently deleted automatically.

  • Destructive

    Update Canary Deploy

    Endpoint to update a canary deploy configuration for an assistant. Updates the existing canary deploy configuration with new version IDs and percentages. All old versions and percentages are replaces by new ones from this request.

  • Destructive

    Delete Canary Deploy

    Endpoint to delete a canary deploy configuration for an assistant. Removes all canary deploy configurations for the specified assistant.

  • Destructive

    Delete a scheduled event

    If the event is pending, this will cancel the event. Otherwise, this will simply remove the record of the event.

  • Destructive

    Remove Assistant Tag

    Removes the specified tag from the AI assistant and returns the assistant's updated tag list.

  • Destructive

    Add Assistant Tool

    Attach an existing tool to an AI assistant.

  • Destructive

    Remove Assistant Tool

    Detaches the specified tool from the AI assistant so the assistant can no longer invoke it.

  • Destructive

    Delete a specific assistant version

    Permanently removes a specific version of an assistant. Can not delete main version

  • Destructive

    Delete Tool

    Permanently deletes the specified custom AI tool from your account.

Audio

  • Write

    Transcribe speech to text

    Transcribe speech to text. This endpoint is consistent with the OpenAI Transcription API and may be used with the OpenAI JS or Python SDK.

Avatars

  • Read

    List avatars

    Returns a paginated list of the Telnyx stock avatars and custom avatars available to the authenticated organization. Custom avatars owned by other organizations are never returned.

  • Read

    Get an avatar

    Returns a Telnyx stock avatar or a custom avatar owned by the authenticated organization. A custom avatar belonging to another organization is returned as not found.

  • Write

    Create a custom avatar

    Uploads an image, validates its file type, size, safe decoding, and resolution, stores it in Telnyx-managed private storage, and creates an avatar owned by the authenticated organization.

  • Write

    Update a custom avatar

    Updates the customer-facing name of a custom avatar owned by the authenticated organization. Stock avatars cannot be modified. To replace the image, create a new custom avatar so existing references keep their original content.

Clusters

  • Read

    List all clusters

    Retrieve a paginated list of clustering tasks and their statuses.

  • Read

    Fetch a cluster

    Fetch the results of a clustering task, including the discovered clusters.

  • Read

    Fetch a cluster visualization

    Fetch a visualization image of the clusters computed by a clustering task.

  • Write

    Compute new clusters

    Starts a background task to compute how the data in an embedded storage bucket is clustered. This helps identify common themes and patterns in the data.

  • Destructive

    Delete a cluster

    Delete a clustering task and its computed results.

AI Collections

  • Read

    List collections

    Returns a paginated list of collections in your organization.

  • Read

    Get a collection by slug

    Fetches a single collection by its slug.

  • Read

    Get a collection

    Fetches a single collection by its uuid.

  • Read

    Get collection settings

    Returns the retrieval settings for a collection.

  • Read

    List collection sources

    Returns the sources attached to a collection.

  • Read

    Search collection documents

    Runs search over the documents in a collection, ranked by relevance to query. Searches currently run vector retrieval (semantic similarity).

  • Write

    Create a collection

    Creates a new collection scoped to your organization. Optionally attach sources and retrieval settings at creation time. If slug is omitted, one is derived from name and must be unique within your organization.

  • Write

    Update a collection

    Updates a collection's metadata (name and/or description). Sources and settings are managed through their own sub-resources.

  • Write

    Update collection settings

    Partially updates the collection's retrieval settings.

  • Write

    Add a collection source

    Attaches a new content source to the specified collection and returns the created source. The source's content is ingested and embedded so it becomes searchable within the collection.

  • Destructive

    Delete a collection

    Soft-deletes a collection. Its slug is freed and may be reused by a new collection.

  • Destructive

    Replace collection settings

    Replaces the collection's retrieval settings.

  • Destructive

    Replace collection sources

    Replaces the collection's entire source set. The response meta reports which sources were added, retained, and removed.

  • Destructive

    Remove a collection source

    Removes a single source from a collection.

Conversation Histories

  • Read

    Search conversation histories

    Performs semantic vector search across conversation history records. How it works: 1. The query text is embedded into a 1024-dimensional vector using the multilingual-e5-large model. 2. The vector is compared against indexed record chunks using semantic similarity search. 3.

Conversations

  • Read

    List conversations

    Retrieve a list of all AI conversations configured by the user. Supports PostgREST-style query parameters for filtering. Examples are included for the standard metadata fields, but you can filter on any field in the metadata JSON object.

  • Read

    Aggregate Conversation Insights

    Aggregate conversation insights by specified fields

  • Read

    Get Insight Template Groups

    Returns a paginated list of your insight template groups. Groups organize related insight templates that are applied together when analyzing conversations.

  • Read

    Get Insight Template Group

    Returns the details of a single insight template group, including the insight templates assigned to it.

  • Read

    Get Insight Templates

    Returns a paginated list of your insight templates. Insight templates define analyses that run over AI conversations to extract structured findings.

  • Read

    Get Insight Template

    Returns the details of a single insight template by its ID, including its configuration.

  • Read

    Get a conversation

    Retrieve a specific AI conversation by its ID.

  • Read

    Get insights for a conversation

    Retrieve insights for a specific conversation

  • Read

    Get conversation messages

    Retrieve messages for a specific conversation, including tool calls made by the assistant.

  • Write

    Create a conversation

    Creates a new AI conversation, the container for messages exchanged with an assistant, and returns the created conversation.

  • Write

    Create Insight Template Group

    Creates a new insight template group for organizing related insight templates, and returns the created group.

  • Write

    Assign Insight Template To Group

    Assigns the specified insight template to the specified insight template group.

  • Write

    Create Insight Template

    Creates a new insight template defining an analysis to run over conversations, and returns the created template.

  • Write

    Create Message

    Add a new message to the conversation. Used to insert a new messages to a conversation manually ( without using chat endpoint )

  • Destructive

    Update Insight Template Group

    Updates the specified insight template group and returns the updated group.

  • Destructive

    Delete Insight Template Group

    Permanently deletes the specified insight template group by its ID.

  • Destructive

    Unassign Insight Template From Group

    Removes the specified insight template from the specified group. The insight template itself is not deleted.

  • Destructive

    Update Insight Template

    Updates the specified insight template and returns the updated template.

  • Destructive

    Delete Insight Template

    Permanently deletes the specified insight template by its ID.

  • Destructive

    Update conversation metadata

    Update metadata for a specific conversation.

  • Destructive

    Delete a conversation

    Delete a specific conversation by its ID.

Embeddings

  • Read

    Get Tasks by Status

    Retrieve tasks for the user that are either queued, processing, failed, success or partialsuccess based on the query string. Defaults to queued and processing.

  • Read

    List embedded buckets

    Returns the list of storage buckets that have been embedded for your account, for use with similarity search.

  • Read

    Get file-level embedding statuses for a bucket

    Get all embedded files for a given user bucket, including their processing status.

  • Read

    Search for documents

    Perform a similarity search on a Telnyx Storage Bucket, returning the most similar numdocs document chunks to the query. Currently the only available distance metric is cosine similarity which will return a distance between 0 and 1.

  • Read

    Get an embedding task's status

    Check the status of a current embedding task. Will be one of the following: - queued - Task is waiting to be picked up by a worker - processing - The embedding task is running - success - Task completed successfully and the bucket is embedded - failure - Task failed and no files…

  • Write

    Embed documents

    Perform embedding on a Telnyx Storage Bucket using the a embedding model. The current supported file types are: - PDF - HTML - txt/unstructured text files - json - csv - audio / video (mp3, mp4, mpeg, mpga, m4a, wav, or webm ) - Max of 100mb file size.

  • Write

    Embed URL content

    Embed website content from a specified URL, including child pages up to 5 levels deep within the same domain. The process crawls and loads content from the main URL and its linked pages into a Telnyx Cloud Storage bucket.

  • Destructive

    Disable AI for an Embedded Bucket

    Deletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing.

Fine Tuning

  • Read

    List fine tuning jobs

    Retrieve a list of all fine tuning jobs created by the user.

  • Read

    Get a fine tuning job

    Returns the details of a single fine-tuning job by its jobid, including its current status.

  • Write

    Create a fine tuning job

    Creates a new fine-tuning job that trains a model on the provided dataset, and returns the created job.

  • Destructive

    Cancel a fine tuning job

    Cancels the specified in-progress fine-tuning job and returns the updated job.

Integrations

  • Read

    List Integrations

    Returns the list of third-party integrations available to connect to your AI assistants and workflows.

  • Read

    List User Integrations

    Returns the list of integration connections you have set up, linking your account to third-party services.

  • Read

    Get User Integration connection By Id

    Returns the details of a single integration connection by its ID.

  • Read

    List Integration By Id

    Returns the details of a single available integration, including its configuration details.

  • Destructive

    Delete Integration Connection

    Delete a specific integration connection.

MCP Servers

  • Read

    List MCP Servers

    Returns a paginated list of the MCP servers configured on your account, with optional filtering by type or URL.

  • Read

    Get MCP Server

    Retrieve details for a specific MCP server.

  • Write

    Create MCP Server

    Creates a new MCP server configuration on your account and returns the created server.

  • Destructive

    Update MCP Server

    Updates the specified MCP server's configuration and returns the updated server.

  • Destructive

    Delete MCP Server

    Permanently deletes the specified MCP server configuration from your account.

Namespaces

  • Read

    List your namespaces

    Every namespace in your organization, default among them.

  • Write

    Create a namespace

    Create a namespace. An organization can have at most five, default among them — a sixth returns 403.

  • Destructive

    Delete a namespace

    Delete a namespace and every profile and memory in it. default cannot be deleted. This cannot be undone.

Operations

  • Read

    Status of a write

    Whether a write has finished. Both ingest and remember return an operationid, and a memory is not recallable until its operation completes — extraction, embedding and consolidation all run first.

Profiles

  • Read

    List a namespace's profiles

    Profiles are never created, only written to, so this lists the ones that hold a memory. A profile whose first ingest is still running is not here yet.

  • Read

    List a profile's memories, most recent first

    Everything stored under one profile, unranked -- ask recall for the memories that answer a question. A profile that holds nothing is an empty page rather than a 404: profiles exist by being written to.

  • Read

    Read one memory, and what it came from

    One memory by its id, as recall and the listing return it, together with what it came from. A fact names its sourceid: read it with GET .../sources/{sourceid} to see what was stored.

  • Read

    List messaging profiles

    Lists messaging profiles owned by the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

  • Read

    Retrieve a messaging profile

    Returns the complete configuration of the specified messaging profile, including webhook and sender-selection settings.

  • Read

    List phone numbers associated with a messaging profile

    Returns the phone numbers currently associated with the specified messaging profile.

  • Read

    List short codes associated with a messaging profile

    Returns the short codes currently associated with the specified messaging profile.

  • Write

    Create a messaging profile

    Creates a messaging profile that controls outbound sender selection, webhook delivery, and inbound message handling for associated numbers and short codes.

  • Write

    Update a messaging profile

    Updates the supplied settings on the specified messaging profile. Settings omitted from the request remain unchanged.

  • Destructive

    Forget a profile's memories

    Delete everything held about one profile. A 2xx means none of its memories are left, and its summary goes with them. There is no undo.

  • Destructive

    Delete a messaging profile

    Deletes the specified messaging profile and returns the profile's final configuration.

Memory

  • Read

    Get a profile's precomputed summary

    The whole profile as one card, precomputed, with no query. Built for the start of a session, where there is no question to ask yet. A summary is generated in the background.

  • Read

    Preview a candidate note before saving it

    Try a candidate note on one profile and see how that profile's summary would read under it, without saving the note and without touching the stored summary.

  • Write

    Ingest a session's messages into a profile

    Store a session. Facts are extracted from whatever you send — the body is taken as any JSON value and stored whole, so a framework's own transcript shape works unchanged. messages of role/content is the conventional shape, not a requirement.

  • Write

    Recall a profile's memories, ranked

    Ranked memories for a question. Matching runs over the profile's memories and returns them in rank order with a relevance score; the score is null where the deployment's reranker is a passthrough, in which case order is the only signal.

  • Write

    Remember one fact, stored as written

    For a fact the agent has already distilled: text is stored as given, with nothing extracted from it. Send a transcript to ingest instead. Remembering the same text again writes the same memory rather than a second copy of it, so a retry is safe.

Sources

  • Read

    List a profile's sources, most recently written first

    Everything a profile has stored and extracts memories from: each ingested session, and each remembered fact, which has no session. Content is not listed; read one source for it. A source whose ingest is still queued is not here yet.

  • Read

    Read one source, with what was stored

    One source and its content, as it was stored: an ingested session's payload or a remembered fact. A source whose ingest is still queued answers 404 until it has been stored.

  • Destructive

    Forget one source

    Deletes one source -- an ingested session or a remembered fact -- together with the memories derived from it. A memory derived from this source and others is deleted too, and derived again from what remains in the background. It answers only once the source is gone.

Settings

  • Read

    Get a namespace's settings

    What is currently set for this namespace. instructions: null means none are set and summaries use the neutral default.

  • Write

    Change a namespace's settings

    Only the fields you send are changed; anything omitted is left as it is, so {} changes nothing. Sending instructions: null, or an empty or whitespace-only string, clears them and returns summaries to the neutral default. Instructions are capped at 2000 characters.

Missions

  • Read

    List missions

    Returns a paginated list of all mission definitions in your organization. Missions describe a goal and the tools, knowledge bases, and MCP servers agents may use to accomplish it.

  • Read

    List recent events

    Returns a paginated list of recent events across every mission in your organization, optionally filtered by event type. Useful for building activity feeds or monitoring dashboards.

  • Read

    List recent runs

    Returns a paginated list of recent runs across every mission in your organization, optionally filtered by run status. Useful for monitoring overall mission activity without querying each mission individually.

  • Read

    Get mission

    Get a mission by ID (includes tools, knowledgebases, mcpservers)

  • Read

    List knowledge bases

    Returns the knowledge bases attached to the specified mission. Knowledge bases provide reference content agents can draw on during runs.

  • Read

    Get knowledge base

    Returns the details of a single knowledge base attached to the specified mission.

  • Read

    List MCP servers

    Returns the MCP servers configured on the specified mission. MCP servers expose external tools and data sources agents can use during runs.

  • Read

    Get MCP server

    Returns the configuration of a single MCP server attached to the specified mission.

  • Read

    List runs for mission

    Returns a paginated list of runs for the specified mission, optionally filtered by run status, so you can track the mission's execution history over time.

  • Read

    Get run details

    Returns the full details of a single run, including its current status. Use this to poll an in-flight run or inspect the outcome of a completed one.

  • Read

    List events

    Returns a paginated list of events logged for the specified run, filterable by event type, plan step, and agent, so you can reconstruct exactly what happened during execution.

  • Read

    Get event details

    Returns the details of a single event logged for the specified run, including its type and payload.

  • Read

    Get plan

    Returns the plan for the specified run, including all plan steps and their statuses, so you can see how the mission was decomposed and how far execution has progressed.

  • Read

    Get step details

    Returns the details of a single plan step within a run's plan, including its status.

  • Read

    List linked Telnyx agents

    Returns the Telnyx agents currently linked to the specified run. Linked agents participate in executing the run's plan.

  • Read

    List tools

    Returns the tools configured on the specified mission. Tools define the actions agents may invoke while executing the mission's runs.

  • Read

    Get tool

    Returns the definition of a single tool configured on the specified mission.

  • Write

    Create mission

    Creates a new mission definition from the provided configuration and returns the created mission. Execute the mission by starting runs against it.

  • Write

    Clone mission

    Creates a copy of the specified mission as a new mission definition, so you can iterate on its configuration without modifying the original.

  • Write

    Create knowledge base

    Create a new knowledge base for a mission

  • Write

    Create MCP server

    Adds an MCP server to the specified mission, making the server's tools available to agents during runs of this mission.

  • Write

    Start a run

    Starts a new run of the specified mission and returns the created run object. Track its progress through the run detail, plan, and events endpoints.

  • Write

    Update run

    Updates a run's status and/or result and returns the updated run object. Typically used by executing agents to report progress or record the final outcome.

  • Write

    Log event

    Logs a new event against the specified run and returns the created event. Events form the run's audit trail and can reference a plan step or agent.

  • Write

    Pause run

    Pauses a currently running run and returns the updated run object. Execution halts until the run is resumed.

  • Write

    Create initial plan

    Creates the initial plan for the specified run from the provided steps and returns the created plan steps. Progress is subsequently reported by updating individual steps.

  • Write

    Add step(s) to plan

    Add one or more steps to an existing plan

  • Write

    Update step status

    Updates the status of a single plan step and returns the updated step. Typically called by the executing agent as it works through the plan.

  • Write

    Resume run

    Resumes a previously paused run and returns the updated run object, letting execution continue from where it was paused.

  • Write

    Link Telnyx agent to run

    Link a Telnyx AI agent (voice/messaging) to a run

  • Write

    Create tool

    Adds a new tool to the specified mission, defining an action agents can invoke during runs of this mission.

  • Destructive

    Update mission

    Replaces the specified mission's definition with the provided configuration and returns the updated mission.

  • Destructive

    Delete mission

    Permanently deletes the specified mission definition and returns no content on success.

  • Destructive

    Update knowledge base

    Replaces the definition of the specified knowledge base on this mission.

  • Destructive

    Delete knowledge base

    Detaches the specified knowledge base from the mission so its content is no longer available to agents in subsequent runs.

  • Destructive

    Update MCP server

    Replaces the configuration of the specified MCP server on this mission.

  • Destructive

    Delete MCP server

    Removes the specified MCP server from the mission, revoking agent access to its tools in subsequent runs.

  • Destructive

    Cancel run

    Cancels a running or paused run and returns the updated run object. A cancelled run stops executing; start a new run to execute the mission again.

  • Destructive

    Unlink Telnyx agent

    Unlinks the specified Telnyx agent from the run so it no longer participates in execution. The run itself and its history are unaffected.

  • Destructive

    Update tool

    Replaces the definition of the specified tool on this mission.

  • Destructive

    Delete tool

    Removes the specified tool from the mission so agents can no longer invoke it in subsequent runs.

Open AI Chat

  • Read

    Get available models (OpenAI-compatible)

    Lists every model currently available to your account on Telnyx Inference, including SOTA open-source LLMs hosted on Telnyx GPUs (for example moonshotai/Kimi-K2.6, zai-org/GLM-5.1-FP8, and MiniMaxAI/MiniMax-M2.7), embedding models, and any fine-tuned models you have created.

  • Write

    Create a chat completion (OpenAI-compatible)

    Chat with a language model. This endpoint is consistent with the OpenAI Chat Completions API and may be used with the OpenAI JS or Python SDK by setting the base URL to https://api.telnyx.com/v2/ai/openai.

  • Write

    Create an OpenAI-compatible response

    Create a response using Telnyx's OpenAI-compatible Responses API. This endpoint is compatible with the OpenAI Responses API and may be used with the OpenAI JS or Python SDK by setting the base URL to https://api.telnyx.com/v2/ai/openai.

Open AI Embeddings

  • Read

    List embedding models

    Returns a list of available embedding models. This endpoint is compatible with the OpenAI Models API format.

  • Write

    Create embeddings

    Creates an embedding vector representing the input text. This endpoint is compatible with the OpenAI Embeddings API and may be used with the OpenAI JS or Python SDK by setting the base URL to https://api.telnyx.com/v2/ai/openai.

Chat

  • Write

    Summarize file content

    Generate a summary of a file's contents. Supports the following text formats: - PDF, HTML, txt, json, csv Supports the following media formats (billed for both the transcription and summary): - flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm - Up to 100 MB

AI Tests

  • Read

    List scheduled test jobs

    Returns the scheduled test jobs in your organization, optionally filtered by test agent. A scheduled job runs selected scenarios on a cron expression.

  • Read

    Retrieve a scheduled test job

    Returns the specified scheduled test job.

  • Read

    List test agents

    Returns a paginated list of test agents in your organization. A test agent wraps the Telnyx AI assistant under test and drives simulated callers against it.

  • Read

    Retrieve a test agent

    Returns the specified test agent.

  • Read

    List test metrics

    Returns the metrics available in your organization, optionally filtered by test agent. Each metric scores one aspect of a conversation or scenario run.

  • Read

    Get test metric generation progress

    Returns the status of a background metric-generation job started with the generate-test-metrics endpoint.

  • Read

    Retrieve a test metric

    Returns the specified metric.

  • Read

    List test personalities

    Returns the catalogue of test personalities available to your organization. A personality describes how a simulated caller speaks: prompt, language, accent, voice, interruption level, and call-behaviour settings.

  • Read

    List test run results

    Returns a paginated list of test run batches in your organization, optionally filtered by test agent, search text, or scenarios.

  • Read

    Retrieve a test run result

    Returns the specified test run batch, optionally with per-run detail.

  • Read

    List evaluator scenarios

    Returns a paginated list of evaluator scenarios in your organization, optionally filtered by test agent or tags.

  • Read

    Export evaluator scenarios

    Exports the selected evaluator scenarios as a CSV or XLSX file download.

  • Read

    Get scenario generation progress

    Returns the status of a background scenario-generation job started with the generate-evaluator-scenarios endpoint.

  • Read

    Get improve-scenarios progress

    Returns the status of an improve-scenarios session started with the improve-evaluator-scenarios endpoint.

  • Read

    Retrieve an evaluator scenario

    Returns the specified evaluator scenario with full detail.

  • Write

    Create a scheduled test job

    Creates a scheduled test job that runs the selected scenarios on a cron expression.

  • Write

    Update a scheduled test job

    Updates the specified scheduled test job.

  • Write

    Create a test agent

    Creates a test agent in your organization. The agent wraps a Telnyx AI assistant so simulated callers can be sent against it.

  • Write

    Create a test metric

    Creates a metric in your organization.

  • Write

    Bulk create test metrics

    Creates several metrics in one request. Accepts an array of metric objects and returns the created metrics.

  • Write

    Generate test metrics

    Starts background generation of suggested metrics for a test agent. Returns a progress ID to poll with the get-test-metric-generation-progress endpoint.

  • Write

    Update a test metric

    Updates the specified metric.

  • Write

    Rerun a test run result

    Re-executes the scenarios of the specified test run batch and creates a new run batch.

  • Write

    Create an evaluator scenario

    Creates an evaluator scenario in your organization.

  • Write

    Generate evaluator scenarios

    Starts background generation of evaluator scenarios for a test agent. Returns a progress ID to poll with the generate-scenarios-progress endpoint.

  • Write

    Run evaluator scenarios

    Runs the selected evaluator scenarios against their test agents and creates a run batch. Returns the ID of the created batch, whose results can be listed with the test-run-results endpoints.

  • Write

    Improve evaluator scenarios

    Starts an interactive session that improves selected evaluator scenarios from a natural-language instruction. Returns a progress ID to poll with the improve-scenarios-progress endpoint.

  • Write

    Update an evaluator scenario

    Updates the specified evaluator scenario.

  • Destructive

    Delete a scheduled test job

    Deletes the specified scheduled test job.

  • Destructive

    Update a test agent

    Updates the specified test agent.

  • Destructive

    Delete a test agent

    Deletes the specified test agent.

  • Destructive

    Delete a test metric

    Deletes the specified metric.

  • Destructive

    Delete a test run result

    Deletes the specified test run batch.

  • Destructive

    Delete an evaluator scenario

    Deletes the specified evaluator scenario.

Decision Models

  • Write

    Evaluate decision models (TypeSafe-compatible)

    Beta API. Choose telnyx/decision-flash for the lowest cost and latency, or telnyx/decision-pro for decisions that require long context, including inputs beyond Jev’s 32k per-decision limit. Omitted model defaults to telnyx/decision-flash.

Messaging

  • Read

    List alphanumeric sender IDs

    List all alphanumeric sender IDs for the authenticated user.

  • Read

    Retrieve an alphanumeric sender ID

    Retrieve a specific alphanumeric sender ID.

  • Read

    List messaging hosted numbers

    List all hosted numbers associated with the authenticated user.

  • Read

    List alphanumeric sender IDs for a messaging profile

    List all alphanumeric sender IDs associated with a specific messaging profile.

  • Read

    Get detailed messaging profile metrics

    Get detailed metrics for a specific messaging profile, broken down by time interval.

  • Read

    Retrieve a messaging hosted number

    Retrieve a specific messaging hosted number by its ID or phone number.

  • Read

    List high-level messaging profile metrics

    List high-level metrics for all messaging profiles belonging to the authenticated user.

  • Write

    Create an alphanumeric sender ID

    Create a new alphanumeric sender ID associated with a messaging profile.

  • Write

    Regenerate messaging profile secret

    Regenerate the v1 secret for a messaging profile.

  • Write

    Update a messaging hosted number

    Update the messaging settings for a hosted number.

  • Destructive

    Delete an alphanumeric sender ID

    Delete an alphanumeric sender ID and disassociate it from its messaging profile.

Artifacts

  • Read

    Download artifact

    Downloads the artifact content. The signed URL (with expires and sig query params) is obtained from the artifact metadata endpoint.

  • Read

    Get artifact metadata

    Returns artifact metadata and a signed download URL. The download URL requires Bearer auth.

Audit Logs

  • Read

    List Audit Logs

    Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes.

Authentication Providers

  • Read

    List all SSO authentication providers

    Returns a list of your SSO authentication providers.

  • Read

    Retrieve an authentication provider

    Retrieves the details of an existing authentication provider.

  • Write

    Creates an authentication provider

    Creates a new authentication provider for single sign-on, configured from the provided identity provider details, and returns the created resource.

  • Write

    Update an authentication provider

    Updates settings of an existing authentication provider.

  • Destructive

    Deletes an authentication provider

    Deletes an existing authentication provider.

Phone Number Search

  • Read

    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 type.

  • Read

    List available phone numbers

    Searches the Telnyx inventory for available phone numbers. Filters support number patterns, location, number type, features, reservability, and other inventory constraints; the response includes matching numbers and search metadata.

Billing

  • Read

    Get user balance details

    Retrieve the current balance, available credit, and credit limit for your account.

Billing Groups

  • Read

    List all billing groups

    Retrieve a paginated list of billing groups on your account.

  • Read

    Get a billing group

    Retrieve the details of a specific billing group.

  • Write

    Create a billing group

    Create a new billing group, which can be used to organize resources for billing purposes.

  • Write

    Update a billing group

    Update the properties of an existing billing group.

  • Destructive

    Delete a billing group

    Delete a billing group from your account.

Browser Sessions

  • Read

    List browser sessions

    Lists sessions for the authenticated org. Optional status filter.

  • Read

    Get browser session

    Returns the current status of a browser session.

  • Write

    Create browser session

    Creates an isolated browser session with network access restricted to the domains you allow.

  • Destructive

    Close browser session

    Closes a ready session and releases its resources. An already closed, failed, or expired session is returned unchanged; a provisioning session returns 409 sessionnotready.

Actions

  • Read

    Get action result

    Returns the stored status and result of an action. Use this to poll actions that returned 202; HTTP 200 can contain any action status. Stored observations contain metadata with empty tree and refs, not the full snapshot; submit a fresh observe action to obtain current refs.

  • Write

    Execute browser action

    Executes a browser action on the session. Returns 200 if completed within waitseconds, 202 if still in-flight. Action types: navigate, observe, click, fill, select, press, scroll, waitfor, screenshot, batch.

SIM Card Actions

  • Read

    List bulk SIM card actions

    This API lists a paginated collection of bulk SIM card actions. A bulk SIM card action contains details about a collection of individual SIM card actions.

  • Read

    Get bulk SIM card action details

    This API fetches information about a bulk SIM card action. A bulk SIM card action contains details about a collection of individual SIM card actions.

  • Read

    List SIM card actions

    This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.

  • Read

    Get SIM card action details

    This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.

Bundles

  • Read

    Retrieve Bundles

    Returns a paginated list of the billing bundles available to your account, with support for filtering.

  • Read

    Get Bundle By Id

    Returns the details of a single billing bundle by its ID, so you can inspect its contents before purchasing a user bundle.

User Bundles

  • Read

    Get User Bundles

    Returns a paginated list of the bundles active on your account, with support for filtering.

  • Read

    Get Unused User Bundles

    Returns all user bundles that aren't in use.

  • Read

    Get User Bundle by Id

    Returns the details of a single user bundle on your account by its ID.

  • Read

    Get User Bundle Resources

    Retrieves the resources of a user bundle by its ID.

  • Write

    Create User Bundles

    Creates multiple user bundles for the user.

  • Destructive

    Deactivate User Bundle

    Deactivates the specified user bundle on your account and returns the deactivated bundle.

Call Control Applications

  • Read

    List call control applications

    Return a list of call control applications.

  • Read

    Retrieve a call control application

    Retrieves the details of an existing call control application.

  • Write

    Create a call control application

    Creates a call control application, which defines the webhook endpoints and settings used to control calls on associated connections.

  • Write

    Update a call control application

    Updates settings of an existing call control application.

  • Destructive

    Delete a call control application

    Permanently deletes the specified call control application and its webhook configuration.

Debugging

  • Read

    List call events

    Filters call events by given filter parameters. Events are ordered by occurredat. If filter for legid or applicationsessionid is not present, it only filters events from the last 24 hours. Note: Only one filter[occurredat] can be passed.

Reference Data

  • Read

    List standard call reasons

    Telnyx maintains a library of pre-vetted call-reason phrases (e.g. "Appointment reminders", "Billing inquiries") that carry through DIR vetting smoothly.

  • Read

    Validate a list of call reasons

    Check up to 10 candidate callreasons strings against Telnyx's vetting heuristics before sending them on a DIR create or update.

  • Read

    List supported DIR document types

    Reference list of documenttype values accepted by DirCreateRequest.documents[].documenttype and the infringement-contest endpoint. Each entry has a stable shortname (used in API calls) and a customer-facing description.

Call Commands

  • Write

    Dial

    Dial a number or SIP URI from a given connection. A successful response will include a calllegid which can be used to correlate the command with subsequent webhooks.

  • Write

    Add messages to AI Assistant

    Add messages to the conversation started by an AI assistant on the call.

  • Write

    Join AI Assistant Conversation

    Add a participant to an existing AI assistant conversation. Use this command to bring an additional call leg into a running AI conversation.

  • Write

    Start AI Assistant

    Start an AI assistant on the call. Expected Webhooks: - call.conversation.created includes conversationid during startup - call.conversation.ended - call.conversationinsights.generated

  • Write

    Stop AI Assistant

    Stops the AI assistant currently engaged on the call. The call remains active and can continue with other call control commands.

  • Write

    Answer call

    Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call. To answer with an AI assistant, include assistant.id and any per-call overrides in the assistant object.

  • Write

    Bridge calls

    Bridge two call control calls. Expected Webhooks: - call.bridged for Leg A - call.bridged for Leg B

  • Write

    Start Conversation Relay

    Start a Conversation Relay session on an active call. Conversation Relay connects the call audio to your WebSocket so your application can exchange realtime messages with the caller while Telnyx handles speech recognition and text-to-speech.

  • Write

    Stop Conversation Relay

    Stop the active Conversation Relay session on a call.

  • Write

    Enqueue call

    Places the call into a queue, where it waits until it is removed or bridged to another leg. Queue behavior is configured through the request body.

  • Write

    Forking start

    Call forking allows you to stream the media from a call to a specific target in realtime. This stream can be used to enable realtime audio analysis to support a variety of use cases, including fraud detection, or the creation of AI-generated audio responses.

  • Write

    Forking stop

    Stop forking a call. Expected Webhooks: - call.fork.stopped

  • Write

    Gather

    Gather DTMF signals to build interactive menus. You can pass a list of valid digits. The Answer command must be issued before the gather command. Expected Webhooks: - call.dtmf.received (you may receive many of these webhooks) - call.gather.ended

  • Write

    Gather stop

    Stop current gather. Expected Webhooks: - call.gather.ended

  • Write

    Gather using AI

    Gather parameters defined in the request payload using a voice assistant. You can pass parameters described as a JSON Schema object and the voice assistant will attempt to gather these informations.

  • Write

    Gather using audio

    Play an audio file on the call until the required DTMF signals are gathered to build interactive menus. You can pass a list of valid digits along with an 'invalidaudiourl', which will be played back at the beginning of each prompt.

  • Write

    Gather using speak

    Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus. You can pass a list of valid digits along with an 'invalidpayload', which will be played back at the beginning of each prompt.

  • Write

    Hangup call

    Hang up the call. Expected Webhooks: - call.hangup - call.recording.saved

  • Write

    Process a payment

    Collect payment details from the caller using DTMF and either charge or tokenize the payment method through a configured Pay connector. Pay pauses active call recordings while sensitive payment details are collected.

  • Write

    Play audio URL

    Play an audio file on the call. If multiple play audio commands are issued consecutively, the audio files will be placed in a queue awaiting playback. Notes: - When overlay is enabled, targetlegs is limited to self.

  • Write

    Stop audio playback

    Stop audio being played on the call. Expected Webhooks: - call.playback.ended or call.speak.ended

  • Write

    Record pause

    Pause recording the call. Recording can be resumed via Resume recording command. Expected Webhooks: There are no webhooks associated with this command.

  • Write

    Record resume

    Resume recording the call. Expected Webhooks: There are no webhooks associated with this command.

  • Write

    Recording start

    Start recording the call. Recording will stop on call hang-up, or can be initiated via the Stop Recording command. Expected Webhooks: - call.recording.saved - call.recording.transcription.saved - call.recording.error

  • Write

    Recording stop

    Stop recording the call. Expected Webhooks: - call.recording.saved

  • Write

    SIP Refer a call

    Initiate a SIP Refer on a Call Control call. You can initiate a SIP Refer at any point in the duration of a call. Expected Webhooks: - call.refer.started - call.refer.completed - call.refer.failed

  • Write

    Reject a call

    Reject an incoming call. Expected Webhooks: - call.hangup

  • Write

    Send DTMF

    Sends DTMF tones from this leg. DTMF tones will be heard by the other end of the call. Expected Webhooks: There are no webhooks associated with this command.

  • Write

    Send SIP info

    Sends SIP info from this leg. Expected Webhooks: - call.sipinfo.received (to be received on the target call leg)

  • Write

    SIPREC start

    Start siprec session to configured in SIPREC connector SRS. Expected Webhooks: - siprec.started - siprec.stopped - siprec.failed

  • Write

    SIPREC stop

    Stop SIPREC session. Expected Webhooks: - siprec.stopped

  • Write

    Speak text

    Convert text to speech and play it back on the call. If multiple speak text commands are issued consecutively, the audio files will be placed in a queue awaiting playback. Expected Webhooks: - call.speak.started - call.speak.ended

  • Write

    Streaming start

    Start streaming the media from a call to a specific WebSocket address or Dialogflow connection in near-realtime. Audio will be delivered as base64-encoded RTP payload (raw audio), wrapped in JSON payloads.

  • Write

    Streaming stop

    Stop streaming a call to a WebSocket. Expected Webhooks: - streaming.stopped

  • Write

    Noise Suppression Start (BETA)

    Start noise suppression on an active call to reduce background noise. This feature is currently in beta.

  • Write

    Noise Suppression Stop (BETA)

    Stop noise suppression previously started on an active call. This feature is currently in beta.

  • Write

    Switch supervisor role

    Switch the supervisor role for a bridged call. This allows switching between different supervisor modes during an active call

  • Write

    Transcription start

    Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command. Expected Webhooks: - call.transcription

  • Write

    Transcription stop

    Stops real-time transcription on the call. Transcription webhooks cease once the command takes effect; the call itself is unaffected.

  • Write

    Transfer call

    Transfer a call to a new destination. If the transfer is unsuccessful, a call.hangup webhook for the other call (Leg B) will be sent indicating that the transfer could not be completed.

  • Destructive

    Update client state

    Updates the client state associated with the call. Client state is an opaque value echoed back in subsequent webhooks for the call, letting you correlate events with your application's state.

  • Destructive

    Remove call from a queue

    Removes the call from the queue it is currently waiting in. The call remains active and can be directed with further call commands.

Call Information

  • Read

    Retrieve a call status

    Returns the status of a call (data is available 10 minutes after call ended).

  • Read

    List all active calls for given connection

    Lists all active calls for given connection. Acceptable connections are either SIP connections with webhookurl or xmlrequesturl, call control or texml. Returned results are cursor paginated.

  • Read

    List dial metrics

    Returns dials-per-second (DPS) metrics for your account's outbound dials made with the Call Control Dial command and TeXML, as time buckets with dial counts, accepted and rejected dials, average and peak DPS, and the DPS limit in force.

Voice Channels

  • Read

    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 Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.

  • Read

    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 Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.

  • Read

    List All Numbers using Channel Billing

    Retrieve a list of all phone numbers using Channel Billing, grouped by Zone.

  • Read

    List Numbers using Channel Billing for a specific Zone

    Retrieve a list of phone numbers using Channel Billing for a specific Zone.

  • Write

    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 increase or decrease your capacity based on expected call volume.

  • Destructive

    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 endpoint to increase or decrease your capacity based on expected call volume.

Charges breakdown

  • Read

    Get monthly charges breakdown

    Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. The date range cannot exceed 31 days.

Charges summary

  • Read

    Get monthly charges summary

    Retrieve a summary of monthly charges for a specified date range. The date range cannot exceed 31 days.

Phone Number Orders

  • Read

    Retrieve all comments

    Returns comments associated with number-order records. Results can be filtered by record type and record ID and include pagination metadata.

  • Read

    Retrieve a comment

    Returns the comment identified by id, including its associated record and comment metadata.

  • Read

    Retrieve a list of phone numbers associated to orders

    Get a list of phone numbers associated to orders.

  • Read

    Retrieve a single phone number within a number order.

    Get an existing phone number in number order.

  • Read

    List number orders

    Returns a paginated list of your phone number orders, with support for filtering.

  • Read

    Retrieve a number order

    Returns the details of an existing phone number order, including its status and the numbers included.

  • Read

    List sub number orders

    Get a paginated list of sub number orders.

  • Read

    Retrieve a sub number orders report

    Get the status and details of a sub number orders report.

  • Read

    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.

  • Read

    Retrieve a sub number order

    Returns the details of an existing sub number order, with support for filtering.

  • Write

    Create a comment

    Creates a comment associated with a supported number-order record. The response contains the created comment.

  • Write

    Mark a comment as read

    Marks the specified comment as read. The response contains the updated read state for the comment.

  • Write

    Update requirements for a single phone number within a number order.

    Updates requirements for a single phone number within a number order.

  • Write

    Create a number order

    Creates an order to purchase the specified phone numbers and returns the created order. Track fulfillment through the order's status.

  • Write

    Update a number order

    Updates an existing phone number order, for example to satisfy regulatory requirements attached to the order, and returns the updated order.

  • Write

    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.

  • Write

    Update a sub number order's requirements

    Updates the requirements of an existing sub number order and returns the updated order.

  • Destructive

    Cancel a sub number order

    Allows you to cancel a sub number order in 'pending' status.

Stateful actors

  • Read

    Retrieve a Stateful Actor type

    Retrieve one account-scoped Stateful Actor type. ownerfunctionid identifies the function that owns and ships the actor class; other functions may reference the same actor type through actor bindings.

Functions

  • Read

    List functions

    List functions for the authenticated organization. Each function includes its persisted function-scoped bindings. Actor bindings expose actortype and envname, allowing clients to identify every function attached to a Stateful Actor type.

  • Read

    Get function logs

    Returns logs oldest first. type=runtime (default) returns function stdout/stderr. type=invocations returns one platform-generated record per HTTP request served.

  • Read

    Get log export configuration

    Returns the function's configured log export destination and which log types are exported. Headers are never returned. Returns 404 (error code 10005) when no destination is configured for the function.

  • Read

    Get function metric aggregates

    Returns aggregate request, latency, CPU, memory, and resource-limit metrics for a function over the requested window.

  • Read

    List function revisions

    Lists a function's ship history newest first, including per-ship failure stage and reason when recorded.

  • Read

    Inspect latest function ship

    Returns the latest ship outcome. The stage is none on success, pending while building, or a failure stage such as build, platform, prebuild, deploy, or securityreview. This stage-neutral customer-facing path is an alias over the same inspection resource as buildloginspection.

  • Destructive

    Configure log export destination

    Configures the external OTLP endpoint a function's runtime and/or invocation logs are pushed to as they happen.

  • Destructive

    Delete log export configuration

    Stops exporting a function's logs and removes its destination configuration. Idempotent: deleting when nothing is configured succeeds.

Conference Commands

  • Read

    List conferences

    Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Conferences are listed in descending order by expiresat.

  • Read

    List conference participants

    Returns a paginated list of participants in the specified conference, with support for filtering.

  • Read

    Retrieve a conference

    Returns the details of an existing conference, including its current status.

  • Read

    Retrieve a conference participant

    Retrieve details of a specific conference participant by their ID or label.

  • Write

    Create conference

    Create a conference from an existing call leg using a callcontrolid and a conference name. Upon creating the conference, the call will be automatically bridged to the conference.

  • Write

    End a conference

    End a conference and terminate all active participants.

  • Write

    Gather DTMF using audio prompt in a conference

    Play an audio file to a specific conference participant and gather DTMF input.

  • Write

    Hold conference participants

    Hold a list of participants in a conference call

  • Write

    Join a conference

    Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the callcontrolid of the leg you wish to join to the conference as an attribute.

  • Write

    Leave a conference

    Removes a call leg from a conference and moves it back to parked state. Expected Webhooks: - conference.participant.left

  • Write

    Mute conference participants

    Mute a list of participants in a conference call

  • Write

    Play audio to conference participants

    Play audio to all or some participants on a conference call.

  • Write

    Conference recording pause

    Pauses the active recording of the specified conference. Resume it later with the recordresume action.

  • Write

    Conference recording resume

    Resumes a previously paused recording of the specified conference, continuing capture from the point it was paused.

  • Write

    Conference recording start

    Start recording the conference. Recording will stop on conference end, or via the Stop Recording command. Expected Webhooks: - conference.recording.saved

  • Write

    Conference recording stop

    Stop recording the conference. Expected Webhooks: - conference.recording.saved

  • Write

    Send DTMF to conference participants

    Send DTMF tones to one or more conference participants.

  • Write

    Speak text to conference participants

    Convert text to speech and play it to all or some participants.

  • Write

    Stop audio being played on the conference

    Stop audio being played to all or some participants on a conference call.

  • Write

    Unhold conference participants

    Unhold a list of participants in a conference call

  • Write

    Unmute conference participants

    Unmute a list of participants in a conference call

  • Write

    Update conference participant

    Update conference participant supervisorrole

  • Write

    Update a conference participant

    Update properties of a conference participant.

Connections

  • Read

    List connections

    Returns a list of your connections irrespective of type.

  • Read

    Count connections

    Returns the number of connections associated with the authenticated user, grouped by connection type, together with the connection limits that apply to the user. Forward-only connections are excluded from the counts.

  • Read

    Retrieve a connection

    Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.

Country Coverage

  • Read

    Get country coverage

    Returns Telnyx service coverage information for every country, including which number types and features are available in each.

  • Read

    Get coverage for a specific country

    Returns Telnyx service coverage information for the specified country, including available number types and features.

Credential Connections

  • Read

    List credential connections

    Returns a list of your credential connections.

  • Read

    Retrieve a credential connection

    Retrieves the details of an existing credential connection.

  • Read

    Check a Credential Connection Registration Status

    Returns the live SIP registration status for a credential connection. Reports whether the endpoint is currently registered (status) and the timestamp of the last SIP registration event (lastregistration).

  • Write

    Create a credential connection

    Creates a new credential-based SIP connection. Credential connections authenticate with a username and password rather than by IP address.

  • Write

    Update a credential connection

    Updates settings of an existing credential connection.

  • Destructive

    Delete a credential connection

    Deletes an existing credential connection.

Call Recordings

  • Read

    Retrieve a stored credential

    Returns the information about custom storage credentials.

  • Read

    List all recording transcriptions

    Returns a list of your recording transcriptions.

  • Read

    Retrieve a recording transcription

    Retrieves the details of an existing recording transcription.

  • Read

    List all call recordings

    Returns a paginated list of your call recordings, with support for filtering to locate specific recordings.

  • Read

    Retrieve a call recording

    Retrieves the details of an existing call recording.

  • Write

    Create a custom storage credential

    Creates a custom storage credentials configuration.

  • Destructive

    Update a stored credential

    Updates a stored custom credentials configuration.

  • Destructive

    Delete a stored credential

    Deletes a stored custom credentials configuration.

  • Destructive

    Delete a recording transcription

    Permanently deletes a recording transcription.

  • Destructive

    Delete a list of call recordings

    Permanently deletes a list of call recordings.

  • Destructive

    Delete a call recording

    Permanently deletes the specified call recording and returns the deleted recording resource. The media is removed and can no longer be downloaded.

Customer Service Record

  • Read

    List customer service records

    Returns a paginated list of your customer service record (CSR) requests, with support for filtering and sorting.

  • Read

    Get a customer service record

    Returns the details of a single customer service record (CSR) request, including its status and any retrieved record data.

  • Write

    Create a customer service record

    Create a new customer service record for the provided phone number.

  • Write

    Verify CSR phone number coverage

    Verify the coverage for a list of phone numbers.

Detail Records

  • Read

    Search detail records

    Search for any detail record across the Telnyx Platform

Dialogflow Integration

  • Read

    Retrieve stored Dialogflow Connection

    Return details of the Dialogflow connection associated with the given CallControl connection.

  • Write

    Create a Dialogflow Connection

    Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services.

  • Destructive

    Update stored Dialogflow Connection

    Updates the stored Dialogflow connection for the specified connection and returns the updated configuration.

  • Destructive

    Delete stored Dialogflow Connection

    Deletes the stored Dialogflow connection for the specified connection.

Display Identity Records

  • Read

    List all DIRs across your enterprises

    Returns every DIR (Display Identity Record) you own, across all of your enterprises, as a single list. Pagination is JSON:API style (page[number], page[size], max 250).

  • Read

    Get a DIR by id

    Returns a single DIR by id. The enterprise is resolved server-side from the DIR id. Returns 404 if the DIR does not exist or is not yours.

  • Read

    List a DIR's authorized BPOs

    List the BPO (Business Process Outsourcer) accounts a Brand Owner has authorized on this DIR, together with the review state of each authorization. Authorizations are supplied as the bpoauthorizations array when creating or updating a DIR, and each one is reviewed on its own.

  • Read

    List DIRs in an enterprise

    Return the DIRs (Display Identity Records) belonging to a single enterprise. Pagination is JSON:API style (page[number], page[size], max 250).

  • Write

    Update a DIR

    Edit a DIR. DIRs in draft, rejected, unsuccessful, or suspended can be edited freely: PATCH is a pure edit, status is never changed, and you re-vet by calling POST /v2/dir/{dirid}/submit explicitly.

  • Write

    Render the BPO Authorization LOA for a DIR

    The Letter of Authorization in which a Brand Owner authorizes an approved BPO (Business Process Outsourcer) to place branded calls that display this DIR on the owner's behalf.

  • Write

    Render the Branded Calling LOA for a DIR

    Generate a pre-filled Letter of Authorization (LOA) PDF for a DIR.

  • Write

    Submit a DIR for vetting

    Submit a DIR for vetting. Sends the DIR back through the vetting cycle from any non-terminal status. When re-submitting from suspended or expired, the DIR's previous Branded Calling registration is torn down transactionally and its phone numbers flip back to submitted.

  • Write

    Create a Display Identity Record (DIR)

    Create a new DIR under the given enterprise. The DIR starts in draft status; it must be submitted (POST .../submit) and approved by Telnyx before any phone number can be attached.

  • Destructive

    Request deletion of a DIR

    Request deletion of a DIR. This does not remove the DIR on this call: it records the request, moves the DIR to deleterequested, and Telnyx completes the removal (de-registration and cleanup) shortly after.

Comments

  • Read

    List comments on a DIR

    List the comments on a DIR. The enterprise is resolved server-side from the DIR id.

  • Write

    Post a comment on a DIR

    Post a customer comment on a DIR (for example, to respond to reviewer notes). Send only content (1–5000 chars) and an optional parentcommentid; the server sets the comment type, visibility, and author automatically. The enterprise is resolved server-side from the DIR id.

Infringement Claims

  • Read

    List infringement claims for a DIR

    Return the trademark or copyright claims filed against this DIR. Each claim's status is pending (newly filed; DIR auto-suspended), contested (you have submitted contest evidence; awaiting resolution), or resolved (final).

  • Read

    Get an infringement claim

    Retrieve a single claim by id. Returns 404 if the claim does not exist or is not against a DIR you own.

  • Write

    Contest an infringement claim

    Submit a written response and supporting documents disputing the claim. The first call moves the claim from pending to contested; subsequent calls append supplementary evidence without changing status.

  • Destructive

    Update a DIR to resolve an infringement concern

    Push a fix for a DIR that is suspended with an open infringement claim back into vetting. POST /dir/{dirid}/submit is blocked while a claim is open, so this is the customer-callable path to update the DIR's content and re-certify before Telnyx adjudicates the claim.

Phone Number Batches

  • Read

    List phone-number batches for a DIR

    List the phone-number batches submitted under a DIR. The enterprise is resolved server-side from the DIR id.

  • Read

    Get a phone-number batch

    Get a single phone-number batch by id. The enterprise is resolved server-side from the DIR id.

Phone Numbers

  • Read

    List phone numbers attached to a DIR

    List the phone numbers registered under a DIR. The enterprise is resolved server-side from the DIR id.

  • Write

    Add phone numbers to a DIR

    Register phone numbers under a DIR. The enterprise is resolved server-side from the DIR id. Pricing: Adding phone numbers is free. Branded Calling fees are charged per DIR and per branded call. See https://telnyx.com/pricing/branded-calling for current pricing.

  • Destructive

    Remove phone numbers from a DIR

    Deregister phone numbers from a DIR. The enterprise is resolved server-side from the DIR id. Returns a partial-success envelope.

DIR References

  • Read

    List a DIR's references

    List the business and financial references submitted for a DIR. Returns the two business references (slots 1 and 2) followed by the single financial reference.

  • Write

    Submit a DIR's references

    Submit the two business references and one financial reference for a DIR. References (two business references and one financial reference) are needed only if the documents uploaded with the DIR don't already prove the business is legitimate and financially stable.

  • Write

    Update a DIR reference

    Partially update one reference, addressed by the DIR id plus the reference's type (business or financial) and slot. Cosmetic fields (full name, job title, organization, relationship, email) are always editable.

Email Verification

  • Read

    Get email-ownership verification status

    Whether the DIR's current authorizer email has been verified.

  • Write

    Send an email-ownership verification code

    Email a 6-digit code to the DIR's authorizer email to confirm ownership of that address. The code goes to the authorizer, not to the caller. If the authorizer is someone else (for example a client's executive), that person has to share the code with whoever is completing setup.

  • Write

    Confirm an email-ownership verification code

    Submit the 6-digit code that was emailed to the DIR's authorizer email. On success the authorizer email is marked verified. For security, any failure (wrong, expired, already-used, or too many attempts) returns the same generic message.

  • Write

    Send an email-ownership verification code to an enterprise

    Email a 6-digit code to the enterprise account's contact email to confirm ownership of that address. A BPO (Business Process Outsourcer) account has no DIR, so it proves ownership of its own contact email here rather than through a DIR.

  • Write

    Confirm an enterprise email-ownership verification code

    Submit the 6-digit code that was emailed to the enterprise account's contact email. On success the contact email is marked verified. For security, any failure (wrong, expired, already-used, or too many attempts) returns the same generic message.

Documents

  • Read

    List all documents

    List all documents ordered by createdat descending.

  • Read

    Retrieve a document

    Returns the details of a single document on your account, including its metadata.

  • Read

    Download a document

    Downloads the raw file content of the specified document as originally uploaded.

  • Write

    Upload a document

    Upload a document. Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted.

  • Write

    Update a document

    Updates the specified document's attributes and returns the updated document.

  • Destructive

    Delete a document

    Delete a document. 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 deleting.

Dynamic Emergency Addresses

  • Read

    List dynamic emergency addresses

    Returns the dynamic emergency addresses according to filters

  • Read

    Get a dynamic emergency address

    Returns the dynamic emergency address based on the ID provided

  • Write

    Create a dynamic emergency address.

    Creates a dynamic emergency address, the validated physical location used when provisioning dynamic emergency endpoints.

  • Destructive

    Delete a dynamic emergency address

    Deletes the dynamic emergency address based on the ID provided

Dynamic Emergency Endpoints

  • Read

    List dynamic emergency endpoints

    Returns the dynamic emergency endpoints according to filters

  • Read

    Get a dynamic emergency endpoint

    Returns the dynamic emergency endpoint based on the ID provided

  • Write

    Create a dynamic emergency endpoint.

    Creates a dynamic emergency endpoint, associating a callback number and location with a device for emergency calling.

  • Destructive

    Delete a dynamic emergency endpoint

    Deletes the dynamic emergency endpoint based on the ID provided

Dedicated IPs

  • Read

    List dedicated IPs

    List the dedicated sending IPs owned by the account, newest first. Narrow the list with filter[status], filter[poolid], and filter[region]; supplied filters combine, so an IP must match every one.

  • Read

    Retrieve a dedicated IP

    Retrieve a single dedicated IP by its identifier, including warm-up state, billing state, and the DNS/PTR provisioning checklist.

  • Write

    Purchase a dedicated IP

    Purchase a dedicated sending IP. Requires a verified, enterprise, or legacy account, and an Idempotency-Key header: a request without the header returns 400 (code 10015) and allocates nothing. Telnyx allocates the next available IP from stock.

  • Write

    Update a dedicated IP

    Move the IP to another pool, or pause/resume its warm-up ramp. One change applies per request. poolid takes precedence over warm-up changes. Otherwise, use warmuppaused or warmup.paused; a Boolean warmuppaused takes precedence.

  • Write

    Manually complete warmup

    Manually complete the warm-up ramp (warmingup to active), bypassing the schedule. Use only for an IP already warmed elsewhere.

  • Write

    Pause warmup

    Pause the warm-up ramp at its current stage. While paused, the IP releases no first-attempt sends from hold and the ramp does not advance. Only a warmingup IP can be paused; pausing an already paused IP refreshes pausedat.

  • Write

    Resume warmup

    Resume a paused warm-up ramp from its held stage. Only a warmingup IP can be resumed; resuming a ramp that is not paused returns the IP unchanged.

  • Write

    Start warmup for a dedicated IP

    Start the warm-up ramp (provisioning to warmingup). The ramp never starts automatically. Only a provisioning IP can be started; a suspended IP returns 409. Starting does not check DNS: the IP carries mail only while dnsconfirmedat is set and the IP is in a pool that routes mail.

  • Destructive

    Release a dedicated IP

    Release the dedicated IP to Telnyx. The IP stops carrying mail immediately, leaves its pool, and moves to released. Telnyx sets quarantineuntil to 30 days after release. Release requests that the MRC stop asynchronously.

IP Pools

  • Read

    List IP pools

    List the account's dedicated-IP pools. Member IPs are not included (ips is empty); retrieve a pool to see its members.

  • Read

    Retrieve an IP pool

    Retrieve a single IP pool by its identifier, including its dedicated-IP members with billing state.

  • Write

    Create an IP pool

    Create an account-scoped pool of dedicated IPs. Set isdefault or domainid for the pool to carry mail; a pool with neither carries none.

  • Write

    Update an IP pool

    Rename the pool, set or clear the default flag, or change its domain scope. Routing follows the new settings for subsequent mail.

  • Write

    Add a dedicated IP to a pool

    Add a dedicated IP to the pool with an optional routing weight. An IP can belong to one pool; to move an IP that is already in a pool, use PATCH /email/dedicatedips/{id} with poolid.

  • Destructive

    Delete an IP pool

    Delete the pool. Member IPs are kept but leave the pool, so they carry no mail until added to another pool. Deleting a pool changes routing for subsequently resolved messages. It does not reroute messages already assigned to the deleted pool.

  • Destructive

    Remove a dedicated IP from a pool

    Remove the dedicated IP from the pool. The IP is kept but carries no mail until added to a pool again. Removing the last IP requires force=true and drain=true.

Email Suppressions

  • Read

    List suppressions

    Account-scoped list. Two mutually exclusive pagination modes: - Offset: page[number] (default 1) + page[size] (default 25, max 100). meta contains totalpages. - Cursor: page[after] and/or page[before] (opaque Base.urlencode64 of {"createdat","id"}).

  • Read

    Export suppressions as CSV

    Streams the account's suppressions as a chunked CSV (server-side cursor; never materialized). Content-type text/csv, header Content-Disposition: attachment; filename="emailblocksexport.csv".

  • Read

    Retrieve a suppression

    Returns the account-owned suppression identified by ID. Cross-account lookups and malformed IDs return 404 without exposing another account’s data.

  • Read

    List audit events for a suppression

    Offset pagination only (page[number] default 1, page[size] default 50, max 100). No sort, no filter, no cursor — ordering is fixed desc occurredat, desc id. Verifies the block belongs to the account first (cross-account → 404).

  • Write

    Create a manual suppression

    Creates a suppression with reason: manualblock and source: manual. Caller-supplied reason / source are ignored; scope is derived server-side from domainid / from and is never trusted.

  • Destructive

    Soft-delete a suppression

    Soft-deletes (status → removed; tombstone retained). A removed audit event is appended unless the block was already removed (idempotent — returns the existing row with 200 and no new event). Mutates updatedat.

Email Suppression Imports

  • Read

    Poll an import job

    Account-scoped fetch (cross-account → 404; malformed UUID → 404).

  • Write

    Create an async CSV import job

    Accepts multipart/form-data with a file field (the CSV) and an optional blockttldays (integer 0, default 30).

Email Domains

  • Read

    List email domains

    Shared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains.

  • Read

    Retrieve an email domain

    Shared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains.

  • Read

    Get domain health summary

    Returns a summary of domain health including verification status and usability.

  • Write

    Create an email domain

    Registers a domain for email sending and optional inbound delivery. The response includes the domain configuration and current verification state.

  • Write

    Rotate the DKIM key for an email domain

    Generates a new DKIM key for the domain, activates it, and retires the previous key. The response includes the updated DKIM DNS records the customer must publish. Selectors are fixed, so rotation replaces the TXT value at the existing .domainkey.

  • Write

    Update an email domain

    Updates mutable settings for an existing email domain, including inbound delivery and tracking configuration. Shared domains are read-only for non-owner accounts.

  • Destructive

    Delete an email domain

    Deletes an email domain configuration. Verified domains require force=true, and shared domains are read-only for non-owner accounts.

Email Domain DNS Records

  • Read

    List DNS records for an email domain

    Returns the DNS records Telnyx generated for domain ownership and DKIM verification, plus MX records when inbound delivery is enabled.

  • Write

    Verify DNS records for an email domain

    Checks the published DNS records against the records required for the email domain and returns the latest verification results.

Email Webhooks

  • Read

    List webhooks for an email domain

    Returns a paginated list of webhook subscriptions scoped to the email domain. Results can be sorted by creation time.

  • Read

    Retrieve a webhook

    Returns the webhook subscription identified by ID within the specified email domain.

  • Write

    Create a webhook for an email domain

    Creates a webhook endpoint subscribed to a specific allowlist of event types. Both email. events (published by email-api) and emaildomain. events (published by this service) flow through the same webhooks.

  • Write

    Update a webhook

    Update a webhook's URL and/or event subscription. A webhook is bound to its domain — domainid is not mutable.

  • Destructive

    Delete a webhook

    Deletes the webhook subscription identified by ID within the specified email domain and returns the deleted subscription.

Email Events

  • Read

    List account email events

    Lists account-level email events sorted oldest first by occurredat asc, id asc. Each row contains a legacy email.-prefixed eventtype and an additive canonicaleventtype.

  • Read

    Get email event statistics

    Returns counts and rates for email events over a time range. The default start time is 30 days ago.

Email Inboxes

  • Read

    List email inboxes

    Lists the account's non-deleted inboxes newest first using stable cursor pagination.

  • Read

    Get an email inbox

    Returns an account-scoped, non-deleted inbox. Missing and foreign inboxes are indistinguishable.

  • Read

    List sender filters for an inbox

    Returns the inbox's sender allowlist and blocklist. Entries are normalized to lowercase. A blocklist match takes precedence over an allowlist match; when both lists are empty, all senders are accepted.

  • Read

    List and search messages in an inbox

    Lists inbound messages newest first. All access is scoped to the authenticated account. filter[search] performs PostgreSQL full-text search over the subject, plain-text body, and HTML body. Filters compose with stable cursor pagination.

  • Read

    List threads in an inbox

    Lists thread summaries newest first using stable cursor pagination.

  • Read

    Get a thread and a page of its messages

    Returns a bounded page of inbound and outbound thread messages interleaved in chronological order using stable cursor pagination.

  • Write

    Create an email inbox

    Creates an inbox on an inbound-enabled domain. When domainid is omitted, Telnyx allocates the account's shared inbound subdomain so the inbox is immediately usable without customer DNS setup. When username is omitted, a unique username is generated.

  • Write

    Add sender filter entries to an inbox

    Adds entries to either the allowlist or blocklist. The operation is an idempotent set union: entries already present remain unchanged.

  • Write

    Update an inbox message

    Updates the explicit read state of an account-scoped inbound message. Set readat to true to mark the message read at the server's current time, to an ISO 8601 timestamp to use that timestamp, or to null to mark the message unread. Repeating the same update is idempotent.

  • Write

    Forward an inbox message

    Sends from the inbox address through the standard email send pipeline to caller-supplied To, Cc, and Bcc recipients. to must contain at least one recipient.

  • Write

    Reply to an inbox message

    Sends from the inbox address through the standard email send pipeline. The recipient is the original Reply-To, falling back to From; original Cc recipients are not included. The subject is prefixed with Re: unless it already has that prefix.

  • Write

    Reply all to an inbox message

    Sends from the inbox address through the standard email send pipeline. The To list starts with the original Reply-To (or From) and includes original To recipients; the Cc list includes original Cc recipients.

  • Write

    Add labels to an inbox message

    Adds one or more mutable labels to a message. Labels carry agent workflow state such as spam, needsreview, or processed.

  • Write

    Add labels to an inbox thread

    Adds one or more mutable labels to a thread, letting an agent mark a whole conversation (for example needsreview) without labelling each message individually.

  • Destructive

    Delete an email inbox

    Soft-deletes an account-scoped inbox. Its address remains reserved and the inbox is no longer returned by list or get operations.

  • Destructive

    Replace sender filters for an inbox

    Replaces both sender filter lists atomically. Omitting either list clears that list. Use POST or DELETE for incremental changes.

  • Destructive

    Remove sender filter entries from an inbox

    Removes entries from either the allowlist or blocklist. The operation is idempotent: removing an entry that is not present still returns the current filter lists.

  • Destructive

    Remove labels from an inbox message

    Removes one or more labels from a message. Idempotent — removing a label the message does not carry is a no-op and still returns 200. Removal is case-sensitive.

  • Destructive

    Remove labels from an inbox thread

    Removes one or more labels from a thread. Idempotent — removing a label the thread does not carry is a no-op and still returns 200.

Email Drafts

  • Read

    List drafts in an inbox

    Lists drafts newest first using stable cursor pagination. All access is scoped to the authenticated account and the given inbox.

  • Read

    Retrieve a draft

    Returns a single draft. Drafts that have been sent remain retrievable, so the exact content that was sent stays auditable.

  • Write

    Create a draft

    Creates an unsent draft in the inbox. Every field is optional — a draft is a work-in-progress and may be saved incomplete. Send-time requirements (sender, subject, at least one recipient) are enforced when the draft is sent, not when it is created.

  • Write

    Update a draft (alias)

    Identical to PUT; both apply a partial update to the supplied fields.

  • Write

    Send a draft

    Sends the draft through the standard send pipeline — the same domain resolution, suppression, reputation, daily-quota, persistence and Detail Record behaviour as POST /v2/emailmessages. The response body is the created email message.

  • Write

    Create a reply draft

    Creates an unsent reply draft for an inbound message. Unlike the /actions/reply endpoint, which sends immediately, this stores a draft that can be reviewed and edited before sending.

  • Destructive

    Update a draft

    Updates the supplied fields on a draft. accountid and inboxid are server-owned and ignored if present in the body, so a draft can never be moved between accounts or inboxes.

  • Destructive

    Delete a draft

    Permanently deletes an unsent draft. Drafts that are being sent or have been sent cannot be deleted; sent drafts are retained for audit.

Email Messages

  • Read

    List email messages

    Lists messages sorted newest first by createdat desc, id desc. Tags and metadata filters compose with cursor pagination. The legacy /v2/emails GET route is a backward-compatible alias for this operation.

  • Read

    List events for an email message

    Lists events for a single message sorted oldest first by occurredat asc, id asc. The legacy /v2/emails/{id}/events GET route is a backward-compatible alias.

  • Read

    List recipients for an email message

    Lists per-recipient delivery states for a single message with cursor pagination. Each recipient has an independent status, billable flag, and lifecycle timestamps. BCC recipient addresses are redacted (returned as null) to protect BCC privacy.

  • Read

    Get a single recipient's delivery state

    Returns the current delivery state of a single recipient, including status, billable flag, SMTP detail, and lifecycle timestamps. BCC recipient addresses are redacted (returned as null).

  • Read

    Get an email message

    The legacy /v2/emails/{id} GET route is a backward-compatible alias for this operation.

  • Write

    Create or send an email message

    Queues, schedules, or sandbox-sends an email message. The legacy /v2/emails POST route is a backward-compatible alias for this operation. subject is required unless templateid is supplied.

  • Write

    Create a batch of email messages

    Creates up to 1,000 email messages in a single request. Request-wide admission checks run first and can reject the whole batch before message creation.

  • Write

    Reschedule a scheduled email message

    Moves an existing scheduled email to a new future send time. Only the delivery time (scheduledat) changes; the message ID, content, recipients, tags, and metadata remain unchanged.

  • Destructive

    Delete email messages by address

    Permanently deletes every email in the authenticated account sent from or to the supplied address, including retained events whose parent message has expired. Events and durable recipients are deleted immediately with each message.

  • Destructive

    Cancel a scheduled email message

    Cancels a scheduled email and returns it with status cancelled. The legacy /v2/emails/{id}/schedule DELETE route is an alias.

  • Destructive

    Delete an email message

    Permanently deletes an account-scoped email message, its events, its durable recipients, and unshared attachment objects. Returns 404 when the message does not exist in the authenticated account. The legacy /v2/emails/{id} DELETE route is a backward-compatible alias.

Email Templates

  • Read

    List email templates

    Lists templates sorted newest first by createdat desc, id desc. Optional filters match a case-insensitive literal name/subject query, stored body presence, and the strictvariables and autoescape settings.

  • Read

    Get an email template

    Returns the account-owned template identified by ID, including its Liquid subject and bodies, declared variables, and timestamps.

  • Write

    Create an email template

    Creates a Liquid email template. Variables are auto-extracted when omitted.

  • Write

    Update an email template

    Updates one or more fields of the specified email template and returns the updated template.

  • Write

    Render an email template

    Renders a template using the provided Liquid variables. Missing templatevariables defaults to {}. When the template has strictvariables enabled and a required variable (per variableschema) is missing, returns 422 naming the variable.

  • Destructive

    Replace an email template

    Replaces template fields. Behaves identically to PATCH; provided for compatibility with Phoenix resource routes.

  • Destructive

    Delete an email template

    Deletes the account-owned template. The operation returns 204 with no body and prevents future sends or renders from using the deleted template ID.

Email Threads

  • Read

    List threads across every inbox in the account

    Lists thread summaries for the whole account, newest first, using stable cursor pagination. An agent operating many inboxes gets every conversation in one call instead of one call per inbox. Each thread carries its own inboxid so a reply can be routed back to the right inbox.

  • Read

    Get an account-wide thread and a page of its messages

    Returns a thread and a bounded page of its inbound and outbound messages, interleaved in chronological order. The inboxid returned by the list endpoint is required because a thread ID can occur in multiple inboxes.

Email Unsubscribe Groups

  • Read

    List unsubscribe groups

    Offset pagination only (page[number] default 1, page[size] default 25, max 100). No sort/filter/cursor — ordering fixed desc createdat, desc id. Uses the shared QueryParser.parseoffset/1 — a malformed page (e.g.

  • Read

    Retrieve an unsubscribe group

    Returns the account-owned unsubscribe group identified by ID.

  • Read

    List suppressions in a group

    Account + group scoped. Offset pagination only (page[number] default 1, page[size] default 25, max 100). No sort/filter/ cursor — ordering fixed desc createdat, desc id.

  • Write

    Create an unsubscribe group

    Creates an account-owned unsubscribe group for associating email categories with separate recipient suppression lists.

  • Write

    Update an unsubscribe group

    Partial update (only name / description). PUT is not routed.

  • Write

    Add a group suppression

    Creates a suppression with reason: unsubscribe, source: manual, groupid: . All other body fields are ignored; only to is read. Idempotent (same dedupe key → 200, no new event).

  • Destructive

    Delete an unsubscribe group

    If the group has 0 active suppressions, hard-deletes the row. With force=true, soft-deletes all active suppressions first (status → removed, groupid cleared, removed audit event per block) in a single transaction, then hard-deletes the group.

  • Destructive

    Remove a group suppression

    Soft-deletes all active blocks for (account, group, normalized email) — one removed audit event per block (actor: manual). The email path segment is normalized (trim + lower-case) before matching. Idempotent on already-removed rows (returns 404 since they're no longer active).

Email Validations

  • Read

    Validate a single email address

    Validates a single email address and returns deliverability checks.

  • Read

    Get a batch email validation job

    Retrieves the current status and, once completed, validation results for a batch job.

  • Write

    Create a batch email validation job

    Creates an asynchronous batch validation job for up to 1,000 email addresses.

Enterprises

  • Read

    List enterprises

    Return the enterprises you own, paginated. The default page size is 20; the maximum is 250.

  • Read

    Get an enterprise

    Retrieve a single enterprise by id. Returns 404 if the id does not exist or does not belong to your account.

  • Write

    Create an enterprise

    Create the legal entity (enterprise) that represents your business on the Telnyx platform. The response carries a server-assigned id you use for every subsequent call. An enterprise is created once and reused; the API collects all required fields up front.

  • Write

    Activate Branded Calling on an enterprise

    Branded Calling must be activated on each enterprise. Activation is idempotent: - First call: marks the enterprise as activated, effective immediately; you can create a DIR right away.

  • Destructive

    Replace an enterprise

    Replace the enterprise's mutable fields. Only mutable fields may be sent.

  • Destructive

    Delete an enterprise

    Soft-delete an enterprise. Failure modes: - 400 - the enterprise still has dependent resources in a non-deletable state. Remove those first; the response detail identifies what is blocking the delete. - 409 - the enterprise has a dependent resource with an unresolved claim.

Reputation

  • Read

    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.

  • Read

    Get the ownership-proof review status

    Get the review status of the enterprise's ownership proof for phone numbers hosted with another provider. Returns 404 when no proof has been submitted.

  • Read

    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 where one has been collected.

  • Read

    Get a single reputation-monitored phone number

    Retrieve one registered number with its latest reputation snapshot. The phonenumber path parameter is in E.164 format and must be URL-encoded (e.g. %2B19493253498).

  • Read

    Get a phone number's ownership tracking detail

    Get the ownership status of a phone number, when it was last checked, the carrier recorded as its baseline, and the history of ownership events.

  • Read

    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 full detail. Supports JSON:API pagination and optional filters on status and created-at range.

  • Read

    Get a reputation remediation request

    Retrieve the full detail of a remediation request, including current status, per-number results (once available), and submission metadata.

  • Read

    List reputation-monitored phone numbers across all enterprises

    Convenience alias for GET /v2/enterprises/{enterpriseid}/reputation/numbers that returns numbers across every enterprise you own. Useful when you don't want to look up the enterprise id first.

  • Read

    Get a reputation-monitored number (no enterpriseid required)

    Convenience alias for GET /v2/enterprises/{enterpriseid}/reputation/numbers/{phonenumber}.

  • Write

    Enable phone-number reputation for an enterprise

    Activate Phone Number Reputation for the given enterprise. Requires an uploaded Letter of Authorization document (the loadocumentid references the Telnyx Documents API) and a refresh-frequency selection.

  • Write

    Submit ownership proof for numbers hosted elsewhere

    Request permission to add phone numbers that the enterprise owns but that are hosted with another provider. Submit one or more uploaded documents proving ownership, such as a carrier invoice or account statement. The request is reviewed once per enterprise.

  • Write

    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. The enterprise's reputation must be in approved status.

  • Write

    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 optional agent block is supplied only when a third-party partner manages the numbers.

  • Write

    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 additional phone numbers can be added.

  • Write

    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 (+1NPANXXXXXX for US/CA).

  • Write

    Force a reputation refresh

    Immediately refresh the stored reputation data for the listed numbers. This is in addition to the periodic refresh determined by checkfrequency. Up to 100 numbers per call. The response carries the kicked-off jobs; the actual refresh runs asynchronously.

  • Write

    Confirm or give up ownership of a phone number

    Answer an ownership question about a phone number hosted with another provider.

  • Write

    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 202 with the persisted request id, then the request transitions through processing states until completion.

  • Write

    Set the number-ownership webhook URL

    Set the HTTPS URL that receives number-ownership events for this enterprise: numberreputation.number.flagged, numberreputation.number.removed and numberreputation.externalverification.statuschanged. Send webhookurl: null to stop receiving them.

  • Destructive

    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 204 on success, 404 if reputation is not enabled for this enterprise.

  • Destructive

    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.

  • Destructive

    Remove a phone number from reputation monitoring (no enterpriseid required)

    Convenience alias for DELETE /v2/enterprises/{enterpriseid}/reputation/numbers/{phonenumber}.

External Connections

  • Read

    List all External Connections

    This endpoint returns a list of your External Connections inside the 'data' attribute of the response.

  • Read

    List all log messages

    Retrieve a list of log messages for all external connections associated with your account.

  • Read

    Retrieve a log message

    Retrieve a log message for an external connection associated with your account.

  • Read

    Retrieve an External Connection

    Return the details of an existing External Connection inside the 'data' attribute of the response.

  • Read

    List all civic addresses and locations

    Returns the civic addresses and locations from Microsoft Teams.

  • Read

    Retrieve a Civic Address

    Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.

  • Read

    List all phone numbers

    Returns a list of all active phone numbers associated with the given external connection.

  • Read

    Retrieve a phone number

    Return the details of a phone number associated with the given external connection.

  • Read

    List all Releases

    Returns a list of your Releases for the given external connection. These are automatically created when you change the connectionid of a phone number that is currently on Microsoft Teams.

  • Read

    Retrieve a Release request

    Return the details of a Release request and its phone numbers.

  • Read

    List all Upload requests

    Returns a list of your Upload requests for the given external connection.

  • Read

    Get the count of pending upload requests

    Returns the count of all pending upload requests for the given external connection.

  • Read

    Retrieve an Upload request

    Return the details of an Upload request and its phone numbers.

  • Write

    Creates an External Connection

    Creates a new External Connection based on the parameters sent in the request. The externalsipconnection and outbound voice profile id are required. Once created, you can assign phone numbers to your application using the /phonenumbers endpoint.

  • Write

    Update an External Connection

    Updates settings of an existing External Connection based on the parameters of the request.

  • Write

    Update a location's static emergency address

    Update the static emergency address assigned to a specific location of an external connection.

  • Write

    Update a phone number

    Asynchronously update settings of the phone number associated with the given external connection.

  • Write

    Creates an Upload request

    Creates a new Upload request to Microsoft teams with the included phone numbers. Only one of civicaddressid or locationid must be provided, not both. The maximum allowed phone numbers for the numbersids array is 1000.

  • Write

    Refresh the status of all Upload requests

    Forces a recheck of the status of all pending Upload requests for the given external connection in the background.

  • Write

    Retry an Upload request

    If there were any errors during the upload process, this endpoint will retry the upload request. In some cases this will reattempt the existing upload request, in other cases it may create a new upload request.

  • Write

    Refresh Operator Connect integration

    This endpoint will make an asynchronous request to refresh the Operator Connect integration with Microsoft Teams for the current user. This will create new external connections on the user's account if needed, and/or report the integration results as log messages.

  • Destructive

    Dismiss a log message

    Dismiss a log message for an external connection associated with your account.

  • Destructive

    Deletes an External Connection

    Permanently deletes an External Connection. Deletion may be prevented if the application is in use by phone numbers, is active, or if it is an Operator Connect connection. To remove an Operator Connect integration please contact Telnyx support.

Requirement Groups

  • Read

    Get action requirement details for a sub number order

    Returns the input fields an action requirement needs and the current requirement action for a sub number order. Action requirements are fulfilled by an external step rather than by uploading documents. Australia mobile ID verification is currently the only action requirement.

  • Read

    List requirement groups

    Returns regulatory requirement groups for the account. Results can be filtered by country, number type, action, approval status, and customer reference.

  • Read

    Get a single requirement group by ID

    Returns the regulatory requirement group identified by id, including its requirement values and current approval status.

  • Write

    Fulfill an action requirement for a sub number order

    Submits the end user's details to the external verification provider and returns the requirement action. Australia mobile ID verification is currently the only action requirement.

  • Write

    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.

  • Write

    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 retained on the created group.

  • Write

    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.

  • Write

    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.

  • Write

    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.

  • Destructive

    Delete a requirement group by ID

    Deletes the regulatory requirement group identified by id. The response contains the deleted requirement-group representation.

Programmable Fax Applications

  • Read

    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 filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.

  • Read

    Retrieve a Fax Application

    Return the details of an existing Fax Application inside the 'data' attribute of the response.

  • Write

    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 phone numbers to your application using the /phonenumbers endpoint.

  • Write

    Update a Fax Application

    Updates settings of an existing Fax Application based on the parameters of the request.

  • Destructive

    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

  • Read

    View a list of faxes

    Retrieve a paginated list of faxes sent or received on your account.

  • Read

    View a fax

    Returns the details of a single fax, including its current status.

  • Write

    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 filesizelimitexceeded and pagecountlimitexceeded respectively.

  • Write

    Refresh a fax

    Refreshes the inbound fax's mediaurl when it has expired

  • Destructive

    Delete a fax

    Delete a fax resource from your account.

  • Destructive

    Cancel a fax

    Cancel the outbound fax that is in one of the following states: queued, media.processed, originated or sending

FQDN Connections

  • Read

    List FQDN connections

    Returns a list of your FQDN connections.

  • Read

    Retrieve an FQDN authentication

    Retrieves the details of an existing FQDN authentication strategy for a specific FQDN connection.

  • Read

    Retrieve an FQDN connection

    Retrieves the details of an existing FQDN connection.

  • Write

    Create an FQDN connection

    Creates a new FQDN-based SIP connection. FQDN connections authenticate by your registered domain names rather than static IP addresses.

  • Write

    Update an FQDN authentication

    Updates the FQDN authentication strategy for a specific FQDN connection.

  • Write

    Update an FQDN connection

    Updates settings of an existing FQDN connection.

  • Destructive

    Delete an FQDN connection

    Permanently deletes the specified FQDN connection from your account.

FQDNs

  • Read

    List FQDNs

    Get all FQDNs belonging to the user that match the given filters.

  • Read

    Retrieve an FQDN

    Return the details regarding a specific FQDN.

  • Write

    Create an FQDN

    Creates a new FQDN record and attaches it to the specified connection.

  • Write

    Update an FQDN

    Updates the details of the specified FQDN record and returns the updated FQDN.

  • Destructive

    Delete an FQDN

    Permanently deletes the specified FQDN record from its connection.

Global IPs

  • Read

    List all Global IP Allowed Ports

    Returns the ports allowed for Global IP traffic, for use when configuring Global IP resources.

  • Read

    Global IP Assignment Health Check Metrics

    Retrieve health check metrics for your Global IP assignments.

  • Read

    List all Global IP assignments

    Returns a paginated list of your Global IP assignments, the links between Global IPs and the WireGuard peers that receive their traffic.

  • Read

    Global IP Assignment Usage Metrics

    Retrieve usage metrics for your Global IP assignments.

  • Read

    Retrieve a Global IP assignment

    Returns the details of a single Global IP assignment, including the Global IP and WireGuard peer it links.

  • Read

    List all Global IP Health check types

    Returns the health check types available for Global IPs, for use when creating Global IP health checks.

  • Read

    List all Global IP health checks

    Returns a paginated list of the Global IP health checks configured on your account.

  • Read

    Retrieve a Global IP health check

    Returns the details of a single Global IP health check, including its type and configuration.

  • Read

    Global IP Latency Metrics

    Retrieve latency metrics measured for your Global IPs.

  • Read

    List all Global IP Protocols

    Returns the network protocols supported for Global IP traffic, for use when configuring Global IP resources.

  • Read

    Global IP Usage Metrics

    Retrieve usage metrics for your Global IPs.

  • Read

    List all Global IPs

    Returns a paginated list of the Global IPs on your account, including each IP's address and configuration.

  • Read

    Retrieve a Global IP

    Returns the details of a single Global IP, including its address and current configuration.

  • Write

    Create a Global IP assignment

    Assigns a Global IP to a WireGuard peer so traffic destined for the IP is delivered over that peer's tunnel. Assignment is asynchronous, so the request is accepted and completes in the background.

  • Write

    Update a Global IP assignment

    Updates the specified Global IP assignment with the provided fields and returns the updated assignment.

  • Write

    Create a Global IP health check

    Creates a health check for a Global IP to monitor the health of its assignments. Creation is asynchronous, so the request is accepted and the health check becomes active once provisioning completes.

  • Write

    Create a Global IP

    Requests creation of a new Global IP, a static IP address announced from the Telnyx network. Provisioning is asynchronous, so the request is accepted and the Global IP becomes available once provisioning completes.

  • Destructive

    Delete a Global IP assignment

    Deletes the specified Global IP assignment, detaching the Global IP from its WireGuard peer.

  • Destructive

    Delete a Global IP health check

    Deletes the specified Global IP health check so it no longer monitors the Global IP's assignments.

  • Destructive

    Delete a Global IP

    Deletes the specified Global IP and releases its address back to Telnyx.

Inexplicit Number Orders

  • Read

    List inexplicit number orders

    Get a paginated list of inexplicit number orders.

  • Read

    Retrieve an inexplicit number order

    Get an existing inexplicit number order by ID.

  • Write

    Create an inexplicit number order

    Create an inexplicit number order to programmatically purchase phone numbers without specifying exact numbers.

Integration Secrets

  • Read

    List integration secrets

    Retrieve a list of all integration secrets configured by the user.

  • Write

    Create a secret

    Create a new secret with an associated identifier that can be used to securely integrate with other services.

  • Destructive

    Delete an integration secret

    Delete an integration secret given its ID.

Inventory Level

  • Read

    Create an inventory coverage request

    Creates an inventory coverage request. If locality, npa or nationaldestinationcode is used in groupBy, and no region or locality filters are used, the whole paginated set is returned.

Invoices

  • Read

    List invoices

    Returns a paginated list of your invoices, with support for sorting.

  • Read

    Get invoice by ID

    Retrieve a single invoice by its unique identifier.

IP Connections

  • Read

    List Ip connections

    Returns a paginated list of your IP-based SIP connections, with support for filtering and sorting.

  • Read

    Retrieve an Ip connection

    Retrieves the details of an existing ip connection.

  • Write

    Create an Ip connection

    Creates a new IP-based SIP connection, which authenticates traffic by source IP address.

  • Write

    Update an Ip connection

    Updates settings of an existing IP connection.

  • Destructive

    Delete an Ip connection

    Permanently deletes the specified IP connection from your account.

IPs

  • Read

    List Ips

    Get all IPs belonging to the user that match the given filters.

  • Read

    Retrieve an Ip

    Return the details regarding a specific IP.

  • Write

    Create an Ip

    Creates a new IP record for use with IP-based connections, associating an IP address with the specified connection.

  • Write

    Update an Ip

    Updates the details of the specified IP record and returns the updated IP.

  • Destructive

    Delete an Ip

    Permanently deletes the specified IP record from its connection.

Reports

  • Read

    Get a ledger billing group report

    Retrieve the details and status of a previously created ledger billing group report.

  • Write

    Create a ledger billing group report

    Create a ledger billing group report, which aggregates ledger activity by billing group.

Speech to Text Batch Reports

  • Read

    Get all Speech to Text batch report requests

    Retrieves all Speech to Text batch report requests for the authenticated user

  • Read

    Get a specific Speech to Text batch report request

    Retrieves a specific Speech to Text batch report request by ID

  • Write

    Create a new Speech to Text batch report request

    Creates a new Speech to Text batch report request with the specified filters

  • Destructive

    Delete a Speech to Text batch report request

    Deletes a specific Speech to Text batch report request by ID

MDR Detailed Reports

  • Read

    Get all MDR detailed report requests

    Retrieves all MDR detailed report requests for the authenticated user

  • Read

    Get a specific MDR detailed report request

    Retrieves a specific MDR detailed report request by ID

  • Write

    Create a new MDR detailed report request

    Creates a new MDR detailed report request with the specified filters

  • Destructive

    Delete a MDR detailed report request

    Deletes a specific MDR detailed report request by ID

CDR Reports

  • Read

    Get all CDR report requests

    Retrieves all CDR report requests for the authenticated user

  • Read

    Get available CDR report fields

    Retrieves all available fields that can be used in CDR reports

  • Read

    Get a specific CDR report request

    Retrieves a specific CDR report request by ID

  • Write

    Create a new CDR report request

    Creates a new CDR report request with the specified filters

  • Destructive

    Delete a CDR report request

    Deletes a specific CDR report request by ID

MDR Usage Reports

  • Read

    List MDR usage reports

    Fetch all previous requests for MDR usage reports.

  • Read

    Get an MDR usage report

    Returns a single MDR (Message Detail Record) usage report by its identifier, including its parameters and current status.

  • Read

    Fetch all Messaging usage reports

    Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown

  • Read

    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 polling is necessary but the response may take up to a couple of minutes.

  • Read

    Retrieve messaging report

    Fetch a single messaging usage report by id

  • Write

    Create a new legacy usage V2 MDR report request

    Creates a new legacy usage V2 MDR report request with the specified filters

  • Write

    Create MDR Usage Report

    Submit request for new new messaging usage report. This endpoint will pull and aggregate messaging data in specified time period.

  • Destructive

    Delete a V2 legacy usage MDR report request

    Deletes a specific V2 legacy usage MDR report request by ID

  • Destructive

    Delete MDR Usage Report

    Permanently deletes the specified messaging usage report by its identifier.

Telco Data Usage Reports

  • Read

    List telco data usage reports

    Retrieve a paginated list of telco data usage reports

  • Read

    Get telco data usage report by ID

    Retrieve a specific telco data usage report by its ID

  • Write

    Submit telco data usage report

    Submits a new telco data (number lookup) usage report request. The report is generated asynchronously; retrieve it by its identifier once ready.

  • Destructive

    Delete telco data usage report

    Delete a specific telco data usage report by its ID

Speech to text Usage Reports

  • Read

    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

  • Read

    List CDR usage reports

    Fetch all previous requests for cdr usage reports.

  • Read

    Get a CDR usage report

    Returns a single CDR (Call Detail Record) usage report by its identifier, including its parameters and current status.

  • Read

    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 necessary but the response may take up to a couple of minutes.

  • Write

    Create a new legacy usage V2 CDR report request

    Creates a new legacy usage V2 CDR report request with the specified filters

  • Destructive

    Delete a V2 legacy usage CDR report request

    Deletes a specific V2 legacy usage CDR report request by ID

AI Gateway

  • Read

    List gateway spend events

    Return request-level usage history for the authenticated account. Supply both UTC dates or neither; omitting both returns the previous full UTC day. Dates use a half-open range [startdate, enddate) of at most 31 days. Cost reflects budget reference rates, not invoice charges.

  • Read

    Get gateway spend summary

    Return request counts, token counts and reference spend grouped by one attribution dimension. Both UTC dates and groupby are required. Dates use a half-open range [startdate, enddate) of at most 31 days. Cost reflects budget reference rates, not invoice charges.

  • Read

    List gateway token groups

    List gateway token groups within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response.

  • Read

    Get gateway token group

    Get gateway token group within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response.

  • Read

    List gateway token keys

    List gateway token keys within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response.

  • Read

    Get gateway token key

    Get gateway token key within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response.

  • Read

    Export gateway usage

    Durable, replayable, content-free usage export for customer pipelines. Requires the dedicated llmtokengateway.usageexport.read V2 action; spend.read and usage.read do not grant it.

  • Read

    Get gateway usage summary

    Gateway reference/enforcement usage, not invoice truth or BYOK provider charges. Requires the dedicated llmtokengateway.usage.read V2 action for combined spend and guardrail reporting; existing spend.read and guardrailevents.read grants do not grant this endpoint.

  • Write

    Create gateway token group

    Create gateway token group within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response.

  • Write

    Update gateway token group

    Update gateway token group within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response. Omitted fields are preserved. Null clears the optional concurrency, fallback and retry settings.

  • Write

    Create gateway token key

    Create gateway token key within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response. The token secret is returned only on the original create response. A replay returns metadata without the secret.

  • Write

    Update gateway token key

    Update gateway token key within the authenticated Telnyx account. Foreign and unknown resource IDs return the same 404 response. Omitted fields are preserved. Null clears maxparallelrequests; null resets budget and rate limits to their maximum. A stale If-Match returns 412.

  • Destructive

    Delete gateway token group

    Revoke resource and its keys atomically; retain historical attribution, never detach into an ungoverned service key.

  • Destructive

    Delete gateway token key

    Revoke this token key. Acknowledged revocation blocks new admissions with the key; requests already admitted may complete. Historical usage attribution is retained. Other keys in the group are unchanged.

Machine Payments

  • Write

    Create a machine payment account credit

    Creates an account credit using the Machine Payment Protocol (MPP), an HTTP-402 payment flow for machines and agents. The flow has two steps.

Managed Accounts

  • Read

    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.

  • Read

    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.

  • Read

    Retrieve a managed account

    Retrieves the details of a single managed account.

  • Write

    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.

  • Write

    Update a managed account

    Updates the specified managed account's attributes and returns the updated account.

  • Write

    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 affected. The managed account and its sub-users will no longer be able to log in via the mission control portal.

  • Write

    Enables a managed account

    Enables a managed account and its sub-users to use Telnyx services.

  • Write

    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.

Media Storage API

  • Read

    List uploaded media

    Returns a list of the media files stored on your account, with support for filtering.

  • Read

    Retrieve stored media

    Returns the information about a stored media file.

  • Read

    Download stored media

    Downloads the raw content of the specified stored media file.

  • Write

    Upload media

    Upload media file to Telnyx so it can be used with other Telnyx services

  • Destructive

    Update stored media

    Updates the specified stored media file and returns the updated resource.

  • Destructive

    Deletes stored media

    Permanently deletes the specified media file from storage.

Meeting Sessions

  • Read

    List meeting sessions

    Returns a list of meeting sessions, optionally filtered by status.

  • Read

    Retrieve a meeting session

    Retrieves a single meeting session by ID. A session that does not exist or that belongs to a different account both return 404.

  • Write

    Create a meeting session

    Creates a new meeting session. When an idempotencykey is supplied in the request body, replay lookup is scoped to the authenticated account and compares only the key; the request payload is not fingerprinted or compared.

  • Write

    Update a meeting session

    Updates mutable properties of a meeting session. Only sessions in the scheduled state can be updated; any other state returns 409 with the invalidstate error code. All request fields are optional, and an empty object is a valid no-op update.

  • Destructive

    Delete a meeting session

    Stops a meeting session without deleting its persisted record. Scheduled bots are cancelled, while bots that are joining or active are asked to leave. The persisted meeting session record remains available.

Meeting Session Actions

  • Write

    Send chat in a meeting session

    Sends a chat message into a meeting session.

  • Write

    Speak in a meeting session

    Sends audio / text-to-speech into a meeting session. With a Telnyx AI Assistant attached, the bot is a webpage-output bot: the speak audio routes through the assistant's output page rather than the bot mic and plays once the assistant is connected -- it is not refused.

  • Write

    Stop speaking in a meeting session

    Stops any active text-to-speech playback in a meeting session. Sessions with a digital avatar (assistant.avatar: true) return 409 invalidstate (message prefix avatarrequiresassistantspeech:): the avatar renders only the assistant's own speech.

Meeting Session Artifacts

  • Read

    List meeting session artifacts

    Returns a list of artifacts for a meeting session.

  • Read

    Retrieve a meeting session artifact

    Retrieves a single meeting session artifact by ID.

  • Write

    Create a meeting session artifact

    Requests asynchronous generation of one artifact: summary, actionitems, decisions, topics, openquestions, or custom. Each request produces one artifact. custom is answered from a prompt you supply, which is required for custom and rejected on the five named types.

Meeting Session Data

  • Read

    List meeting session events

    Returns stored events ordered by ascending seq. To continue, pass the last returned item's seq as after. An empty page means no later stored events existed at read time; this operation returns no separate next-page cursor. Default limit is 100 and maximum is 1,000.

  • Read

    List meeting session transcript

    Returns transcript segments ordered by ascending seq. Default limit is 100 and maximum is 1,000. Continue with after=meta.nextafter.

  • Destructive

    Delete meeting session recording media

    Irreversibly requests deletion of the aggregate recording media for the session. The operation retains the Telnyx-local Meeting session, transcript segments, events, artifacts, and usage records.

Messages

  • Read

    Retrieve group MMS messages

    Retrieve all messages in a group MMS conversation by the group message ID.

  • Read

    Retrieve a message

    Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation. If you require messages older than this, please generate an MDR report.

  • Write

    Send a message

    Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool. This endpoint allows you to send a message with any messaging resource. Current messaging resources include: long-code, short-code, number-pool, and alphanumeric-sender-id.

  • Write

    Send a message using an alphanumeric sender ID

    Send an SMS message using an alphanumeric sender ID. This is SMS only.

  • Write

    Send a group MMS message

    Queues an MMS addressed to multiple recipients as a group conversation. Delivery events are reported asynchronously through messaging webhooks.

  • Write

    Send a long code message

    Queues an outbound SMS or MMS using a long-code sender. Delivery progress and final disposition are reported asynchronously through messaging webhooks.

  • Write

    Send a message using number pool

    Queues an outbound message using a number pool. Telnyx selects an eligible sender from the pool according to its messaging profile configuration.

  • Write

    Schedule a message

    Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool. This endpoint allows you to schedule a message with any messaging resource. Current messaging resources include: long-code, short-code, number-pool, and alphanumeric-sender-id.

  • Write

    Send a short code message

    Queues an outbound SMS or MMS using a short-code sender. Delivery progress and final disposition are reported asynchronously through messaging webhooks.

  • Destructive

    Cancel a scheduled message

    Cancel a scheduled message that has not yet been sent. Only messages with status=scheduled and sendat more than a minute from now can be cancelled.

RCS

  • Read

    List all RCS agents

    Returns RCS agents available to the authenticated account.

  • Read

    Retrieve an RCS agent

    Returns the configuration and current state of the specified RCS agent.

  • Read

    Check RCS capabilities (batch)

    Returns RCS capability information for multiple recipients in one request.

  • Read

    Check RCS capabilities

    Returns the RCS features supported by the specified recipient for the selected agent.

  • Write

    Send an RCS message

    Queues an outbound RCS message through the selected RCS agent. Check recipient capabilities before sending features that require RCS support.

  • Write

    Modify an RCS agent

    Updates the supplied configuration fields on the specified RCS agent.

  • Destructive

    Add RCS test number

    Adds a test phone number to an RCS agent for testing purposes.

Whatsapp messaging

  • Write

    Send a Whatsapp message

    Sends a WhatsApp message using a Telnyx WhatsApp-enabled number. The message body, interactive elements, media, location, and reaction content are specified in the whatsappmessage field.

Verification Requests

  • Read

    Get Verification Request Status History

    Get the history of status changes for a verification request. Returns a paginated list of historical status changes including the reason for each change and when it occurred.

  • Read

    List Verification Requests

    Get a list of previously-submitted tollfree verification requests

  • Read

    Get Verification Request

    Get a single verification request by its ID.

  • Write

    Submit Verification Request

    Submit a new tollfree verification request

  • Write

    Update Verification Request

    Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken.

  • Destructive

    Delete Verification Request

    Delete a verification request A request may only be deleted when when the request is in the "rejected" state. HTTP 200: request successfully deleted HTTP 400: request exists but can't be deleted (i.e. not rejected) HTTP 404: request unknown or already deleted

Hosted Numbers

  • Read

    List messaging hosted number orders

    Returns hosted-messaging orders for the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

  • Read

    Check hosted messaging eligibility

    Checks whether the supplied phone numbers are eligible for hosted messaging before an order is created.

  • Read

    Retrieve a messaging hosted number order

    Returns the current state, phone numbers, and required actions for the specified hosted-messaging order.

  • Read

    Validate hosted number codes

    Validate the verification codes sent to the numbers of the hosted order. The verification codes must be created in the verification codes endpoint.

  • Write

    Create a messaging hosted number order

    Creates an order to enable Telnyx messaging on phone numbers whose voice service remains with another carrier.

  • Write

    Upload hosted number document

    Uploads a supporting document to the specified hosted-messaging order.

  • Write

    Create hosted number verification codes

    Create verification codes to validate numbers of the hosted order. The verification codes will be sent to the numbers of the hosted order.

  • Destructive

    Delete a messaging hosted number order

    Delete a messaging hosted number order and all associated phone numbers.

  • Destructive

    Delete a messaging hosted number

    Removes the specified hosted number from Telnyx messaging management.

Number Settings

  • Read

    Retrieve bulk update status

    Returns processing status and results for a bulk messaging-settings update order.

  • Read

    List phone numbers with messaging settings

    Returns phone numbers with their current messaging product and messaging-profile assignments.

  • Read

    Retrieve a phone number with messaging settings

    Returns the messaging product and messaging-profile assignment for the specified phone number.

  • Write

    Bulk update phone number profiles

    Starts a bulk update of messaging-profile assignments for the supplied phone numbers. The response identifies the order used to monitor processing.

  • Write

    Update the messaging profile and/or messaging product of a phone number

    Updates the messaging product, messaging profile, or both for the specified phone number.

Opt Out Management

  • Read

    List opt-outs

    Returns a paginated list of opt-out blocks created when message recipients opt out. Supports filtering and optional redaction of recipient numbers.

  • Read

    List Auto-Response Settings

    Returns the auto-response rules configured for the specified messaging profile.

  • Read

    Get Auto-Response Setting

    Returns the matching criteria and response content for the specified auto-response rule.

  • Write

    Create auto-response setting

    Creates an auto-response rule on the specified messaging profile. Matching inbound messages trigger the configured response.

  • Destructive

    Update Auto-Response Setting

    Replaces the configuration of the specified auto-response rule.

  • Destructive

    Delete Auto-Response Setting

    Deletes the specified auto-response rule from the messaging profile.

Messaging URL Domains

  • Read

    List messaging URL domains

    Returns the URL domains available to the authenticated account for message URL shortening.

Mobile Network Operators

  • Read

    List mobile network operators

    Telnyx has a set of GSM mobile operators partners that are available through our mobile network roaming. This resource is entirely managed by Telnyx and may change over time. That means that this resource won't allow any write operations for it.

Mobile Number Settings

  • Read

    List mobile phone numbers with messaging settings

    Returns mobile phone numbers with their current messaging configuration.

  • Read

    Retrieve a mobile phone number with messaging settings

    Returns the messaging configuration for the specified mobile phone number.

Push Credentials

  • Read

    List mobile push credentials

    Returns a paginated list of the mobile push credentials on your account, with support for filtering.

  • Read

    Retrieves a mobile push credential

    Retrieves mobile push credential based on the given pushcredentialid

  • Write

    Creates a new mobile push credential

    Creates a new mobile push credential for delivering push notifications to iOS or Android apps, and returns the created credential.

  • Destructive

    Deletes a mobile push credential

    Deletes a mobile push credential based on the given pushcredentialid

Coverage

  • Read

    List network coverage locations

    List all locations and the interfaces that region supports

Network Routes

  • Read

    List all Network Routes

    Lists the routes of the account's Networks. A Network's list is its effective route table: the routes added with POST /networkroutes (origin static) and the routes that its attachments install (origin attachment). Lookup is longest prefix within the Network.

  • Read

    Retrieve a Network Route

    Retrieves a route and its status.

  • Write

    Create a Network Route

    Adds a route to a Network. Traffic on the Network to an address in cidr goes via nexthop. With a tunnel as the next hop, functions on the Network reach the CIDR through the tunnel without a redeploy. A Network holds each CIDR once.

  • Destructive

    Delete a Network Route

    Deletes a route that was added with POST /networkroutes. Traffic to its CIDR stops going via the next hop at once. Routes that an attachment installs (origin attachment) leave with the attachment and cannot be deleted here.

Networks

  • Read

    List all Networks

    Returns a paginated list of the private networks on your account, with support for filtering.

  • Read

    Retrieve a Network

    Returns the details of a single network by its identifier.

  • Read

    Get Default Gateway status.

    Returns the status of the default gateway configured on the specified network.

  • Read

    List all Interfaces for a Network.

    Returns a paginated list of the interfaces attached to the specified network, with support for filtering.

  • Write

    Create a Network

    Creates a new private network, the container that links your WireGuard interfaces, gateways, and cross connects.

  • Write

    Update a Network

    Updates the specified network's attributes and returns the updated network.

  • Write

    Create Default Gateway.

    Creates a default gateway on the specified network, directing the network's outbound traffic through the chosen gateway.

  • Destructive

    Delete a Network

    Permanently deletes the specified network from your account.

  • Destructive

    Delete Default Gateway.

    Removes the default gateway from the specified network.

Noise Suppression Engines

  • Read

    List available noise suppression engines

    Returns all noise suppression engines available to the authenticated user. Engines gated behind a feature flag are included only when the flag is enabled for the user's account. Results are not paginated; the number of engines is expected to remain small.

Notifications

  • Read

    List notification channels

    Returns a paginated list of your notification channels, the destinations that receive notifications.

  • Read

    Get a notification channel

    Returns the details of a single notification channel by its identifier.

  • Read

    List all Notifications Events Conditions

    Returns a list of your notifications events conditions.

  • Read

    List all Notifications Events

    Returns a list of your notifications events.

  • Read

    List all Notifications Profiles

    Returns a list of your notifications profiles.

  • Read

    Get a notification profile

    Returns the details of a single notification profile by its identifier.

  • Read

    List notification settings

    Returns a paginated list of your notification settings, which map notification event types to profiles and channels.

  • Read

    Get a notification setting

    Returns the details of a single notification setting by its identifier.

  • Write

    Create a notification channel

    Creates a new notification channel defining where notifications are delivered, and returns the created channel.

  • Write

    Update a notification channel

    Updates the specified notification channel and returns the updated channel.

  • Write

    Create a notification profile

    Creates a new notification profile, a named grouping used to organize notification settings, and returns it.

  • Write

    Update a notification profile

    Updates the specified notification profile and returns the updated profile.

  • Write

    Add a Notification Setting

    Adds a notification setting that enables delivery of a notification event type to a notification profile.

  • Destructive

    Delete a notification channel

    Deletes the specified notification channel so notifications are no longer delivered to it.

  • Destructive

    Delete a notification profile

    Deletes the specified notification profile from your account.

  • Destructive

    Delete a notification setting

    Deletes the specified notification setting, disabling that notification delivery.

Phone Number Block Orders

  • Read

    List number block orders

    Get a paginated list of number block orders.

  • Read

    Retrieve a number block order

    Get an existing phone number block order.

  • Write

    Create a number block order

    Creates an order for a block of consecutive phone numbers and returns the created order. Track fulfillment through the order's status.

Number Lookup

  • Read

    Lookup phone number data

    Returns information about the provided phone number.

Phone Number Reservations

  • Read

    List number reservations

    Gets a paginated list of phone number reservations.

  • Read

    Retrieve a number reservation

    Returns the details of a single phone number reservation, including its status and the reserved numbers.

  • Write

    Create a number reservation

    Creates a Phone Number Reservation for multiple numbers.

  • Write

    Extend a number reservation

    Extends reservation expiry time on all phone numbers.

Numbers features

  • Read

    Retrieve the features for a list of numbers

    Retrieve the features for a list of numbers

OAuth Protocol

  • Read

    OAuth authorization endpoint

    OAuth 2.0 authorization endpoint for the authorization code flow

  • Read

    Get OAuth consent token

    Retrieve details about an OAuth consent token

  • Read

    JSON Web Key Set

    Retrieve the JSON Web Key Set for token verification

  • Write

    Create OAuth grant

    Creates an OAuth authorization grant and returns the grant response for completing the authorization flow.

  • Write

    Token introspection

    Introspect an OAuth access token to check its validity and metadata

  • Write

    Dynamic client registration

    Register a new OAuth client dynamically (RFC 7591)

  • Write

    OAuth token endpoint

    Exchange authorization code, client credentials, or refresh token for access token

OAuth Clients

  • Read

    List OAuth clients

    Retrieve a paginated list of OAuth clients for the authenticated user

  • Read

    Get OAuth client

    Returns the details of a single OAuth client on your account by its ID.

  • Write

    Create OAuth client

    Creates a new OAuth client on your account for authenticating third-party integrations, and returns the created client.

  • Destructive

    Update OAuth client

    Updates the specified OAuth client's configuration and returns the updated client.

  • Destructive

    Delete OAuth client

    Permanently deletes the specified OAuth client from your account.

OAuth Grants

  • Read

    List OAuth grants

    Retrieve a paginated list of OAuth grants for the authenticated user

  • Read

    Get OAuth grant

    Returns the details of a single OAuth grant on your account by its ID.

  • Destructive

    Revoke OAuth grant

    Revokes the specified OAuth grant, withdrawing the access previously granted to the client.

Organization Users

  • Read

    List organization users

    Returns a list of the users in your organization.

  • Read

    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 information. The report can be retrieved in JSON or CSV format by sending specific content-type headers.

  • Read

    Get organization user

    Returns the details of a user in your organization, optionally including the groups the user belongs to.

  • Destructive

    Delete organization user

    Removes the specified user from your organization and returns the result of the removal.

OTA updates

  • Read

    List OTA updates

    Retrieve a paginated list of over-the-air (OTA) update operations for your SIM cards.

  • Read

    Get OTA update

    This API returns the details of an Over the Air (OTA) update.

Outbound Voice Profiles

  • Read

    Get all outbound voice profiles

    Get all outbound voice profiles belonging to the user that match the given filters.

  • Read

    Retrieve an outbound voice profile

    Retrieves the details of an existing outbound voice profile.

  • Write

    Create an outbound voice profile

    Creates a new outbound voice profile defining calling permissions, destinations, and limits for outbound calls, and returns the created profile.

  • Write

    Updates an existing outbound voice profile.

    Updates an existing outbound voice profile.

  • Destructive

    Delete an outbound voice profile

    Deletes an existing outbound voice profile.

Pay Connectors

  • Read

    List Pay connectors

    List connectors belonging to the authenticated organization, including connectors created by other users in that organization. Set filter[type]=generic to restrict results to the type covered here. Results default to newest createdat first.

  • Read

    Retrieve a Pay connector

    Retrieve a connector by name within the authenticated organization. Password and token are omitted. A missing name or a connector owned by another organization returns 404.

  • Write

    Create a Pay connector

    Create a generic payment connector in the authenticated organization. The name must be unique in that organization. Authentication supplies ownership; do not send userid or organizationid. Config is encrypted at rest; passwords and tokens are omitted from responses.

  • Write

    Update a Pay connector

    Update a generic connector by name in the authenticated organization. Both test and live connectors can be updated through the API. Omitted fields remain unchanged. Supplying config replaces the entire config; it does not merge keys.

  • Destructive

    Delete a Pay connector

    Delete a connector by name in the authenticated organization. Both test and live connectors can be deleted. Returns no response body on success; a missing name or a connector in another organization returns 404.

Auto Recharge Preferences

  • Read

    List auto recharge preferences

    Returns the payment auto recharge preferences.

  • Write

    Update auto recharge preferences

    Update payment auto recharge preferences.

Phone Number Blocks Background Jobs

  • Read

    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 metadata.

  • Read

    Retrieves a phone number blocks job

    Returns the status and details of the phone-number-block background job identified by id.

  • Destructive

    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.

Whatsapp Phone Numbers

  • Read

    List Whatsapp phone numbers

    Retrieve a list of the phone numbers registered for WhatsApp on your account.

  • Read

    Retrieve a WhatsApp phone number

    Returns one WhatsApp phone number linked to the authenticated Telnyx account. For a coexistence number in the syncing state, the response includes syncprogress.

  • Read

    Get calling settings for a phone number

    Retrieve the WhatsApp calling settings for a phone number.

  • Read

    Get conversation window status for a phone number

    Returns whether the 24-hour conversation window is currently open for a given source/destination pair. If windowactive is false, only template messages may be sent.

  • Read

    Get phone number conversational components

    Retrieve the conversational components configuration for a WhatsApp phone number.

  • Read

    Get phone number business profile

    Retrieve the WhatsApp business profile associated with a phone number.

  • Read

    Get Whatsapp profile photo

    Retrieve the profile photo of a WhatsApp phone number.

  • Read

    Get Connection ID for a WhatsApp Calling BYON number

    Retrieve the connection ID currently stored for a WhatsApp Calling BYON (Bring Your Own Number) phone number: the connection that inbound WhatsApp calls to the number are delivered to. Use it to check the result of PATCH /whatsapp/phonenumbers/{id}/callingrouting.

  • Write

    Initialize Whatsapp phone number verification

    Start the verification process to register a phone number with a WhatsApp Business Account.

  • Write

    Enable or disable Whatsapp calling for a phone number

    Enable or disable WhatsApp calling for a phone number and manage its calling configuration.

  • Write

    Update phone number conversational components

    Update the conversational components configuration, such as welcome messages and commands, for a WhatsApp phone number.

  • Write

    Update phone number business profile

    Update the WhatsApp business profile associated with a phone number.

  • Write

    Upload Whatsapp profile photo

    Upload a new profile photo for a WhatsApp phone number.

  • Write

    Resend verification code

    Resend the verification code for a phone number that is being registered with WhatsApp.

  • Write

    Submit verification code for a phone number

    Submit the verification code to complete WhatsApp registration of a phone number.

  • Write

    Update Connection ID for a WhatsApp Calling BYON number

    Set or clear the connection ID for a WhatsApp Calling BYON (Bring Your Own Number) phone number: the connection that inbound WhatsApp calls to the number are delivered to. The update is processed asynchronously.

  • Destructive

    Delete a Whatsapp phone number

    Delete a phone number's WhatsApp registration from your account.

  • Destructive

    Delete Whatsapp profile photo

    Delete the profile photo of a WhatsApp phone number.

Phone Number Configurations

  • Read

    Slim List phone numbers

    List phone numbers, This endpoint is a lighter version of the /phonenumbers endpoint having higher performance and rate limit.

  • Read

    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 reference, and voice usage payment method.

  • Read

    Retrieve a phone number

    Returns the detailed configuration and current state of the phone number identified by id.

  • Read

    Retrieve a phone number with voice settings

    Returns the specified phone number together with its current voice configuration.

  • Write

    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.

  • Write

    Update a phone number

    Updates the configurable settings of the specified phone number. The response contains the complete updated phone-number representation.

  • Write

    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 its updated bundle state.

  • Write

    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 or an accepted state when processing continues asynchronously.

  • Write

    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.

  • Destructive

    Delete a phone number

    Deletes the specified phone number from the account. The response contains the phone number's final deleted representation.

CSV Downloads

  • Read

    List CSV downloads

    Returns CSV export jobs created for account phone numbers, including each export's current status and pagination metadata.

  • Read

    Retrieve a CSV download

    Returns the current status and download details for the CSV export identified by id.

  • Write

    Create a CSV download

    Starts generation of a CSV export for phone numbers matching the supplied filters. The csvformat parameter selects the output format, and the response contains the resulting download record.

Bulk Phone Number Operations

  • Read

    Lists the phone numbers jobs

    Returns background jobs that operate on phone numbers. Filter by job type, target phone numbers, job status, or creation-time customer reference, and sort by creation time.

  • Read

    Retrieve a phone numbers job

    Returns the status and details of the phone-number background job identified by id.

  • Write

    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.

  • Write

    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 be submitted.

  • Destructive

    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.

Regulatory Requirements

  • Read

    Retrieve regulatory requirements for a list of phone numbers

    Returns the regulatory requirements that apply to the supplied comma-separated phone numbers. The response includes the matching requirement records and pagination metadata.

  • Read

    Retrieve regulatory requirements

    Returns regulatory requirements for number ordering, porting, or other supported actions. Results can be filtered by phone number, requirement group, country, number type, and action.

Voicemail

  • Read

    Get voicemail

    Returns the voicemail settings for a phone number

  • Write

    Create voicemail

    Create voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode customgreeting together with a medianame that points to an audio file uploaded through the Media Storage API, or mode default to use the standard syste…

  • Write

    Update voicemail

    Update voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode customgreeting together with a medianame that points to an audio file uploaded through the Media Storage API, or mode default to use the standard syste…

Phone Number Porting

  • Write

    Run a portability check

    Runs a portability check, returning the results immediately.

Porting Orders

  • Read

    List all porting events

    Returns a paginated list of porting-related events on your account, such as status changes on porting orders. Supports filtering and is useful for auditing or reconciling webhook deliveries.

  • Read

    Show a porting event

    Returns the details of a single porting event, including its type and payload.

  • Read

    List LOA configurations

    Returns a paginated list of your LOA (Letter of Authorization) configurations. LOA configurations customize the company details and branding used on generated LOA documents.

  • Read

    Preview the LOA configuration parameters

    Preview the LOA template that would be generated without need to create LOA configuration.

  • Read

    Retrieve a LOA configuration

    Returns the details of a single LOA (Letter of Authorization) configuration by its identifier.

  • Read

    Preview a LOA configuration

    Renders a preview of the LOA document produced by this configuration so you can verify company details and branding before using it on porting orders.

  • Read

    List porting related reports

    List the reports generated about porting operations.

  • Read

    Retrieve a report

    Returns the details of a previously requested porting report, including its status and parameters.

  • Read

    List available carriers in the UK

    Returns the list of UK carriers available for porting, for use when preparing porting orders for UK numbers.

  • Read

    List all porting orders

    Returns a paginated list of your porting orders. Supports filtering and sorting, and can optionally include the phone numbers attached to each order.

  • Read

    List all exception types

    Returns a list of all possible exception types for a porting order.

  • Read

    List all phone number configurations

    Returns a list of phone number configurations paginated.

  • Read

    Retrieve a porting order

    Retrieves the details of an existing porting order.

  • Read

    List all porting activation jobs

    Returns a list of your porting activation jobs.

  • Read

    Retrieve a porting activation job

    Returns the details of a single activation job for the porting order, including its current status.

  • Read

    List additional documents

    Returns a list of additional documents for a porting order.

  • Read

    List allowed FOC dates

    Returns a list of allowed FOC dates for a porting order.

  • Read

    List all comments of a porting order

    Returns a list of all comments of a porting order.

  • Read

    Download a porting order loa template

    Downloads the Letter of Authorization (LOA) template document for this porting order, optionally rendered with a specific LOA configuration.

  • Read

    List porting order requirements

    Returns a list of all requirements based on country/number type for this porting order.

  • Read

    Retrieve the associated V1 subrequestid and portrequestid

    Retrieve the associated V1 subrequestid and portrequestid

  • Read

    List verification codes

    Returns a list of verification codes for a porting order.

  • Read

    List action requirements for a porting order

    Returns a list of action requirements for a specific porting order.

  • Read

    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 should be kept or disconnected.

  • Read

    List all phone number blocks

    Returns a list of all phone number blocks of a porting order.

  • Read

    List all phone number extensions

    Returns a list of all phone number extensions of a porting order.

  • Read

    List all porting phone numbers

    Returns a list of your porting phone numbers.

  • Write

    Republish a porting event

    Republishes the specified porting event, triggering re-delivery of the corresponding webhook to your account.

  • Write

    Create a LOA configuration

    Creates a new LOA configuration with your company details and branding for use when generating LOA documents for porting orders.

  • Write

    Update a LOA configuration

    Updates the specified LOA configuration with the provided fields and returns the updated configuration.

  • Write

    Create a porting related report

    Generate reports about porting operations.

  • Write

    Create a porting order

    Creates a new porting order to bring phone numbers from another carrier to Telnyx. Complete the order's requirements and then confirm it to submit the port.

  • Write

    Create a list of phone number configurations

    Creates a list of phone number configurations.

  • Write

    Edit a porting order

    Edits the details of an existing porting order. Any or all of a porting orders attributes may be included in the resource object included in a PATCH request.

  • Write

    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.

  • Write

    Submit a porting order.

    Confirms the porting order and submits it for processing. Make sure all required information and documents are attached before confirming.

  • Write

    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.

  • Write

    Update a porting activation job

    Updates the activation time of a porting activation job.

  • Write

    Create a list of additional documents

    Creates a list of additional documents for a porting order.

  • Write

    Create a comment for a porting order

    Creates a new comment for a porting order.

  • Write

    Send the verification codes

    Send the verification code for all porting phone numbers.

  • Write

    Verify the verification code for a list of phone numbers

    Verifies the verification code for a list of phone numbers.

  • Write

    Initiate an action requirement

    Initiates a specific action requirement for a porting order.

  • Write

    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.

  • Write

    Create a phone number block

    Creates a phone number block on the porting order, representing a contiguous range of phone numbers to be ported together.

  • Write

    Create a phone number extension

    Creates a phone number extension on the porting order, mapping extension ranges to one of the order's phone numbers.

  • Destructive

    Delete a LOA configuration

    Permanently deletes the specified LOA configuration so it can no longer be used when generating LOA documents.

  • Destructive

    Delete a porting order

    Deletes an existing porting order. This operation is restrict to porting orders in draft state.

  • Destructive

    Cancel a porting order

    Requests cancellation of the porting order and returns the updated order.

  • Destructive

    Delete an additional document

    Deletes an additional document for a porting order.

  • Destructive

    Delete an associated phone number

    Deletes an associated phone number from a porting order.

  • Destructive

    Delete a phone number block

    Deletes the specified phone number block from the porting order.

  • Destructive

    Delete a phone number extension

    Deletes the specified phone number extension from the porting order.

Number Portout

  • Read

    List portout requests

    Returns the portout requests according to filters

  • Read

    List all port-out events

    Returns a paginated list of port-out events on your account, such as status changes on port-out requests, with support for filtering.

  • Read

    Show a port-out event

    Returns the details of a single port-out event, including its type and payload.

  • Read

    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

  • Read

    List port-out related reports

    List the reports generated about port-out operations.

  • Read

    Retrieve a report

    Returns the details of a previously requested port-out report, including its status and parameters.

  • Read

    Get a portout request

    Returns the portout request based on the ID provided

  • Read

    List all comments for a portout request

    Returns a list of comments for a portout request.

  • Read

    List supporting documents on a portout request

    List every supporting documents for a portout request.

  • Write

    Republish a port-out event

    Republishes the specified port-out event, triggering re-delivery of the corresponding webhook to your account.

  • Write

    Create a port-out related report

    Generate reports about port-out operations.

  • Write

    Create a comment on a portout request

    Creates a comment on the specified port-out request and returns the created comment.

  • Write

    Create a list of supporting documents on a portout request

    Creates a list of supporting documents on a portout request.

  • Write

    Update Status

    Updates the status of the specified port-out request, using the status path segment to authorize or reject the port-out.

Pricing

  • Read

    List products

    Returns the full product catalog with pagination. Each entry contains a slug, display name, and description. Use the slug to fetch per-product pricing via GET /pricing/products/{slug}.

  • Read

    Get product pricing

    Returns pricing entries for a single product. Most products return standard rate entries with fields like rate, unit, countryiso, direction, and tiers. Inference products return model-specific fields (model, inputrate, outputrate, cachedinputrate) with tiered pricing.

Private Wireless Gateways

  • Read

    Get all Private Wireless Gateways

    Get all Private Wireless Gateways belonging to the user.

  • Read

    Get a Private Wireless Gateway

    Retrieve information about a Private Wireless Gateway.

  • Write

    Create a Private Wireless Gateway

    Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. This operation may take several minutes so you can check the Private Wireless Gateway status at the section Get a Private Wireless Gateway.

  • Destructive

    Delete a Private Wireless Gateway

    Permanently deletes the specified Private Wireless Gateway from your account.

Pronunciation Dictionaries

  • Read

    List pronunciation dictionaries

    List all pronunciation dictionaries for the authenticated organization. Results are paginated using offset-based pagination.

  • Read

    Get a pronunciation dictionary

    Retrieve a single pronunciation dictionary by ID.

  • Write

    Create a pronunciation dictionary

    Create a new pronunciation dictionary for the authenticated organization. Each dictionary contains a list of items that control how specific words are spoken. Items can be alias type (text replacement) or phoneme type (IPA pronunciation notation).

  • Write

    Update a pronunciation dictionary

    Update the name and/or items of an existing pronunciation dictionary. Uses optimistic locking — if the dictionary was modified concurrently, the request returns 409 Conflict.

  • Destructive

    Delete a pronunciation dictionary

    Permanently delete a pronunciation dictionary.

Public Internet Gateways

  • Read

    List all Public Internet Gateways

    Returns a paginated list of the public internet gateways on your account, with support for filtering.

  • Read

    Retrieve a Public Internet Gateway

    Returns the details of a single public internet gateway by its identifier.

  • Write

    Create a Public Internet Gateway

    Requests creation of a public internet gateway on the specified network, giving the network internet egress. Creation is asynchronous, so the request is accepted and completes in the background.

  • Destructive

    Delete a Public Internet Gateway

    Deletes the specified public internet gateway, removing internet egress through it.

Queue Commands

  • Read

    List queues

    List all queues for the authenticated user.

  • Read

    Retrieve a call queue

    Returns the details of an existing call queue, including its current configuration.

  • Read

    Retrieve calls from a queue

    Retrieve the list of calls in an existing queue

  • Read

    Retrieve a call from a queue

    Retrieve an existing call from an existing queue

  • Write

    Create a queue

    Creates a new call queue with the provided configuration and returns the created queue.

  • Write

    Update a queue

    Update properties of an existing call queue.

  • Write

    Update queued call

    Update queued call's keepafterhangup flag

  • Destructive

    Delete a queue

    Permanently deletes the specified call queue from your account.

  • Destructive

    Force remove a call from a queue

    Removes an inactive call from a queue. If the call is no longer active, use this command to remove it from the queue.

RCS Agents

  • Read

    List RCS agents

    Lists RCS agents owned by the authenticated organization, optionally filtered by brand.

  • Read

    Retrieve an RCS agent

    Retrieves an RCS agent, section statuses, test devices, carrier approvals, and provider capabilities.

  • Read

    List RCS agent carrier approvals

    Lists carrier approval records for an RCS agent. The provider may expose per-carrier, hub-level, or bot-level approval status.

  • Read

    List RCS agent test devices

    Lists test devices attached to an RCS agent.

  • Write

    Create an RCS agent

    Creates an editable RCS agent draft under a brand. The Idempotency-Key is scoped to the authenticated organization. Reusing the key with the same request returns the original agent, while reusing it with a different request returns a conflict.

  • Write

    Update an RCS agent

    Updates one or more fields on an agent while its status is CREATED. Submitted agents cannot be changed through this endpoint.

  • Write

    Submit an RCS agent for launch

    Adds the campaign and testing configuration, then starts asynchronous carrier launch. Agent basics must already be submitted. Repeating a launch that is already in progress returns the current agent without creating new work.

  • Write

    Submit RCS agent basics

    Starts asynchronous provider provisioning and submits the agent's basic configuration. The brand must be VERIFIED. Repeating this request for an in-progress agent returns its current state without creating new work.

  • Write

    Add an RCS agent test device

    Adds an RCS-capable test number after provider agent creation. Repeating the request for a number already attached to the agent returns the existing test device.

  • Destructive

    Remove an RCS agent test device

    Removes a test device from an RCS agent and its provider registration.

RCS Brands

  • Read

    List RCS brands

    Lists RCS brands owned by the authenticated organization.

  • Read

    Retrieve an RCS brand

    Retrieves an RCS brand and its current lifecycle status.

  • Write

    Create an RCS brand

    Creates an editable RCS brand draft. Creating the draft does not begin external review.

  • Write

    Update an RCS brand

    Updates one or more fields on a brand while its status is CREATED. Submitted brands cannot be changed.

  • Write

    Submit an RCS brand

    Starts asynchronous provider provisioning and external review for a brand. Repeating this request for an in-progress brand returns its current state without creating new work.

Regions

  • Read

    List all Regions

    List all regions and the interfaces that region supports

MDR Detail Reports

  • Read

    Fetch all Mdr records

    Returns message detail records (MDRs) matching the provided criteria, such as date range, direction, status, and message type.

WDR Detail Reports

  • Read

    Fetches all Wdr records

    Returns wireless detail records (WDRs) matching the provided criteria, such as date range, SIM card, IMSI, or phone number, with pagination and sorting.

Requirement Types

  • Read

    List all requirement types

    List all requirement types ordered by createdat descending

  • Read

    Retrieve a requirement types

    Returns the details of a single requirement type by its identifier, describing a kind of documentation needed for regulatory purposes.

Requirements

  • Read

    List all requirements

    List all requirements with filtering, sorting, and pagination

  • Read

    Retrieve a document requirement

    Returns a single document requirement record by its identifier, describing the documentation needed for number-related actions. A specific requirement version can be requested.

  • Write

    Schedule a future requirement version

    Create a new pending version of a requirement with a future effective start date. Only one pending version may exist per requirement at a time.

  • Destructive

    Cancel a pending requirement version

    Cancel a pending requirement version. The pending version is marked as cancelled and the previously active version is restored with effectiveendat set to NULL.

Room Compositions

  • Read

    View a list of room compositions.

    Returns a paginated list of room compositions. Filter compositions by creation date, room session, or processing status.

  • Read

    View a room composition.

    Returns the composition identified by roomcompositionid, including its room and session, processing status, media details, video layout, lifecycle timestamps, and download URL.

  • Write

    Create a room composition.

    Asynchronously create a room composition.

  • Destructive

    Delete a room composition.

    Synchronously delete a room composition.

Room Participants

  • Read

    View a list of room participants.

    Returns a paginated list of room participants across sessions. Filter participants by session, join, update, or leave date and by participant context.

  • Read

    View a room participant.

    Returns the participant identified by roomparticipantid, including its session, context, and join, update, and leave timestamps.

Room Recordings

  • Read

    View a list of room recordings.

    Returns a paginated list of room recordings. Filter recordings by room, session, participant, recording type, status, duration, or start and end dates.

  • Read

    View a room recording.

    Returns the recording identified by roomrecordingid, including its room, session, participant, status, media details, lifecycle timestamps, and download URL.

  • Destructive

    Delete several room recordings in a bulk.

    Deletes the room recordings that match the supplied filters and returns the number of recordings affected. Filters support room, session, participant, recording type, status, duration, and start or end dates.

  • Destructive

    Delete a room recording.

    Synchronously deletes the specified video room recording. The recording's media is removed permanently.

Room Sessions

  • Read

    View a list of room sessions.

    Returns a paginated list of room sessions across the account. Filter sessions by room, creation, update, or end date and active status, and use includeparticipants to include participant records.

  • Read

    View a room session.

    Returns the room session identified by roomsessionid, including its room, active status, and lifecycle timestamps. Use includeparticipants to include its participant records.

  • Read

    View a list of room participants.

    Returns a paginated list of participants for the specified room session. Filter participants by join, update, or leave date and by participant context.

  • Write

    End a room session.

    Note: this will also kick all participants currently present in the room

  • Write

    Kick participants from a room session.

    Removes the selected participants from the specified room session. Apply the action to a list of participant IDs or to all, with optional participant IDs excluded from the action.

  • Write

    Mute participants in room session.

    Mutes the selected participants in the specified room session. Apply the action to a list of participant IDs or to all, with optional participant IDs excluded from the action.

  • Write

    Unmute participants in room session.

    Unmutes the selected participants in the specified room session. Apply the action to a list of participant IDs or to all, with optional participant IDs excluded from the action.

Rooms

  • Read

    View a list of rooms.

    Returns a paginated list of rooms. Filter the results by creation or update date and unique name, and use includesessions to include each room’s sessions.

  • Read

    View a room.

    Returns the room identified by roomid, including its participant limit, recording and webhook configuration, and active session identifier. Use includesessions to include its sessions.

  • Read

    View a list of room sessions.

    Returns a paginated list of sessions for the specified room. Filter sessions by creation, update, or end date and active status, and use includeparticipants to include participant records.

  • Write

    Create a room.

    Synchronously creates a new video room with the provided configuration and returns the created room.

  • Write

    Update a room.

    Synchronously updates the specified video room's configuration and returns the updated room.

  • Destructive

    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 that room.

Rooms Client Tokens

  • Write

    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 tokenttlsecs, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after refreshtokenttlsecs.

  • Write

    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 tokenttlsecs.

Session Analysis

  • Read

    Get metadata overview

    Returns all available record types and supported query parameters for session analysis.

  • Read

    Get record type metadata

    Returns detailed metadata for a specific record type, including relationships and examples.

  • Read

    Get session analysis

    Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages.

SETI Observability

  • Read

    Retrieve Black Box Test Results

    Returns the results of the various black box tests

Short Codes

  • Read

    List short codes

    Returns short codes owned by the authenticated account. Apply the documented filters and pagination parameters to narrow the result set.

  • Read

    Retrieve a short code

    Returns the messaging configuration and assignment details for the specified short code.

  • Write

    Update short code

    Update the settings for a specific short code. To unbind a short code from a profile, set the messagingprofileid to null or an empty string. To add or update tags, include the tags field as an array of strings.

SIM Card Group Actions

  • Read

    List SIM card group actions

    This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.

  • Read

    Get SIM card group action details

    This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.

SIM Card Groups

  • Read

    Get all SIM card groups

    Get all SIM card groups belonging to the user that match the given filters.

  • Read

    Get SIM card group

    Returns the details regarding a specific SIM card group

  • Write

    Create a SIM card group

    Creates a new SIM card group and returns it. Groups let you apply shared settings to a set of SIM cards.

  • Write

    Update a SIM card group

    Updates the specified SIM card group's attributes and returns the updated group.

  • Write

    Request Private Wireless Gateway removal from SIM card group

    This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic handled by Telnyx's default mobile network configuration.

  • Write

    Request Wireless Blocklist removal from SIM card group

    This action asynchronously removes the Wireless Blocklist assigned to a SIM Card Group. The request returns 404 when the SIM Card Group does not exist and 422 when no Wireless Blocklist is assigned.

  • Write

    Request Private Wireless Gateway assignment for SIM card group

    This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway.

  • Write

    Request Wireless Blocklist assignment for SIM card group

    This action asynchronously assigns a Wireless Blocklist to all SIMs in the SIM Card Group. The request returns 404 when the SIM Card Group does not exist and 422 when the Wireless Blocklist does not exist.

  • Destructive

    Delete a SIM card group

    Permanently deletes the specified SIM card group from your account.

SIM Card Orders

  • Read

    Preview SIM card orders

    Previews a SIM card order purchase, returning estimated costs and details before you place the order. The preview is processed asynchronously.

  • Read

    Get all SIM card orders

    Get all SIM card orders according to filters.

  • Read

    Get a single SIM card order

    Returns the details of a single SIM card order by its ID, including its status.

  • Write

    Create a SIM card order

    Creates a new order for physical SIM cards, including quantity and shipping details, and returns the created order.

UAC Connections

  • Read

    SIP Registration Status

    Returns the live SIP registration status for a Telnyx endpoint: whether it is currently registered, when the current registration expires, and the last response Telnyx received from the registrar.

  • Read

    List UAC connections

    Returns a list of your UAC connections. A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite of a standard SIP trunk, where the PBX registers to Telnyx.

  • Read

    Retrieve a UAC connection

    Retrieves the details of an existing UAC connection.

  • Read

    Check a UAC Connection Registration Status

    Returns the live SIP registration status for a UAC connection. Reports whether the endpoint is currently registered (status) and the timestamp of the last SIP registration event (lastregistration).

  • Write

    Create a UAC connection

    Creates a UAC connection. A UAC (User Agent Client) Connection registers Telnyx to your PBX — the opposite of a standard SIP trunk, where the PBX registers to Telnyx. Use UAC when your PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration.

  • Write

    Update a UAC connection

    Updates settings of an existing UAC connection.

  • Destructive

    Delete a UAC connection

    Permanently deletes the specified UAC connection from your account.

SIPREC Connectors

  • Read

    Retrieve a SIPREC connector

    Returns details of a stored SIPREC connector.

  • Write

    Create a SIPREC connector

    Creates a new SIPREC connector configuration.

  • Destructive

    Update a SIPREC connector

    Updates a stored SIPREC connector configuration.

  • Destructive

    Delete a SIPREC connector

    Deletes the stored SIPREC connector with the specified connector name.

Speech To Text Capabilities

  • Read

    List supported STT providers

    Retrieve the canonical list of supported speech-to-text providers, models, accepted language codes, and the service types each model supports. Service types: streaming — standalone WebSocket transcription via /speech-to-text/transcription.

Speech To Text over Web Sockets

  • Read

    Speech to text over WebSocket

    Open a WebSocket connection to stream audio and receive transcriptions in real-time. Authentication is provided via the standard Authorization: Bearer header. Supported engines: Azure, Deepgram, Google, Telnyx, xAI, Speechmatics, Soniox, Parakeet, Humain, Reson8, Cohere.

Spend Limits

  • Read

    List spend limits

    Returns one entry per product and period you can set a limit on, with the limit, the spend so far in the period and whether the product is blocked. An entry without a limit is still listed (limit: null).

  • Write

    Create a spend limit

    Sets a limit for a product and period that has none. Send exactly one of amount and unlimited: true. The period's spend is checked at once: if it is already above the new limit, the product is blocked immediately (evaluation.blockednow).

  • Write

    Update a spend limit

    Replaces the value of the existing limit for the product and period. Send exactly one of amount and unlimited: true.

  • Destructive

    Delete a spend limit

    Removes the limit for the product and period. For inference, which has no default limit, the product becomes unlimited for the period and the period's block is lifted (evaluation.released). The response carries limit: null and the effectivelimitusd that applies after the removal.

Bucket SSL Certificate

  • Read

    Get Bucket SSL Certificate

    Returns the stored certificate detail of a bucket, if applicable.

  • Destructive

    Add SSL Certificate

    Uploads an SSL certificate and its matching secret so that you can use Telnyx's storage as your CDN.

  • Destructive

    Remove SSL Certificate

    Deletes an SSL certificate and its matching secret.

Bucket Usage

  • Read

    Get API Usage

    Returns the detail on API usage on a bucket of a particular time period, group by method category.

  • Read

    Get Bucket Usage

    Returns the amount of storage space and number of files a bucket takes up.

Presigned Object URLs

  • Write

    Create Presigned Object URL

    Returns a timed and authenticated URL to download (GET) or upload (PUT) an object. This is the equivalent to AWS S3’s “presigned” URL.

Cloudfs filesystems

  • Read

    List CloudFS filesystems

    Lists the CloudFS filesystems for the authenticated user's organization. Results use cursor-based pagination: fetch the next page by passing meta.cursors.after as page[after], or follow the meta.next URL.

  • Read

    Get a CloudFS filesystem

    Retrieves a CloudFS filesystem by its ID. The returned metaurl omits the credential — the metadata token is only ever returned by create and rotate-meta-token. A filesystem whose last lifecycle action failed includes a customer-safe error message.

  • Write

    Create a CloudFS filesystem

    Creates a CloudFS filesystem. Provisioning is synchronous — typically a few seconds, up to a few minutes — and the filesystem is returned with status ready, together with its S3 bucket and metadata connection details.

  • Write

    Update a CloudFS filesystem

    Updates a CloudFS filesystem. Only name can be changed; other fields are immutable and unknown fields are rejected with a 400. Renaming to a name that already exists in your organization returns a 422.

  • Write

    Rotate the metadata token

    Issues a new metadata access token for the filesystem and returns the full filesystem, including the new metatoken and credential-bearing metaurl. The previous token stops authenticating immediately; the metadata database and S3 bucket are unchanged. The request takes no body.

  • Destructive

    Delete a CloudFS filesystem

    Permanently deletes a CloudFS filesystem, removing its S3 bucket and its metadata database. Deletion is synchronous: the response returns the filesystem's final state with status deleted. There is no restore. A filesystem that is still provisioning returns a 409.

Kv namespaces

  • Read

    List KV namespaces

    Lists the KV namespaces for the authenticated user's organization. Results use page-based pagination (page[number]/page[size]).

  • Read

    Get a KV namespace

    Retrieves a KV namespace by its ID, including its provisioning status.

  • Write

    Create a KV namespace

    Creates a new KV namespace. Provisioning is asynchronous: the namespace is returned with status pending and becomes usable once it reaches provisionok.

  • Destructive

    Delete a KV namespace

    Deletes a KV namespace and all of the keys it contains. Deletion is asynchronous: the namespace is returned with status deleting. Deleting a namespace whose deletion is already in progress returns a 409.

Kv keys

  • Read

    List keys

    Lists the keys in a namespace. Returns key names and metadata only, never values. Results are paginated with limit and an opaque cursor.

  • Read

    Get a key's value

    Returns the raw stored value for a key. The response body is the value exactly as it was written; the Content-Type header echoes the value's stored content type (defaults to application/octet-stream).

  • Destructive

    Set a key's value

    Creates or replaces the value for a key. The request body is stored verbatim as the value — no base64, no JSON envelope — up to 1 MiB. The request's Content-Type header is stored with the value and echoed back on retrieval.

  • Destructive

    Delete a key

    Deletes a key. Idempotent: deleting a key that does not exist still succeeds. The namespace itself must exist and be provisioned.

Data Migration

  • Read

    List Migration Source coverage

    List the external storage providers and regions supported as migration sources.

  • Read

    List all Migration Sources

    List the migration sources configured on your account. A migration source is an external storage bucket from which data can be migrated into Telnyx Cloud Storage.

  • Read

    Get a Migration Source

    Retrieve the details of a specific migration source.

  • Read

    List all Migrations

    Retrieve a list of the storage migrations on your account.

  • Read

    Get a Migration

    Retrieve the details and status of a specific storage migration.

  • Write

    Create a Migration Source

    Create a source from which data can be migrated from.

  • Write

    Create a Migration

    Initiate a migration of data from an external provider into Telnyx Cloud Storage. Currently, only S3 is supported.

  • Write

    Stop a Migration

    Stops the specified in-progress storage migration and returns the updated migration.

  • Destructive

    Delete a Migration Source

    Delete a migration source configuration.

Sql databases

  • Read

    List SQL databases

    Lists the SQL databases for the authenticated user's organization. Results use page-based pagination (page[number]/page[size]) and can be filtered and sorted.

  • Read

    Get a SQL database

    Retrieves a SQL database by its ID, including its provisioning status.

  • Write

    Create a SQL database

    Creates a new SQL database. Provisioning is asynchronous: the database is returned with status pending and becomes usable once it reaches provisionok.

  • Write

    Run SQL against a SQL database

    Runs SQL against the database and returns the resulting rows — empty for statements that return none, such as DDL. Bind positional ? placeholders with params rather than interpolating values into the SQL string.

  • Destructive

    Delete a SQL database

    Deletes a SQL database and all of the data it holds. Deletion is asynchronous and returns 202 with an empty body — the record is not removed synchronously. Poll GET /storage/sqldbs/{id}, which returns 404 once the database has been purged; there is no durable deleted state.

Tailscale Subnet Routers

  • Read

    List all Tailscale Subnet Routers

    Returns a paginated list of the Tailscale Subnet Routers on the account, with support for filtering by Network.

  • Read

    Retrieve a Tailscale Subnet Router

    Returns the details of a single Tailscale Subnet Router by its identifier, including its enrollment state.

  • Write

    Create a Tailscale Subnet Router

    Creates a Tailscale Subnet Router on a Network and enrolls it in the user's tailnet with the auth key. The response returns the router with status provisioning. Poll GET /tailscalesubnetrouters/{id} until it is provisioned.

  • Write

    Update a Tailscale Subnet Router

    Renames the router, changes its advertised routes, or retries a failed enrollment. Any change queues a new provisioning run and returns the router with status provisioning. The router keeps its machine identity on the tailnet.

  • Destructive

    Delete a Tailscale Subnet Router

    Removes the router from the Network and logs it out of the tailnet. The response returns the router with status deleting. The record disappears once removal completes. A machine entry can remain in the tailnet's admin console until it is removed there.

Credentials

  • Read

    List all credentials

    Returns a paginated list of the on-demand telephony credentials on your account, with support for filtering.

  • Read

    Get a credential

    Get the details of an existing On-demand Credential.

  • Write

    Create a credential

    Creates a new on-demand telephony credential for the specified connection. The credential can then be used to generate access tokens for SIP or WebRTC clients.

  • Write

    Update a credential

    Updates the specified telephony credential and returns the updated credential.

  • Destructive

    Delete a credential

    Permanently deletes the specified telephony credential, revoking any access it provided.

Access Tokens

  • Write

    Create an Access Token.

    Create an Access Token (JWT) for the credential.

Terms of Service

  • Read

    List the calling user's Terms of Service agreements

    Returns the Terms of Service agreements the authenticated user has on file. Each entry records the version agreed to and when. Most users only have one agreement per product, but if the ToS is updated and the user re-agrees a new entry is added.

  • Read

    Get a Terms of Service agreement by id

    Retrieve a single ToS agreement record. Returns 404 if the agreement does not exist or does not belong to the authenticated user.

  • Read

    Get Terms of Service information

    Returns the available Terms of Service agreements (product, current version, terms URL, effective date). Omit producttype to return all products; pass it to scope to one.

  • Read

    Get the calling user's Terms of Service status

    Returns whether the authenticated user has agreed to the current Terms of Service for the product given by producttype. Used during onboarding to decide whether to prompt the user with the ToS dialog before continuing.

  • Write

    Agree to the Branded Calling Terms of Service

    Records the authenticated user's agreement to the current Branded Calling ToS. No body required. Idempotent - re-calling after agreement is a no-op and returns the existing agreement.

  • Write

    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. Prerequisite for using any of the /v2/.../reputation/ endpoints.

Te XML REST Commands

  • Read

    Fetch multiple call resources

    Returns multiple call resouces for an account. This endpoint is eventually consistent.

  • Read

    Fetch a call

    Returns an individual call identified by its CallSid. This endpoint is eventually consistent.

  • Read

    Fetch recordings for a call

    Returns recordings for a call identified by callsid.

  • Read

    List conference resources

    Returns a paginated list of conference resources for the account, with support for filtering by friendly name, status, and creation or update dates.

  • Read

    Fetch a conference resource

    Returns a single conference resource for the account by its ConferenceSid.

  • Read

    List conference participants

    Returns the list of participants currently in the specified conference.

  • Read

    Get conference participant resource

    Returns a single conference participant resource by call SID or participant label.

  • Read

    List conference recordings

    Returns the list of recordings made for the specified conference.

  • Read

    Fetch recordings for a conference

    Returns recordings for a conference identified by conferencesid.

  • Read

    List queue resources

    Returns a paginated list of queue resources for the account, with support for filtering by creation or update dates.

  • Read

    Fetch a queue resource

    Returns a single queue resource for the account by its QueueSid.

  • Read

    Fetch multiple recording resources

    Returns multiple recording resources for an account.

  • Read

    Fetch recording resource

    Returns recording resource identified by recording id.

  • Read

    List recording transcriptions

    Returns multiple recording transcription resources for an account.

  • Read

    Fetch a recording transcription resource

    Returns the recording transcription resource identified by its ID.

  • Write

    Initiate an outbound call

    Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the TeXML Application in the Mission Control Portal.

  • Write

    Update call

    Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.

  • Write

    Request recording for a call

    Starts recording with specified parameters for call idientified by callsid.

  • Write

    Update recording on a call

    Updates recording resource for particular call.

  • Write

    Request siprec session for a call

    Starts siprec session with specified parameters for call idientified by callsid.

  • Write

    Updates siprec session for a call

    Updates siprec session identified by siprecsid.

  • Write

    Start streaming media from a call.

    Starts streaming media from a call to a specific WebSocket address.

  • Write

    Update streaming on a call

    Updates streaming resource for particular call.

  • Write

    Update a conference resource

    Updates the specified conference resource, for example to modify its status, and returns the updated conference.

  • Write

    Dial a new conference participant

    Dials a new participant into the specified conference and returns the created participant resource.

  • Write

    Update a conference participant

    Updates the specified conference participant, for example muting or holding them, and returns the updated participant.

  • Write

    Create a new queue

    Creates a new queue resource for the account with the provided settings and returns it.

  • Write

    Update a queue resource

    Updates the specified queue resource's settings and returns the updated queue.

  • Write

    Initiate an outbound AI call

    Initiate an outbound AI call with warm-up support: Telnyx attempts to warm up the assistant identified by AIAssistantId before placing the call and starts it automatically when the called party answers.

  • Write

    Create a connection-scoped TeXML call

    Initiate an outbound TeXML call using a TeXML application connection ID, not an account SID. Request parameter names are case-sensitive. From and To are required; Texml supplies inline instructions and Url overrides the application XML request URL.

  • Write

    Create a TeXML secret

    Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to use your secret name, and this name will be replaced by the actual secret value when processing the TeXML on Telnyx side.

  • Destructive

    Delete a conference participant

    Removes the specified participant from the conference, ending their leg of the call.

  • Destructive

    Delete a queue resource

    Permanently deletes the specified queue resource from the account.

  • Destructive

    Delete recording resource

    Deletes recording resource identified by recording id.

  • Destructive

    Delete a recording transcription

    Permanently deletes a recording transcription.

Te XML Applications

  • Read

    List all TeXML Applications

    Returns a list of your TeXML Applications.

  • Read

    Retrieve a TeXML Application

    Retrieves the details of an existing TeXML Application.

  • Write

    Creates a TeXML Application

    Creates a TeXML application, which defines the voice URLs and settings used to serve TeXML instructions for calls, and returns the created application.

  • Write

    Update a TeXML Application

    Updates settings of an existing TeXML Application.

  • Destructive

    Deletes a TeXML Application

    Permanently deletes the specified TeXML application from your account.

Text To Speech Commands

  • Read

    Stream text to speech over WebSocket

    Open a WebSocket connection to stream text and receive synthesized audio in real time. Authentication is provided via the standard Authorization: Bearer header. Send JSON frames with text to synthesize; receive JSON frames containing base64-encoded audio chunks.

  • Read

    List available voices

    Retrieve a list of available voices from one or all TTS providers. When provider is specified, returns voices for that provider only. Otherwise, returns voices from all providers. Some providers (ElevenLabs) require an API key to list voices.

  • Write

    Generate speech from text

    Generate synthesized speech audio from text input. Returns audio in the requested format (binary audio stream, base64-encoded JSON, or an audio URL for later retrieval). Authentication is provided via the standard Authorization: Bearer header.

Traffic Policy Profiles

  • Read

    Get all traffic policy profiles

    Get all traffic policy profiles belonging to the user that match the given filters.

  • Read

    Get all available traffic policy profile services

    Get all available PCEF services that can be used in traffic policy profiles.

  • Read

    Get a traffic policy profile

    Returns the details regarding a specific traffic policy profile.

  • Write

    Create a traffic policy profile

    Create a new traffic policy profile. At least one of services, ipranges, or domains must be provided.

  • Write

    Update a traffic policy profile

    Updates the specified traffic policy profile and returns the updated profile.

  • Destructive

    Delete a traffic policy profile

    Permanently deletes the specified traffic policy profile from your account.

Tunnels

  • Read

    List all Tunnels

    Lists the tunnels on the account with their status and connected tunnel processes. Responses never include tunneltoken.

  • Read

    Retrieve a Tunnel

    Retrieves a tunnel with its status and the tunnel processes connected to it. The response never includes tunneltoken.

  • Write

    Create a Tunnel

    Creates a tunnel and returns its tunneltoken. The token is the only credential the tunnel process needs, and this response and POST /tunnels/{id}/actions/rotatetoken are the only ones that return it. A new tunnel is inactive until a tunnel process connects with the token.

  • Write

    Rotate a Tunnel Token

    Issues a new tunneltoken and invalidates the previous one. Tunnel processes already connected stay connected until they reconnect, and are then refused until they use the new token.

  • Destructive

    Delete a Tunnel

    Deletes a tunnel. A tunnel that a route names as its next hop cannot be deleted; delete those routes first. Connected tunnel processes are disconnected and cannot reconnect with the tunnel's token.

Usage Reports (BETA)

  • Read

    Get Telnyx product usage data (BETA)

    Get Telnyx usage data by product, broken out by the specified dimensions

  • Read

    Get Usage Reports query options (BETA)

    Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions

User Addresses

  • Read

    List all user addresses

    Returns a paginated list of your user addresses, with support for filtering and sorting.

  • Read

    Retrieve a user address

    Retrieves the details of an existing user address.

  • Write

    Creates a user address

    Creates a new user address from the provided details and returns the created address.

User Tags

  • Read

    List User Tags

    Returns the user tags defined on your account, with support for filtering. Tags help organize resources such as phone numbers.

Bot Signup

  • Read

    Exchange a magic link token for a session

    Consumes the one-time portal redirect (magic link) token emailed during bot signup and returns an API session. The token is a UUIDv7 that encodes its creation time; it expires after a configurable validity window (15 minutes by default) and is cleared on first use.

  • Write

    Issue a bot challenge

    Generates a reverse-CAPTCHA challenge used to gate the bot signup flow.

  • Write

    Register via bot signup

    Creates a freemium Telnyx account through the agentic signup flow.

Mobile Phone Numbers

  • Read

    List Mobile Phone Numbers

    Retrieve a paginated list of mobile phone numbers on your account.

  • Read

    Retrieve a Mobile Phone Number

    Retrieve the details of a specific mobile phone number.

  • Write

    Update a Mobile Phone Number

    Update the settings of a specific mobile phone number.

Mobile Voice Connections

  • Read

    List Mobile Voice Connections

    Retrieve a paginated list of mobile voice connections on your account.

  • Read

    Retrieve a Mobile Voice Connection

    Retrieve the details of a specific mobile voice connection.

  • Write

    Create a Mobile Voice Connection

    Creates a new mobile voice connection with the provided configuration and returns the created connection.

  • Write

    Update a Mobile Voice Connection

    Update the settings of a specific mobile voice connection.

  • Destructive

    Delete a Mobile Voice Connection

    Delete a mobile voice connection from your account.

Stored Payment Transactions

  • Write

    Create a stored payment transaction

    Create a transaction that charges a stored payment method on the account.

Whatsapp Business Accounts

  • Read

    List Whatsapp Business Accounts

    Retrieve a list of the WhatsApp Business Accounts (WABAs) connected to your Telnyx account.

  • Read

    Get a single Whatsapp Business Account

    Retrieve the details of a specific WhatsApp Business Account.

  • Read

    List phone numbers for a WABA

    List the phone numbers associated with a WhatsApp Business Account.

  • Read

    Get WABA settings

    Retrieve the settings of a WhatsApp Business Account.

  • Read

    Fetch Whatsapp user data

    Returns the WhatsApp user-data settings associated with the authenticated Telnyx account.

  • Write

    Update WABA settings

    Update the settings of a WhatsApp Business Account.

  • Write

    Update Whatsapp user data

    Updates the supplied WhatsApp user-data settings for the authenticated Telnyx account.

  • Destructive

    Delete a Whatsapp Business Account

    Delete a WhatsApp Business Account connection from your Telnyx account.

Whatsapp Message Templates

  • Read

    List Whatsapp message templates

    Retrieve the WhatsApp message templates for your WhatsApp Business Accounts.

  • Read

    Get a Whatsapp message template by ID

    Retrieve a specific WhatsApp message template by its ID.

  • Write

    Create a Whatsapp message template

    Create a new WhatsApp message template. Templates must be approved by WhatsApp before they can be used in messages.

  • Write

    Update a Whatsapp message template

    Update an existing WhatsApp message template.

  • Destructive

    Delete a Whatsapp message template

    Permanently deletes the specified WhatsApp message template from your account.

Verify

  • Read

    List verifications by phone number

    Returns a paginated list of verifications associated with the specified phone number.

  • Read

    Retrieve verification

    Returns the verification identified by ID, including its channel, phone number, Verify profile, timeout, and current status.

  • Read

    List all Verify profiles

    Gets a paginated list of Verify profiles.

  • Read

    Retrieve Verify profile message templates

    List all Verify profile message templates.

  • Read

    Retrieve Verify profile

    Returns the details of a single Verify profile by its ID, including its verification channel configuration.

  • Write

    Verify verification code by phone number

    Submits a verification code for the specified phone number and Verify profile. The response indicates whether the code was accepted or rejected.

  • Write

    Trigger Call verification

    Starts a verification for the specified phone number and delivers its code in a voice call using the selected Verify profile. Returns the pending verification record.

  • Write

    Trigger Flash call verification

    Starts a verification for the specified phone number and places a brief call with the code embedded in the caller ID. Returns the pending verification record.

  • Write

    Trigger SMS verification

    Starts a verification for the specified phone number and sends its code by SMS using the selected Verify profile. Returns the pending verification record.

  • Write

    Trigger WhatsApp verification

    Starts a verification for the specified phone number and sends its code over WhatsApp using the selected Verify profile. Returns the pending verification record.

  • Write

    Verify verification code by ID

    Checks the supplied code, or the supplied status for a custom-code verification, against the verification identified by ID. The response indicates whether the verification was accepted or rejected.

  • Write

    Create a Verify profile

    Creates a new Verify profile to associate verifications with.

  • Write

    Create message template

    Create a new Verify profile message template.

  • Write

    Update message template

    Update an existing Verify profile message template.

  • Write

    Update Verify profile

    Updates the specified Verify profile's name, webhook destinations, language, daily spend limits, or channel-specific settings. Returns the updated profile.

  • Destructive

    Delete Verify profile

    Deletes the specified Verify profile and returns the deleted profile record.

Verified Numbers

  • Read

    List all Verified Numbers

    Gets a paginated list of Verified Numbers.

  • Read

    Retrieve a verified number

    Retrieve the details of a verified number on your account.

  • Write

    Request phone number verification

    Initiates phone number verification procedure. Supports DTMF extension dialing for voice calls to numbers behind IVR systems.

  • Write

    Submit verification code

    Submit the verification code received via the selected verification method to verify a phone number.

  • Destructive

    Delete a verified number

    Remove a verified number from your account.

Virtual Cross Connects

  • Read

    List all Virtual Cross Connects

    Returns a paginated list of the virtual cross connects on your account, with support for filtering.

  • Read

    List Virtual Cross Connect Cloud Coverage

    List Virtual Cross Connects Cloud Coverage. This endpoint shows which cloud regions are available for the locationcode your Virtual Cross Connect will be provisioned in.

  • Read

    Retrieve a Virtual Cross Connect

    Returns the details of a single virtual cross connect by its identifier.

  • Write

    Create a Virtual Cross Connect

    Create a new Virtual Cross Connect. For AWS and GCE, you have the option of creating the primary connection first and the secondary connection later. You also have the option of disabling the primary and/or secondary connections at any time and later re-enabling them.

  • Write

    Update the Virtual Cross Connect

    Update the Virtual Cross Connect. Cloud IPs can only be patched during the created state, as GCE will only inform you of your generated IP once the pending connection requested has been accepted.

  • Destructive

    Delete a Virtual Cross Connect

    Deletes the specified virtual cross connect from your account.

Voice Clones

  • Read

    List voice clones

    Returns a paginated list of voice clones belonging to the authenticated account.

  • Read

    Download voice clone audio sample

    Downloads the WAV audio sample that was used to create the voice clone.

  • Write

    Create a voice clone from a voice design

    Creates a new voice clone by capturing the voice identity of an existing voice design. The clone can then be used for text-to-speech synthesis.

  • Write

    Create a voice clone from an audio file upload

    Creates a new voice clone by uploading an audio file directly. Supported formats: WAV, MP3, FLAC, OGG, M4A. Maximum file size: 20MB.

  • Write

    Update a voice clone

    Updates the name, language, or gender of a voice clone.

  • Destructive

    Delete a voice clone

    Permanently deletes a voice clone. This action cannot be undone.

Voice Designs

  • Read

    List voice designs

    Returns a paginated list of voice designs belonging to the authenticated account.

  • Read

    Get a voice design

    Returns the latest version of a voice design, or a specific version when ?version=N is provided. The id parameter accepts either a UUID or the design name.

  • Read

    Download voice design audio sample

    Downloads the WAV audio sample for the voice design. Returns the latest version's sample by default, or a specific version when ?version=N is provided. The id parameter accepts either a UUID or the design name.

  • Write

    Create or add a version to a voice design

    Creates a new voice design (version 1) when voicedesignid is omitted. When voicedesignid is provided, adds a new version to the existing design instead. A design can have at most 50 versions.

  • Write

    Rename a voice design

    Updates the name of a voice design. All versions retain their other properties.

  • Destructive

    Delete a voice design

    Permanently deletes a voice design and all of its versions. This action cannot be undone.

  • Destructive

    Delete a specific version of a voice design

    Permanently deletes a specific version of a voice design. The version number must be a positive integer.

Voice SDK Stats

  • Read

    List Voice SDK call reports

    Returns paginated raw call report stats JSON payloads stored for the authenticated user. The user is derived from Telnyx authentication, not from request parameters.

  • Read

    Retrieve Voice SDK call reports by call ID

    Returns raw call report stats JSON payloads stored for the authenticated user and callid. The user is derived from Telnyx authentication, not from request parameters.

Web Search

  • Write

    Web search

    Performs a real-time web search and returns structured, LLM-ready JSON results with titles, URLs, descriptions, and snippets. Supports filtering by domain, country, safe search, freshness, and live crawl. Note: includedomains and excludedomains cannot be used in the same request.

Contents

  • Read

    Retrieve page contents

    Retrieves clean HTML or Markdown content from a list of URLs. Supports up to 20 URLs per request (public API limit). Specify which formats to return: html, markdown, metadata.

Research

  • Read

    Get research task status

    Polls the status of a previously started asynchronous research task. When the status is completed, the response includes the answer and citations. When the status is failed, the response includes an error message.

  • Write

    Start research task

    Starts a deep research task that runs multiple searches, reads sources, and synthesizes an answer with citations. Synchronous mode (default) When background is false or omitted, the request blocks until the research completes and returns the answer with citations.

Webhooks

  • Read

    List webhook deliveries

    Lists webhookdeliveries for the authenticated user

  • Read

    Find webhookdelivery details by ID

    Provides webhookdelivery debug data, such as timestamps, delivery status and attempts.

Whatsapp Signup

  • Read

    List Whatsapp hosted signups

    List hosted signups created by the account, newest first. Expired hosted signups are included.

  • Read

    Get a Whatsapp hosted signup

    Retrieve a hosted signup and its onboarding URL.

  • Read

    List Whatsapp signup sessions

    List finished WhatsApp Embedded Signup sessions, with status SUCCESS or FAILURE, newest first. Use the errors of a failed session to see why provisioning stopped.

  • Read

    Get Whatsapp signup session status

    Retrieve the current state and status of a WhatsApp Embedded Signup session.

  • Write

    Create a Whatsapp hosted signup

    Create a time-limited onboarding URL on the Telnyx-hosted Embedded Signup page for a Tech Provider's end customer. Set signuptype to coexistence to launch Meta's WhatsApp Business app coexistence flow instead of standard Cloud API onboarding.

Wire Guard Interfaces

  • Read

    List all WireGuard Interfaces

    Returns a paginated list of the WireGuard interfaces on your account, with support for filtering.

  • Read

    Retrieve a WireGuard Interfaces

    Returns the details of a single WireGuard interface by its identifier.

  • Read

    List all WireGuard Peers

    Returns a paginated list of your WireGuard peers, with support for filtering.

  • Read

    Retrieve the WireGuard Peer

    Returns the details of a single WireGuard peer by its identifier.

  • Read

    Retrieve Wireguard config template for Peer

    Retrieve Wireguard config template for Peer

  • Write

    Create a WireGuard Interface

    Create a new WireGuard Interface. Current limitation of 10 interfaces per user can be created.

  • Write

    Create a WireGuard Peer

    Create a new WireGuard Peer. Current limitation of 5 peers per interface can be created.

  • Write

    Update the WireGuard Peer

    Updates the specified WireGuard peer and returns the updated peer.

  • Destructive

    Delete a WireGuard Interface

    Deletes the specified WireGuard interface from its network.

  • Destructive

    Delete the WireGuard Peer

    Deletes the specified WireGuard peer from its interface.

Reporting

  • Read

    Get all Wireless Detail Records (WDRs) Reports

    Returns the WDR Reports that match the given parameters.

  • Read

    Get a Wireless Detail Record (WDR) Report

    Returns a single Wireless Detail Record (WDR) report by its identifier, including its parameters and current status.

  • Write

    Create a Wireless Detail Records (WDRs) Report

    Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.

  • Destructive

    Delete a Wireless Detail Record (WDR) Report

    Permanently deletes the specified Wireless Detail Record (WDR) report.

Wireless Regions

  • Read

    Get all wireless regions

    Retrieve all wireless regions for the given product.

Wireless Blocklists

  • Read

    Get all possible wireless blocklist values

    Retrieve all wireless blocklist values for a given blocklist type. The request returns 422 when type is missing or invalid.

  • Read

    Get all Wireless Blocklists

    Get all Wireless Blocklists belonging to the user.

  • Read

    Get a Wireless Blocklist

    Retrieve information about a Wireless Blocklist.

  • Write

    Create a Wireless Blocklist

    Create a Wireless Blocklist to prevent SIMs from connecting to certain networks.

  • Write

    Update a Wireless Blocklist

    Updates the specified wireless blocklist. The update is processed asynchronously, so the request is accepted and completes in the background.

  • Destructive

    Delete a Wireless Blocklist

    Permanently deletes the specified wireless blocklist from your account. The request returns 422 when the wireless blocklist is assigned to a SIM Card Group.

X402 Payment Transactions

  • Read

    List x402 payments

    Returns a paginated list of the authenticated user's x402 payment transactions, newest first. Organization sub-users must have read permission on transactions; without it the list is empty.

  • Read

    Get an x402 payment

    Returns a single x402 payment transaction by ID. The transaction must belong to the authenticated user; organization sub-users must have read permission on transactions. Returns 404 if the transaction does not exist or belongs to another user.

  • Write

    Settle a payment

    Settles an x402 payment using the quote ID and a signed payment authorization. The payment signature can be provided via the PAYMENT-SIGNATURE header or the paymentsignature body parameter.

  • Write

    Create a payment quote

    Creates a payment quote for the specified USD amount. Returns payment details including the x402 payment requirements, network, and expiration time. The quote must be settled before it expires.

See How connections work for access and permissions, or browse all integrations.