Telnyx

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. [Brands] via DELETE /10dlc/brand/{brandId}

Terminate a campaign. Note that once deactivated, a campaign cannot be restored. [Campaign] via DELETE /10dlc/campaign/{campaignId}

This endpoint allows you to remove a campaign assignment from the supplied phoneNumber. [Phone Number Campaigns] via DELETE /10dlc/phone_number_campaigns/{phoneNumber}

Delete an access IP address entry from your account. [IP Addresses] via DELETE /access_ip_address/{access_ip_address_id}

Delete an access IP range from your account. [IP Ranges] via DELETE /access_ip_ranges/{access_ip_range_id}

Permanently deletes the specified address from your account. [Addresses] via DELETE /addresses/{id}

Delete an AI Assistant by assistant_id. [Assistants] via DELETE /ai/assistants/{assistant_id}

Endpoint to delete a canary deploy configuration for an assistant. Removes all canary deploy configurations for the specified assistant. [Assistants] via DELETE /ai/assistants/{assistant_id}/canary-deploys

If the event is pending, this will cancel the event. Otherwise, this will simply remove the record of the event. [Assistants] via DELETE /ai/assistants/{assistant_id}/scheduled_events/{event_id}

Removes the specified tag from the AI assistant and returns the assistant's updated tag list. [Assistants] via DELETE /ai/assistants/{assistant_id}/tags/{tag}

Detaches the specified tool from the AI assistant so the assistant can no longer invoke it. [Assistants] via DELETE /ai/assistants/{assistant_id}/tools/{tool_id}

Permanently removes a specific version of an assistant. Can not delete main version [Assistants] via DELETE /ai/assistants/{assistant_id}/versions/{version_id}

Permanently removes an assistant test and all associated data [Assistants] via DELETE /ai/assistants/tests/{test_id}

Delete a clustering task and its computed results. [Clusters] via DELETE /ai/clusters/{task_id}

Soft-deletes a collection. Its slug is freed and may be reused by a new collection. [AI Collections] via DELETE /ai/collections/{uuid}

Removes a single source from a collection. [AI Collections] via DELETE /ai/collections/{uuid}/sources/{sourceId}

Delete a specific conversation by its ID. [Conversations] via DELETE /ai/conversations/{conversation_id}

Permanently deletes the specified insight template group by its ID. [Conversations] via DELETE /ai/conversations/insight-groups/{group_id}

Removes the specified insight template from the specified group. The insight template itself is not deleted. [Conversations] via DELETE /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/unassign

Permanently deletes the specified insight template by its ID. [Conversations] via DELETE /ai/conversations/insights/{insight_id}

Deletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing. [Embeddings] via DELETE /ai/embeddings/buckets/{bucket_name}

Delete a specific integration connection. [Integrations] via DELETE /ai/integrations/connections/{user_connection_id}

Permanently deletes the specified MCP server configuration from your account. [MCP Servers] via DELETE /ai/mcp_servers/{mcp_server_id}

Permanently deletes the specified mission definition and returns no content on success. [Missions] via DELETE /ai/missions/{mission_id}

Detaches the specified knowledge base from the mission so its content is no longer available to agents in subsequent runs. [Missions] via DELETE /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}

Removes the specified MCP server from the mission, revoking agent access to its tools in subsequent runs. [Missions] via DELETE /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}

Unlinks the specified Telnyx agent from the run so it no longer participates in execution. The run itself and its history are unaffected. [Missions] via DELETE /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents/{telnyx_agent_id}

Removes the specified tool from the mission so agents can no longer invoke it in subsequent runs. [Missions] via DELETE /ai/missions/{mission_id}/tools/{tool_id}

Permanently deletes the specified custom AI tool from your account. [Assistants] via DELETE /ai/tools/{tool_id}

Delete an alphanumeric sender ID and disassociate it from its messaging profile. [Messaging] via DELETE /alphanumeric_sender_ids/{id}

Deletes an existing authentication provider. [Authentication Providers] via DELETE /authentication_providers/{id}

Delete a billing group from your account. [Billing Groups] via DELETE /billing_groups/{id}

Deactivates the specified user bundle on your account and returns the deactivated bundle. [User Bundles] via DELETE /bundle_pricing/user_bundles/{user_bundle_id}

Permanently deletes the specified call control application and its webhook configuration. [Call Control Applications] via DELETE /call_control_applications/{id}

Deletes an existing credential connection. [Credential Connections] via DELETE /credential_connections/{id}

Deletes a stored custom credentials configuration. [Call Recordings] via DELETE /custom_storage_credentials/{connection_id}

Deletes the stored Dialogflow connection for the specified connection. [Dialogflow Integration] via DELETE /dialogflow_connections/{connection_id}

Delete a DIR. Failure modes: 400 if a child phone number is in a non-deletable status, 409 if the DIR has an unresolved infringement claim, 404 if the DIR is not yours. [Display Identity Records] via DELETE /dir/{dir_id}

Deregister phone numbers from a DIR. The enterprise is resolved server-side from the DIR id. Returns a partial-success envelope. [Phone Numbers] via DELETE /dir/{dir_id}/phone_numbers

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. [Documents] via DELETE /documents/{id}

Deletes the dynamic emergency address based on the ID provided [Dynamic Emergency Addresses] via DELETE /dynamic_emergency_addresses/{id}

Deletes the dynamic emergency endpoint based on the ID provided [Dynamic Emergency Endpoints] via DELETE /dynamic_emergency_endpoints/{id}

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 updated_at. [Email Suppressions] via DELETE /email_blocks/{id}

Deletes the webhook subscription identified by ID within the specified email domain and returns the deleted subscription. [Email Webhooks] via DELETE /email_domains/{domain_id}/webhooks/{id}

Deletes an email domain configuration. Verified domains require force=true, and shared domains are read-only for non-owner accounts. [Email Domains] via DELETE /email_domains/{id}

Soft-deletes an account-scoped inbox. Its address remains reserved and the inbox is no longer returned by list or get operations. [Email Inboxes] via DELETE /email_inboxes/{id}

Permanently deletes an unsent draft. Drafts that are being sent or have been sent cannot be deleted; sent drafts are retained for audit. [Email Drafts] via DELETE /email_inboxes/{inbox_id}/drafts/{draft_id}

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. [Email Inboxes] via DELETE /email_inboxes/{inbox_id}/filters

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. [Email Inboxes] via DELETE /email_inboxes/{inbox_id}/messages/{message_id}/labels

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 Inboxes] via DELETE /email_inboxes/{inbox_id}/threads/{thread_id}/labels

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. The operation never searches or reports matches in another account. The legacy /v2/emails DELETE route is a backward-compatible alias. [Email Messages] via DELETE /email_messages

Cancels a scheduled email and returns it with status cancelled. The legacy /v2/emails/{id}/schedule DELETE route is an alias. [Email Messages] via DELETE /email_messages/{email_id}/schedule

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 Messages] via DELETE /email_messages/{id}

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 Templates] via DELETE /email_templates/{id}

If the group has 0 active suppressions, hard-deletes the row. With force=true, soft-deletes all active suppressions first (status → removed, group_id cleared, removed audit event per block) in a single transaction, then hard-deletes the group. Without force and active suppressions present → 409. Audit trail is preserved. force only accepts the string "true" or boolean true; all other values are false. [Email Unsubscribe Groups] via DELETE /email_unsubscribe_groups/{id}

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). Two distinct 404 cases: a missing/cross-account group returns 10001 "The requested unsubscribe group was not found"; a group that exists but has no active suppression for that email returns 10001 "The requested group suppression was not found". [Email Unsubscribe Groups] via DELETE /email_unsubscribe_groups/{id}/suppressions/{email}

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. Resolve it before deleting. - 404 - the enterprise does not exist or does not belong to your account. [Enterprises] via DELETE /enterprises/{enterprise_id}

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. [Reputation] via DELETE /enterprises/{enterprise_id}/reputation

Stop tracking the reputation of this phone number. The number itself remains in your inventory; only the reputation registration is removed. [Reputation] via DELETE /enterprises/{enterprise_id}/reputation/numbers/{phone_number}

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. [External Connections] via DELETE /external_connections/{id}

Dismiss a log message for an external connection associated with your account. [External Connections] via DELETE /external_connections/log_messages/{id}

Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers. [Programmable Fax Applications] via DELETE /fax_applications/{id}

Delete a fax resource from your account. [Programmable Fax Commands] via DELETE /faxes/{id}

Permanently deletes the specified FQDN connection from your account. [FQDN Connections] via DELETE /fqdn_connections/{id}

Permanently deletes the specified FQDN record from its connection. [FQDNs] via DELETE /fqdns/{id}

Deletes the specified Global IP assignment, detaching the Global IP from its WireGuard peer. [Global IPs] via DELETE /global_ip_assignments/{id}

Deletes the specified Global IP health check so it no longer monitors the Global IP's assignments. [Global IPs] via DELETE /global_ip_health_checks/{id}

Deletes the specified Global IP and releases its address back to Telnyx. [Global IPs] via DELETE /global_ips/{id}

Delete an integration secret given its ID. [Integration Secrets] via DELETE /integration_secrets/{id}

Permanently deletes the specified IP connection from your account. [IP Connections] via DELETE /ip_connections/{id}

Permanently deletes the specified IP record from its connection. [IPs] via DELETE /ips/{id}

Deletes a specific MDR detailed report request by ID [MDR Detailed Reports] via DELETE /legacy_reporting/batch_detail_records/messaging/{id}

Deletes a specific Speech to Text batch report request by ID [Speech to Text Batch Reports] via DELETE /legacy/reporting/batch_detail_records/speech_to_text/{id}

Deletes a specific CDR report request by ID [CDR Reports] via DELETE /legacy_reporting/batch_detail_records/voice/{id}

Deletes a specific V2 legacy usage MDR report request by ID [MDR Usage Reports] via DELETE /legacy_reporting/usage_reports/messaging/{id}

Delete a specific telco data usage report by its ID [Telco Data Usage Reports] via DELETE /legacy_reporting/usage_reports/number_lookup/{id}

Deletes a specific V2 legacy usage CDR report request by ID [CDR Usage Reports] via DELETE /legacy_reporting/usage_reports/voice/{id}

Permanently deletes the specified media file from storage. [Media Storage API] via DELETE /media/{media_name}

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 Sessions] via DELETE /meeting_sessions/{id}

Not yet available in production — this route is not currently routed on api.telnyx.com and returns a generic 404; it is documented ahead of rollout. Irreversibly requests deletion of provider-hosted aggregate recording media under the provider contract. The operation retains the Telnyx-local Meeting session, transcript segments, events, artifacts, and usage records. It is separate from DELETE /meeting_sessions/{id}, which stops or cancels participation without deleting the persisted session. A missing/foreign session returns 404; provider deletion failures return 502. [Meeting Session Data] via DELETE /meeting_sessions/{id}/recording_media

Cancel a scheduled message that has not yet been sent. Only messages with status=scheduled and send_at more than a minute from now can be cancelled. [Messages] via DELETE /messages/{id}

Delete a messaging hosted number order and all associated phone numbers. [Hosted Numbers] via DELETE /messaging_hosted_number_orders/{id}

Removes the specified hosted number from Telnyx messaging management. [Hosted Numbers] via DELETE /messaging_hosted_numbers/{id}

Deletes the specified messaging profile and returns the profile's final configuration. [Profiles] via DELETE /messaging_profiles/{id}

Deletes the specified auto-response rule from the messaging profile. [Opt-Out Management] via DELETE /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}

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 [Verification Requests] via DELETE /messaging_tollfree/verification/requests/{id}

Deletes a mobile push credential based on the given push_credential_id [Push Credentials] via DELETE /mobile_push_credentials/{push_credential_id}

Permanently deletes the specified network from your account. [Networks] via DELETE /networks/{id}

Removes the default gateway from the specified network. [Networks] via DELETE /networks/{id}/default_gateway

Deletes the specified notification channel so notifications are no longer delivered to it. [Notifications] via DELETE /notification_channels/{id}

Deletes the specified notification profile from your account. [Notifications] via DELETE /notification_profiles/{id}

Deletes the specified notification setting, disabling that notification delivery. [Notifications] via DELETE /notification_settings/{id}

Permanently deletes the specified OAuth client from your account. [OAuth Clients] via DELETE /oauth_clients/{id}

Revokes the specified OAuth grant, withdrawing the access previously granted to the client. [OAuth Grants] via DELETE /oauth_grants/{id}

Deletes an existing outbound voice profile. [Outbound Voice Profiles] via DELETE /outbound_voice_profiles/{id}

Deletes the specified phone number from the account. The response contains the phone number's final deleted representation. [Phone Number Configurations] via DELETE /phone_numbers/{id}

Permanently deletes the specified LOA configuration so it can no longer be used when generating LOA documents. [Porting Orders] via DELETE /porting/loa_configurations/{id}

Deletes an existing porting order. This operation is restrict to porting orders in draft state. [Porting Orders] via DELETE /porting_orders/{id}

Deletes an additional document for a porting order. [Porting Orders] via DELETE /porting_orders/{id}/additional_documents/{additional_document_id}

Deletes an associated phone number from a porting order. [Porting Orders] via DELETE /porting_orders/{porting_order_id}/associated_phone_numbers/{id}

Deletes the specified phone number block from the porting order. [Porting Orders] via DELETE /porting_orders/{porting_order_id}/phone_number_blocks/{id}

Deletes the specified phone number extension from the porting order. [Porting Orders] via DELETE /porting_orders/{porting_order_id}/phone_number_extensions/{id}

Permanently deletes the specified Private Wireless Gateway from your account. [Private Wireless Gateways] via DELETE /private_wireless_gateways/{id}

Permanently delete a pronunciation dictionary. [Pronunciation Dictionaries] via DELETE /pronunciation_dicts/{id}

Deletes the specified public internet gateway, removing internet egress through it. [Public Internet Gateways] via DELETE /public_internet_gateways/{id}

Permanently deletes the specified call queue from your account. [Queue Commands] via DELETE /queues/{queue_name}

Removes an inactive call from a queue. If the call is no longer active, use this command to remove it from the queue. [Queue Commands] via DELETE /queues/{queue_name}/calls/{call_control_id}

Removes a test device from an RCS agent and its provider registration. [RCS Agents] via DELETE /rcs/agents/{id}/test_devices/{test_device_id}

Permanently deletes a recording transcription. [Call Recordings] via DELETE /recording_transcriptions/{recording_transcription_id}

Permanently deletes the specified call recording and returns the deleted recording resource. The media is removed and can no longer be downloaded. [Call Recordings] via DELETE /recordings/{recording_id}

Permanently deletes the specified messaging usage report by its identifier. [MDR Usage Reports] via DELETE /reports/mdr_usage_reports/{id}

Convenience alias for DELETE /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}. [Reputation] via DELETE /reputation/numbers/{phone_number}

Deletes the regulatory requirement group identified by id. The response contains the deleted requirement-group representation. [Requirement Groups] via DELETE /requirement_groups/{id}

Cancel a pending requirement version. The pending version is marked as cancelled and the previously active version is restored with effective_end_at set to NULL. [Requirements] via DELETE /requirements/{id}/versions/pending

Synchronously delete a room composition. [Room Compositions] via DELETE /room_compositions/{room_composition_id}

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. [Room Recordings] via DELETE /room_recordings

Synchronously deletes the specified video room recording. The recording's media is removed permanently. [Room Recordings] via DELETE /room_recordings/{room_recording_id}

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] via DELETE /rooms/{room_id}

Delete the SIM Card Data Usage Notification. [SIM Cards] via DELETE /sim_card_data_usage_notifications/{id}

Permanently deletes the specified SIM card group from your account. [SIM Card Groups] via DELETE /sim_card_groups/{id}

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. Transitioning to the disabled state may take a period of time. Until the transition is completed, the SIM card status will be disabling disabling . In order to re-enable the SIM card, you will need to re-register it. [SIM Cards] via DELETE /sim_cards/{id}

Deletes the stored SIPREC connector with the specified connector name. [SIPREC Connectors] via DELETE /siprec_connectors/{connector_name}

Deletes an SSL certificate and its matching secret. [Bucket SSL Certificate] via DELETE /storage/buckets/{bucketName}/ssl_certificate

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. If the filesystem still contains data, the request may be rejected with a 409 — drain the bucket and retry. [cloudfs filesystems] via DELETE /storage/cloudfs/{id}

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 namespaces] via DELETE /storage/kvs/{id}

Deletes a key. Idempotent: deleting a key that does not exist still succeeds. The namespace itself must exist and be provisioned. [kv keys] via DELETE /storage/kvs/{id}/keys/{key}

Delete a migration source configuration. [Data Migration] via DELETE /storage/migration_sources/{id}

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. A database still bound by a function is refused with 409 unless force=true. [sql databases] via DELETE /storage/sqldbs/{id}

Permanently deletes the specified telephony credential, revoking any access it provided. [Credentials] via DELETE /telephony_credentials/{id}

Removes the specified participant from the conference, ending their leg of the call. [TeXML REST Commands] via DELETE /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}

Permanently deletes the specified queue resource from the account. [TeXML REST Commands] via DELETE /texml/Accounts/{account_sid}/Queues/{queue_sid}

Deletes recording resource identified by recording id. [TeXML REST Commands] via DELETE /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json

Permanently deletes a recording transcription. [TeXML REST Commands] via DELETE /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json

Permanently deletes the specified TeXML application from your account. [TeXML Applications] via DELETE /texml_applications/{id}

Permanently deletes the specified traffic policy profile from your account. [Traffic Policy Profiles] via DELETE /traffic_policy_profiles/{id}

Permanently deletes the specified UAC connection from your account. [UAC Connections] via DELETE /uac_connections/{id}

Delete a mobile voice connection from your account. [Mobile Voice Connections] via DELETE /mobile_voice_connections/{id}

Remove a verified number from your account. [Verified Numbers] via DELETE /verified_numbers/{phone_number}

Deletes the specified Verify profile and returns the deleted profile record. [Verify] via DELETE /verify_profiles/{verify_profile_id}

Deletes the specified virtual cross connect from your account. [Virtual Cross Connects] via DELETE /virtual_cross_connects/{id}

Permanently deletes a voice clone. This action cannot be undone. [Voice Clones] via DELETE /voice_clones/{id}

Permanently deletes a voice design and all of its versions. This action cannot be undone. [Voice Designs] via DELETE /voice_designs/{id}

Permanently deletes a specific version of a voice design. The version number must be a positive integer. [Voice Designs] via DELETE /voice_designs/{id}/versions/{version}

Delete a WhatsApp Business Account connection from your Telnyx account. [Whatsapp Business Accounts] via DELETE /whatsapp/business_accounts/{id}

Permanently deletes the specified WhatsApp message template from your account. [Whatsapp Message Templates] via DELETE /whatsapp/message_templates/{id}

Delete a phone number's WhatsApp registration from your account. [Whatsapp Phone Numbers] via DELETE /whatsapp/phone_numbers/{phone_number}

Delete the profile photo of a WhatsApp phone number. [Whatsapp Phone Numbers] via DELETE /whatsapp/phone_numbers/{phone_number}/profile/photo

Deletes the specified WireGuard interface from its network. [WireGuard Interfaces] via DELETE /wireguard_interfaces/{id}

Deletes the specified WireGuard peer from its interface. [WireGuard Interfaces] via DELETE /wireguard_peers/{id}

Permanently deletes the specified wireless blocklist from your account. [Wireless Blocklists] via DELETE /wireless_blocklists/{id}

Permanently deletes the specified Wireless Detail Record (WDR) report. [Reporting] via DELETE /wireless/detail_records_reports/{id}

This endpoint is used to list all brands associated with your organization. [Brands] via GET /10dlc/brand

Returns the details of a 10DLC brand by its brandId, including the count of campaigns associated with the brand. [Brands] via GET /10dlc/brand/{brandId}

Get list of valid external vetting record for a given brand [Brands] via GET /10dlc/brand/{brandId}/externalVetting

Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID. This endpoint allows you to check the delivery and verification status of an OTP sent during the Sole Proprietor brand verification process by looking it up with the brand ID. The response includes delivery status, verification dates, and detailed delivery information. Note: This is an alternative to the /10dlc/brand/smsOtp/{referenceId} endpoint when you have the Brand ID but not the reference ID. [Brands] via GET /10dlc/brand/{brandId}/smsOtp

Get feedback about a brand by ID. This endpoint can be used after creating or revetting a brand. Possible values for .category[].id: * TAX_ID - Data mismatch related to tax id and its associated properties. * STOCK_SYMBOL - Non public entity registered as a public for profit entity or the stock information mismatch. * GOVERNMENT_ENTITY - Non government entity registered as a government entity. Must be a U.S. government entity. * NONPROFIT - Not a recognized non-profit entity. No IRS tax-exempt status found. * OTHERS - Details of the data misrepresentation if any. [Brands] via GET /10dlc/brand_feedback/{brandId}

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. You can query by either: * referenceId - The reference ID returned when the OTP was initially triggered * brandId - Query parameter for portal users to look up OTP status by Brand ID The response includes delivery status, verification dates, and detailed delivery information. [Brands] via GET /10dlc/brand/smsOtp/{referenceId}

Retrieve a list of campaigns associated with a supplied brandId. [Campaign] via GET /10dlc/campaign

Retrieve campaign details by campaignId. [Campaign] via GET /10dlc/campaign/{campaignId}

Get the campaign metadata for each MNO it was submitted to. [Campaign] via GET /10dlc/campaign/{campaignId}/mnoMetadata

Retrieve campaign's operation status at MNO level. [Campaign] via GET /10dlc/campaign/{campaignId}/operationStatus

Retrieve the OSR attributes assigned to a 10DLC campaign. [Campaign] via GET /10dlc/campaign/{campaignId}/osr_attributes

Returns whether the campaign is configured for partner sharing and the current sharing state. [Campaign] via GET /10dlc/campaign/{campaignId}/sharing

Retrieve the campaign cost associated with a given 10DLC use case, including any carrier fees. [Campaign] via GET /10dlc/campaign/usecase_cost

This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case. [Campaign] via GET /10dlc/campaignBuilder/brand/{brandId}/usecase/{usecase}

Returns the accepted values for the selected 10DLC enumeration endpoint. Use these values when constructing brand and campaign requests. [Enum] via GET /10dlc/enum/{endpoint}

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. In other words, shared but pending campaigns are currently omitted from the response from this endpoint. [Shared Campaigns] via GET /10dlc/partner_campaigns

Retrieve campaign details by campaignId. [Shared Campaigns] via GET /10dlc/partner_campaigns/{campaignId}

Returns the partner-sharing state for the specified campaign. [Shared Campaigns] via GET /10dlc/partnerCampaign/{campaignId}/sharing

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. [Shared Campaigns] via GET /10dlc/partnerCampaign/sharedByMe

Returns phone-number-to-campaign assignments for the authenticated account. Apply the documented filters and pagination parameters to narrow the result set. [Phone Number Campaigns] via GET /10dlc/phone_number_campaigns

Retrieve an individual phone number/campaign assignment by phoneNumber. [Phone Number Campaigns] via GET /10dlc/phone_number_campaigns/{phoneNumber}

Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by taskId. [Bulk Phone Number Campaigns] via GET /10dlc/phoneNumberAssignmentByProfile/{taskId}

Check the status of the individual phone number/campaign assignments associated with the supplied taskId. [Bulk Phone Number Campaigns] via GET /10dlc/phoneNumberAssignmentByProfile/{taskId}/phoneNumbers

Retrieve a paginated list of access IP addresses configured on your account. [IP Addresses] via GET /access_ip_address

Retrieve the details of a specific access IP address. [IP Addresses] via GET /access_ip_address/{access_ip_address_id}

Retrieve a paginated list of access IP ranges configured on your account. [IP Ranges] via GET /access_ip_ranges

Returns a paginated list of the addresses on your account, with support for filtering and sorting. [Addresses] via GET /addresses

Retrieves the details of an existing address. [Addresses] via GET /addresses/{id}

Returns the advanced number orders associated with the account. Each result includes the order configuration and its current state. [Advanced Number Orders] via GET /advanced_orders

Returns the advanced number order identified by order_id, including its configuration and current state. [Advanced Number Orders] via GET /advanced_orders/{order_id}

Retrieve a list of all AI Assistants configured by the user. [Assistants] via GET /ai/assistants

Retrieve an AI Assistant configuration by assistant_id. [Assistants] via GET /ai/assistants/{assistant_id}

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. [Assistants] via GET /ai/assistants/{assistant_id}/canary-deploys

Get scheduled events for an assistant with pagination and filtering [Assistants] via GET /ai/assistants/{assistant_id}/scheduled_events

Returns the details of a single scheduled event configured for the specified assistant. [Assistants] via GET /ai/assistants/{assistant_id}/scheduled_events/{event_id}

Get an assistant texml by assistant_id. [Assistants] via GET /ai/assistants/{assistant_id}/texml

Retrieves all versions of a specific assistant with complete configuration and metadata [Assistants] via GET /ai/assistants/{assistant_id}/versions

Retrieves a specific version of an assistant by assistant_id and version_id [Assistants] via GET /ai/assistants/{assistant_id}/versions/{version_id}

Retrieve all tags that have been applied to your AI assistants. [Assistants] via GET /ai/assistants/tags

Retrieves a paginated list of assistant tests with optional filtering capabilities [Assistants] via GET /ai/assistants/tests

Retrieves detailed information about a specific assistant test [Assistants] via GET /ai/assistants/tests/{test_id}

Retrieves paginated execution history for a specific assistant test with filtering options [Assistants] via GET /ai/assistants/tests/{test_id}/runs

Retrieves detailed information about a specific test run execution [Assistants] via GET /ai/assistants/tests/{test_id}/runs/{run_id}

Retrieves a list of all distinct test suite names available to the current user [Assistants] via GET /ai/assistants/tests/test-suites

Retrieves paginated history of test runs for a specific test suite with filtering options [Assistants] via GET /ai/assistants/tests/test-suites/{suite_name}/runs

Retrieve a paginated list of clustering tasks and their statuses. [Clusters] via GET /ai/clusters

Fetch the results of a clustering task, including the discovered clusters. [Clusters] via GET /ai/clusters/{task_id}

Returns a paginated list of collections in your organization. [AI Collections] via GET /ai/collections

Runs search over the documents in a collection, ranked by relevance to query. The collection's retrieval_type setting selects the strategy: vector (semantic similarity), hybrid (vector similarity fused with keyword matching), or keyword (lexical BM25 matching). When query is omitted, returns a plain catalog listing of the collection's documents. How it works: 1. For vector and hybrid, the query text is embedded into a 1024-dimensional vector using the multilingual-e5-large model. 2. For vector, the embedding is compared against the collection's indexed document chunks using semantic similarity; for hybrid, those similarity scores are fused with keyword-match scores; for keyword, only lexical BM25 matching is applied. 3. Results are ranked by score (descending) and paginated via page[number] / page[size]. Authentication: Requires a Telnyx API key via Authorization: Bearer . Results are automatically scoped to your organization and cannot be overridden. Filtering: Use filter[field][operator]=value query parameters to narrow results before search. Supported operators: eq (default), in, gte, gt, lte, lt, contains. Metadata fields resolve to metadata. . Examples: - GET /v2/ai/collections/my-collection/documents?query=billing+issue&top_k=10 - GET /v2/ai/collections/my-collection/documents?query=refund&sources=voice,message - GET /v2/ai/collections/my-collection/documents?query=outage&filter[record_created_at][gte]=2026-01-01T00:00:00Z [AI Collections] via GET /ai/collections/{slug}/documents

Fetches a single collection by its uuid. [AI Collections] via GET /ai/collections/{uuid}

Returns the retrieval settings for a collection. [AI Collections] via GET /ai/collections/{uuid}/settings

Returns the sources attached to a collection. [AI Collections] via GET /ai/collections/{uuid}/sources

Fetches a single collection by its slug. [AI Collections] via GET /ai/collections/slug/{slug}

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. When no region is specified, all regions are queried in parallel (fan-out) and results are merged by score. 4. Results are ranked by similarity score (descending) and paginated via page[number] / page[size]. Authentication: Requires a Telnyx API key via Authorization: Bearer . Results are automatically scoped to the caller's organization — organization_id is injected from the auth token and cannot be overridden. Chunking: Records are split into chunks of up to 480 tokens with 64-token overlap at ingestion time. Each search result represents a single chunk, with chunk_index and chunk_total indicating its position within the original record. Filtering: Use filter[field][operator]=value query parameters to narrow results before vector search. Top-level filterable fields: user_id, region, record_id, record_created_at, ingested_at, retention Note: retention is filter-only — it can be used to narrow results but is not returned in the response body. Metadata fields: any field not in the list above is resolved to data.metadata. (e.g., filter[language]=en → data.metadata.language). Supported filter operators: - eq — exact match (default when no operator specified) - in — match any of comma-separated values - gte, gt, lte, lt — range comparisons (useful for date filtering) - contains — wildcard substring match Examples: - GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10 - GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5 - GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z - GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU - GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en [Conversation Histories] via GET /ai/conversation_histories

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. For example, to filter by a custom field metadata->custom_field, use metadata->custom_field=eq.value. [Conversations] via GET /ai/conversations

Retrieve a specific AI conversation by its ID. [Conversations] via GET /ai/conversations/{conversation_id}

Retrieve insights for a specific conversation [Conversations] via GET /ai/conversations/{conversation_id}/conversations-insights

Retrieve messages for a specific conversation, including tool calls made by the assistant. [Conversations] via GET /ai/conversations/{conversation_id}/messages

Aggregate conversation insights by specified fields [Conversations] via GET /ai/conversations/conversation-insights/aggregates

Returns a paginated list of your insight template groups. Groups organize related insight templates that are applied together when analyzing conversations. [Conversations] via GET /ai/conversations/insight-groups

Returns the details of a single insight template group, including the insight templates assigned to it. [Conversations] via GET /ai/conversations/insight-groups/{group_id}

Returns a paginated list of your insight templates. Insight templates define analyses that run over AI conversations to extract structured findings. [Conversations] via GET /ai/conversations/insights

Returns the details of a single insight template by its ID, including its configuration. [Conversations] via GET /ai/conversations/insights/{insight_id}

Retrieve tasks for the user that are either queued, processing, failed, success or partial_success based on the query string. Defaults to queued and processing. [Embeddings] via GET /ai/embeddings

Returns the list of storage buckets that have been embedded for your account, for use with similarity search. [Embeddings] via GET /ai/embeddings/buckets

Get all embedded files for a given user bucket, including their processing status. [Embeddings] via GET /ai/embeddings/buckets/{bucket_name}

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 were embedded successfully - partial_success - Some files were embedded successfully, but at least one failed [Embeddings] via GET /ai/embeddings/{task_id}

Retrieve a list of all fine tuning jobs created by the user. [Fine Tuning] via GET /ai/fine_tuning/jobs

Returns the details of a single fine-tuning job by its job_id, including its current status. [Fine Tuning] via GET /ai/fine_tuning/jobs/{job_id}

Returns the list of third-party integrations available to connect to your AI assistants and workflows. [Integrations] via GET /ai/integrations

Returns the details of a single available integration, including its configuration details. [Integrations] via GET /ai/integrations/{integration_id}

Returns the list of integration connections you have set up, linking your account to third-party services. [Integrations] via GET /ai/integrations/connections

Returns the details of a single integration connection by its ID. [Integrations] via GET /ai/integrations/connections/{user_connection_id}

Returns a paginated list of the MCP servers configured on your account, with optional filtering by type or URL. [MCP Servers] via GET /ai/mcp_servers

Retrieve details for a specific MCP server. [MCP Servers] via GET /ai/mcp_servers/{mcp_server_id}

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. [Missions] via GET /ai/missions

Get a mission by ID (includes tools, knowledge_bases, mcp_servers) [Missions] via GET /ai/missions/{mission_id}

Returns the knowledge bases attached to the specified mission. Knowledge bases provide reference content agents can draw on during runs. [Missions] via GET /ai/missions/{mission_id}/knowledge-bases

Returns the details of a single knowledge base attached to the specified mission. [Missions] via GET /ai/missions/{mission_id}/knowledge-bases/{knowledge_base_id}

Returns the MCP servers configured on the specified mission. MCP servers expose external tools and data sources agents can use during runs. [Missions] via GET /ai/missions/{mission_id}/mcp-servers

Returns the configuration of a single MCP server attached to the specified mission. [Missions] via GET /ai/missions/{mission_id}/mcp-servers/{mcp_server_id}

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. [Missions] via GET /ai/missions/{mission_id}/runs

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. [Missions] via GET /ai/missions/{mission_id}/runs/{run_id}

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. [Missions] via GET /ai/missions/{mission_id}/runs/{run_id}/events

Returns the details of a single event logged for the specified run, including its type and payload. [Missions] via GET /ai/missions/{mission_id}/runs/{run_id}/events/{event_id}

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. [Missions] via GET /ai/missions/{mission_id}/runs/{run_id}/plan

Returns the details of a single plan step within a run's plan, including its status. [Missions] via GET /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}

Returns the Telnyx agents currently linked to the specified run. Linked agents participate in executing the run's plan. [Missions] via GET /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents

Returns the tools configured on the specified mission. Tools define the actions agents may invoke while executing the mission's runs. [Missions] via GET /ai/missions/{mission_id}/tools

Returns the definition of a single tool configured on the specified mission. [Missions] via GET /ai/missions/{mission_id}/tools/{tool_id}

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. [Missions] via GET /ai/missions/events

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. [Missions] via GET /ai/missions/runs

Deprecated: Use GET /v2/ai/openai/models instead. Returns the same ModelsResponse payload as the OpenAI-compatible endpoint — open-source LLMs hosted on Telnyx (e.g. moonshotai/Kimi-K2.6, zai-org/GLM-5.1-FP8, MiniMaxAI/MiniMax-M2.7), embedding models, and fine-tuned models — kept around for backwards compatibility. New integrations should use /v2/ai/openai/models. Model ids follow the {organization}/{model_name} convention from Hugging Face. [Chat] via GET /ai/models

Returns a list of available embedding models. This endpoint is compatible with the OpenAI Models API format. [OpenAI Embeddings] via GET /ai/openai/embeddings/models

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. Each entry is a ModelMetadata object describing the model id, owner, task, context length, supported languages, billing tier, pricing per 1M tokens, deployment regions, and whether the model supports vision or fine-tuning. Use this endpoint to discover model ids you can pass to POST /v2/ai/openai/chat/completions. Model ids follow the {organization}/{model_name} convention from Hugging Face (for example moonshotai/Kimi-K2.6). This endpoint is OpenAI-compatible: clients pointed at https://api.telnyx.com/v2/ai/openai can call client.models.list() to retrieve the same payload. [OpenAI Chat] via GET /ai/openai/models

Retrieve a list of the custom AI tools configured on your account. [Assistants] via GET /ai/tools

Retrieve the details of a specific AI tool. [Assistants] via GET /ai/tools/{tool_id}

List all alphanumeric sender IDs for the authenticated user. [Messaging] via GET /alphanumeric_sender_ids

Retrieve a specific alphanumeric sender ID. [Messaging] via GET /alphanumeric_sender_ids/{id}

Retrieve a list of audit log entries. Audit logs are a best-effort, eventually consistent record of significant account-related changes. [Audit Logs] via GET /audit_events

Returns a list of your SSO authentication providers. [Authentication Providers] via GET /authentication_providers

Retrieves the details of an existing authentication provider. [Authentication Providers] via GET /authentication_providers/{id}

Searches the Telnyx inventory for available contiguous phone-number blocks. Results can be filtered by locality, country, national destination code, and number type. [Phone Number Search] via GET /available_phone_number_blocks

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. [Phone Number Search] via GET /available_phone_numbers

Retrieve the current balance, available credit, and credit limit for your account. [Billing] via GET /balance

Retrieve a paginated list of billing groups on your account. [Billing Groups] via GET /billing_groups

Retrieve the details of a specific billing group. [Billing Groups] via GET /billing_groups/{id}

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. [SIM Card Actions] via GET /bulk_sim_card_actions

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. [SIM Card Actions] via GET /bulk_sim_card_actions/{id}

Returns a paginated list of the billing bundles available to your account, with support for filtering. [Bundles] via GET /bundle_pricing/billing_bundles

Returns the details of a single billing bundle by its ID, so you can inspect its contents before purchasing a user bundle. [Bundles] via GET /bundle_pricing/billing_bundles/{bundle_id}

Returns a paginated list of the bundles active on your account, with support for filtering. [User Bundles] via GET /bundle_pricing/user_bundles

Returns the details of a single user bundle on your account by its ID. [User Bundles] via GET /bundle_pricing/user_bundles/{user_bundle_id}

Retrieves the resources of a user bundle by its ID. [User Bundles] via GET /bundle_pricing/user_bundles/{user_bundle_id}/resources

Returns all user bundles that aren't in use. [User Bundles] via GET /bundle_pricing/user_bundles/unused

Return a list of call control applications. [Call Control Applications] via GET /call_control_applications

Retrieves the details of an existing call control application. [Call Control Applications] via GET /call_control_applications/{id}

Filters call events by given filter parameters. Events are ordered by occurred_at. If filter for leg_id or application_session_id is not present, it only filters events from the last 24 hours. Note: Only one filter[occurred_at] can be passed. [Debugging] via GET /call_events

Telnyx maintains a library of pre-vetted call-reason phrases (e.g. "Appointment reminders", "Billing inquiries") that carry through DIR vetting smoothly. You can use any string that fits your use case in DirCreateRequest.call_reasons, but matching one of these reduces the chance the vetting team flags the phrasing for clarification. [Reference Data] via GET /call_reasons

Returns the status of a call (data is available 10 minutes after call ended). [Call Information] via GET /calls/{call_control_id}

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. [Voice Channels] via GET /channel_zones

Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. The date range cannot exceed 31 days. [Billing] via GET /charges_breakdown

Retrieve a summary of monthly charges for a specified date range. The date range cannot exceed 31 days. [Billing] via GET /charges_summary

Returns comments associated with number-order records. Results can be filtered by record type and record ID and include pagination metadata. [Phone Number Orders] via GET /comments

Returns the comment identified by id, including its associated record and comment metadata. [Phone Number Orders] via GET /comments/{id}

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 expires_at. [Conference Commands] via GET /conferences

Returns a paginated list of participants in the specified conference, with support for filtering. [Conference Commands] via GET /conferences/{conference_id}/participants

Returns the details of an existing conference, including its current status. [Conference Commands] via GET /conferences/{id}

Retrieve details of a specific conference participant by their ID or label. [Conference Commands] via GET /conferences/{id}/participants/{participant_id}

Returns a list of your connections irrespective of type. [Connections] via GET /connections

Lists all active calls for given connection. Acceptable connections are either SIP connections with webhook_url or xml_request_url, call control or texml. Returned results are cursor paginated. [Call Information] via GET /connections/{connection_id}/active_calls

Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type. [Connections] via GET /connections/{id}

Returns Telnyx service coverage information for every country, including which number types and features are available in each. [Country Coverage] via GET /country_coverage

Returns Telnyx service coverage information for the specified country, including available number types and features. [Country Coverage] via GET /country_coverage/countries/{country_code}

Returns a list of your credential connections. [Credential Connections] via GET /credential_connections

Retrieves the details of an existing credential connection. [Credential Connections] via GET /credential_connections/{id}

Returns the information about custom storage credentials. [Call Recordings] via GET /custom_storage_credentials/{connection_id}

Returns a paginated list of your customer service record (CSR) requests, with support for filtering and sorting. [Customer Service Record] via GET /customer_service_records

Returns the details of a single customer service record (CSR) request, including its status and any retrieved record data. [Customer Service Record] via GET /customer_service_records/{customer_service_record_id}

Search for any detail record across the Telnyx Platform [Detail Records] via GET /detail_records

Return details of the Dialogflow connection associated with the given CallControl connection. [Dialogflow Integration] via GET /dialogflow_connections/{connection_id}

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). Supports filter[] query params: filter[enterprise_id], filter[status], filter[display_name][contains], filter[call_reason][contains], plus the renewal-window filters filter[expiring_at][gte] / filter[expiring_at][lte]. Sortable by created_at, updated_at, display_name, status (prefix - for descending; default -created_at). [Display Identity Records] via GET /dir

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. [Display Identity Records] via GET /dir/{dir_id}

List the comments on a DIR. The enterprise is resolved server-side from the DIR id. [Comments] via GET /dir/{dir_id}/comments

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). Resolution outcomes: upheld (claim accepted; DIR stays suspended/permanently_rejected), rejected (claim dismissed; DIR restored to verified), modified (partial outcome). [Infringement Claims] via GET /dir/{dir_id}/infringement_claims

List the phone-number batches submitted under a DIR. The enterprise is resolved server-side from the DIR id. [Phone Number Batches] via GET /dir/{dir_id}/phone_number_batches

Get a single phone-number batch by id. The enterprise is resolved server-side from the DIR id. [Phone Number Batches] via GET /dir/{dir_id}/phone_number_batches/{batch_id}

List the phone numbers registered under a DIR. The enterprise is resolved server-side from the DIR id. [Phone Numbers] via GET /dir/{dir_id}/phone_numbers

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. Each entry carries its ref_type and slot, which together address the reference when updating it, alongside the details supplied when it was submitted (name, title, organization, relationship, phone, email, timezone). No internal identifiers are exposed. Returns an empty list when no references were submitted. [DIR References] via GET /dir/{dir_id}/references

Whether the DIR's current authorizer email has been verified. [Email Verification] via GET /dir/{dir_id}/verify_email

Reference list of document_type values accepted by DirCreateRequest.documents[].document_type and the infringement-contest endpoint. Each entry has a stable short_name (used in API calls) and a customer-facing description. [Reference Data] via GET /dir/document_types

List all documents links ordered by created_at descending. [Documents] via GET /document_links

List all documents ordered by created_at descending. [Documents] via GET /documents

Returns the details of a single document on your account, including its metadata. [Documents] via GET /documents/{id}

Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication. [Documents] via GET /documents/{id}/download_link

Returns the dynamic emergency addresses according to filters [Dynamic Emergency Addresses] via GET /dynamic_emergency_addresses

Returns the dynamic emergency address based on the ID provided [Dynamic Emergency Addresses] via GET /dynamic_emergency_addresses/{id}

Returns the dynamic emergency endpoints according to filters [Dynamic Emergency Endpoints] via GET /dynamic_emergency_endpoints

Returns the dynamic emergency endpoint based on the ID provided [Dynamic Emergency Endpoints] via GET /dynamic_emergency_endpoints/{id}

Account-scoped list. Two mutually exclusive pagination modes: - Offset: page[number] (default 1) + page[size] (default 25, max 100). meta contains total_pages. - Cursor: page[after] and/or page[before] (opaque Base.url_encode64 of {"created_at","id"}). Cannot combine with page[number]; after+before together is an error. meta contains next_cursor / previous_cursor (omitted when their flag is false). Sort defaults to -created_at (desc); only created_at is sortable. A -- prefix is an error. nil/empty filter values are silently dropped. [Email Suppressions] via GET /email_blocks

Returns the account-owned suppression identified by ID. Cross-account lookups and malformed IDs return 404 without exposing another account’s data. [Email Suppressions] via GET /email_blocks/{id}

Offset pagination only (page[number] default 1, page[size] default 50, max 100). No sort, no filter, no cursor — ordering is fixed desc occurred_at, desc id. Verifies the block belongs to the account first (cross-account → 404). [Email Suppressions] via GET /email_blocks/{id}/events

Streams the account's suppressions as a chunked CSV (server-side cursor; never materialized). Content-type text/csv, header Content-Disposition: attachment; filename="email_blocks_export.csv". Filters (filter[reason], filter[domain_id], filter[created_after], filter[created_before]) are the only params that affect output. sort and page[*] are parsed (bad values still produce 400) but ignored — rows stream ORDER BY created_at ASC, id ASC with no pagination. CSV columns: id,to,from,reason,source,scope,status,domain_id, created_at,updated_at,expires_at,group_id. The CSV carries the group_id column so group-scoped suppressions' group link survives the export (empty for account-scope rows). [Email Suppressions] via GET /email_blocks/export

Account-scoped fetch (cross-account → 404; malformed UUID → 404). Nullable fields are omitted until terminal: provider/completed_at when nil; processed_rows/created_count/existing_count/ skipped_count/error_count only when status == completed; errors only when non-empty; failure_reason only on terminal failure. [Email Suppression Imports] via GET /email_blocks/import/{id}

Shared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains. [Email Domains] via GET /email_domains

Returns the DNS records Telnyx generated for domain ownership and DKIM verification, plus MX records when inbound delivery is enabled. [Email Domain DNS Records] via GET /email_domains/{domain_id}/dns_records

Returns a paginated list of webhook subscriptions scoped to the email domain. Results can be sorted by creation time. [Email Webhooks] via GET /email_domains/{domain_id}/webhooks

Returns the webhook subscription identified by ID within the specified email domain. [Email Webhooks] via GET /email_domains/{domain_id}/webhooks/{id}

Shared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains. [Email Domains] via GET /email_domains/{id}

Returns a summary of domain health including verification status and usability. [Email Domains] via GET /email_domains/{id}/health

Lists account-level email events sorted oldest first by occurred_at asc, id asc. [Email Events] via GET /email_events

Returns counts and rates for email events over a time range. The default start time is 30 days ago. [Email Events] via GET /email_events/stats

Lists the account's non-deleted inboxes newest first using stable cursor pagination. [Email Inboxes] via GET /email_inboxes

Returns an account-scoped, non-deleted inbox. Missing and foreign inboxes are indistinguishable. [Email Inboxes] via GET /email_inboxes/{id}

Lists drafts newest first using stable cursor pagination. All access is scoped to the authenticated account and the given inbox. [Email Drafts] via GET /email_inboxes/{inbox_id}/drafts

Returns a single draft. Drafts that have been sent remain retrievable, so the exact content that was sent stays auditable. [Email Drafts] via GET /email_inboxes/{inbox_id}/drafts/{draft_id}

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. [Email Inboxes] via GET /email_inboxes/{inbox_id}/filters

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. [Email Inboxes] via GET /email_inboxes/{inbox_id}/messages

Lists thread summaries newest first using stable cursor pagination. [Email Inboxes] via GET /email_inboxes/{inbox_id}/threads

Returns a bounded page of inbound and outbound thread messages interleaved in chronological order using stable cursor pagination. [Email Inboxes] via GET /email_inboxes/{inbox_id}/threads/{thread_id}

Lists messages sorted newest first by created_at desc, id desc. No filters other than cursor pagination are implemented. The legacy /v2/emails GET route is a backward-compatible alias for this operation. [Email Messages] via GET /email_messages

Lists events for a single message sorted oldest first by occurred_at asc, id asc. The legacy /v2/emails/{id}/events GET route is a backward-compatible alias. [Email Messages] via GET /email_messages/{email_id}/events

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. Default page size is 25, maximum is 100. [Email Messages] via GET /email_messages/{email_id}/recipients

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). [Email Messages] via GET /email_messages/{email_id}/recipients/{recipient_id}

The legacy /v2/emails/{id} GET route is a backward-compatible alias for this operation. [Email Messages] via GET /email_messages/{id}

Lists templates sorted newest first by created_at desc, id desc. [Email Templates] via GET /email_templates

Returns the account-owned template identified by ID, including its Liquid subject and bodies, declared variables, and timestamps. [Email Templates] via GET /email_templates/{id}

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 inbox_id so a reply can be routed back to the right inbox. Use filter[inbox_id] (repeatable) to narrow the result to specific inboxes. Because a thread ID can be delivered to multiple inboxes, each result is identified by its (inbox_id, id) pair. [Email Threads] via GET /email_threads

Returns a thread and a bounded page of its inbound and outbound messages, interleaved in chronological order. The inbox_id returned by the list endpoint is required because a thread ID can occur in multiple inboxes. Only messages matching that (inbox_id, thread_id) pair are returned. Threads outside the account return an opaque 404. [Email Threads] via GET /email_threads/{thread_id}

Offset pagination only (page[number] default 1, page[size] default 25, max 100). No sort/filter/cursor — ordering fixed desc created_at, desc id. Uses the shared QueryParser.parse_offset/1 — a malformed page (e.g. flat ?page=1 instead of ?page[number]=1) returns 400 (code 10015), consistent with GET /v2/email_blocks. meta includes total_pages. [Email Unsubscribe Groups] via GET /email_unsubscribe_groups

Returns the account-owned unsubscribe group identified by ID. [Email Unsubscribe Groups] via GET /email_unsubscribe_groups/{id}

Account + group scoped. Offset pagination only (page[number] default 1, page[size] default 25, max 100). No sort/filter/ cursor — ordering fixed desc created_at, desc id. Uses the shared QueryParser.parse_offset/1 — a malformed page returns 400 (code 10015), consistent with GET /v2/email_blocks. meta includes total_pages. Rows reuse the standard suppression shape (group_id set to this group). [Email Unsubscribe Groups] via GET /email_unsubscribe_groups/{id}/suppressions

Retrieves the current status and, once completed, validation results for a batch job. [Email Validations] via GET /email_validations/batch/{id}

Return the enterprises you own, paginated. The default page size is 20; the maximum is 250. [Enterprises] via GET /enterprises

Retrieve a single enterprise by id. Returns 404 if the id does not exist or does not belong to your account. [Enterprises] via GET /enterprises/{enterprise_id}

Return the DIRs (Display Identity Records) belonging to a single enterprise. Pagination is JSON:API style (page[number], page[size], max 250). Supports filter[] query params: filter[status], filter[display_name][contains], filter[call_reason][contains], plus the renewal-window filters filter[expiring_at][gte] / filter[expiring_at][lte] and the convenience filter[expiring_within_days] (mutually exclusive with the explicit gte/lte form). Sortable by created_at, updated_at, display_name, status, submitted_at, verified_at, expiring_at (prefix - for descending; default -created_at). [Display Identity Records] via GET /enterprises/{enterprise_id}/dir

Phone Number Reputation tracks how your outbound caller-IDs are perceived (spam risk, engagement, etc.) across the call-screening ecosystem. This endpoint reads the enterprise-level settings: whether the product is enabled, the refresh cadence, and the stored Letter of Authorization document id. Returns 404 if reputation has never been enabled for this enterprise. [Reputation] via GET /enterprises/{enterprise_id}/reputation

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. [Reputation] via GET /enterprises/{enterprise_id}/reputation/numbers

Retrieve one registered number with its latest reputation snapshot. The phone_number path parameter is in E.164 format and must be URL-encoded (e.g. %2B19493253498). [Reputation] via GET /enterprises/{enterprise_id}/reputation/numbers/{phone_number}

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. [Reputation] via GET /enterprises/{enterprise_id}/reputation/remediation

Retrieve the full detail of a remediation request, including current status, per-number results (once available), and submission metadata. [Reputation] via GET /enterprises/{enterprise_id}/reputation/remediation/{remediation_id}

This endpoint returns a list of your External Connections inside the 'data' attribute of the response. External Connections are used by Telnyx customers to seamless configure SIP trunking integrations with Telnyx Partners, through External Voice Integrations in Mission Control Portal. [External Connections] via GET /external_connections

Return the details of an existing External Connection inside the 'data' attribute of the response. [External Connections] via GET /external_connections/{id}

Returns the civic addresses and locations from Microsoft Teams. [External Connections] via GET /external_connections/{id}/civic_addresses

Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response. [External Connections] via GET /external_connections/{id}/civic_addresses/{address_id}

Returns a list of all active phone numbers associated with the given external connection. [External Connections] via GET /external_connections/{id}/phone_numbers

Return the details of a phone number associated with the given external connection. [External Connections] via GET /external_connections/{id}/phone_numbers/{phone_number_id}

Returns a list of your Releases for the given external connection. These are automatically created when you change the connection_id of a phone number that is currently on Microsoft Teams. [External Connections] via GET /external_connections/{id}/releases

Return the details of a Release request and its phone numbers. [External Connections] via GET /external_connections/{id}/releases/{release_id}

Returns a list of your Upload requests for the given external connection. [External Connections] via GET /external_connections/{id}/uploads

Return the details of an Upload request and its phone numbers. [External Connections] via GET /external_connections/{id}/uploads/{ticket_id}

Returns the count of all pending upload requests for the given external connection. [External Connections] via GET /external_connections/{id}/uploads/status

Retrieve a list of log messages for all external connections associated with your account. [External Connections] via GET /external_connections/log_messages

Retrieve a log message for an external connection associated with your account. [External Connections] via GET /external_connections/log_messages/{id}

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. [Programmable Fax Applications] via GET /fax_applications

Return the details of an existing Fax Application inside the 'data' attribute of the response. [Programmable Fax Applications] via GET /fax_applications/{id}

Retrieve a paginated list of faxes sent or received on your account. [Programmable Fax Commands] via GET /faxes

Returns the details of a single fax, including its current status. [Programmable Fax Commands] via GET /faxes/{id}

Returns a list of your FQDN connections. [FQDN Connections] via GET /fqdn_connections

Retrieves the details of an existing FQDN authentication strategy for a specific FQDN connection. [FQDN Connections] via GET /fqdn_connections/{fqdn_connection_id}/fqdn_authentication

Retrieves the details of an existing FQDN connection. [FQDN Connections] via GET /fqdn_connections/{id}

Get all FQDNs belonging to the user that match the given filters. [FQDNs] via GET /fqdns

Return the details regarding a specific FQDN. [FQDNs] via GET /fqdns/{id}

Returns the ports allowed for Global IP traffic, for use when configuring Global IP resources. [Global IPs] via GET /global_ip_allowed_ports

Retrieve health check metrics for your Global IP assignments. [Global IPs] via GET /global_ip_assignment_health

Returns a paginated list of your Global IP assignments, the links between Global IPs and the WireGuard peers that receive their traffic. [Global IPs] via GET /global_ip_assignments

Returns the details of a single Global IP assignment, including the Global IP and WireGuard peer it links. [Global IPs] via GET /global_ip_assignments/{id}

Retrieve usage metrics for your Global IP assignments. [Global IPs] via GET /global_ip_assignments_usage

Returns the health check types available for Global IPs, for use when creating Global IP health checks. [Global IPs] via GET /global_ip_health_check_types

Returns a paginated list of the Global IP health checks configured on your account. [Global IPs] via GET /global_ip_health_checks

Returns the details of a single Global IP health check, including its type and configuration. [Global IPs] via GET /global_ip_health_checks/{id}

Retrieve latency metrics measured for your Global IPs. [Global IPs] via GET /global_ip_latency

Returns the network protocols supported for Global IP traffic, for use when configuring Global IP resources. [Global IPs] via GET /global_ip_protocols

Retrieve usage metrics for your Global IPs. [Global IPs] via GET /global_ip_usage

Returns a paginated list of the Global IPs on your account, including each IP's address and configuration. [Global IPs] via GET /global_ips

Returns the details of a single Global IP, including its address and current configuration. [Global IPs] via GET /global_ips/{id}

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. [Voice Channels] via GET /inbound_channels

Get a paginated list of inexplicit number orders. [Inexplicit Number Orders] via GET /inexplicit_number_orders

Get an existing inexplicit number order by ID. [Inexplicit Number Orders] via GET /inexplicit_number_orders/{id}

Retrieve a single claim by id. Returns 404 if the claim does not exist or is not against a DIR you own. [Infringement Claims] via GET /infringement_claims/{claim_id}

Retrieve a list of all integration secrets configured by the user. [Integration Secrets] via GET /integration_secrets

Creates an inventory coverage request. If locality, npa or national_destination_code is used in groupBy, and no region or locality filters are used, the whole paginated set is returned. [Inventory Level] via GET /inventory_coverage

Returns a paginated list of your invoices, with support for sorting. [Billing] via GET /invoices

Retrieve a single invoice by its unique identifier. [Billing] via GET /invoices/{id}

Returns a paginated list of your IP-based SIP connections, with support for filtering and sorting. [IP Connections] via GET /ip_connections

Retrieves the details of an existing ip connection. [IP Connections] via GET /ip_connections/{id}

Get all IPs belonging to the user that match the given filters. [IPs] via GET /ips

Return the details regarding a specific IP. [IPs] via GET /ips/{id}

Retrieve the details and status of a previously created ledger billing group report. [Reports] via GET /ledger_billing_group_reports/{id}

Retrieves all MDR detailed report requests for the authenticated user [MDR Detailed Reports] via GET /legacy_reporting/batch_detail_records/messaging

Retrieves a specific MDR detailed report request by ID [MDR Detailed Reports] via GET /legacy_reporting/batch_detail_records/messaging/{id}

Retrieves all Speech to Text batch report requests for the authenticated user [Speech to Text Batch Reports] via GET /legacy/reporting/batch_detail_records/speech_to_text

Retrieves a specific Speech to Text batch report request by ID [Speech to Text Batch Reports] via GET /legacy/reporting/batch_detail_records/speech_to_text/{id}

Retrieves all CDR report requests for the authenticated user [CDR Reports] via GET /legacy_reporting/batch_detail_records/voice

Retrieves a specific CDR report request by ID [CDR Reports] via GET /legacy_reporting/batch_detail_records/voice/{id}

Retrieves all available fields that can be used in CDR reports [CDR Reports] via GET /legacy_reporting/batch_detail_records/voice/fields

Fetch all previous requests for MDR usage reports. [MDR Usage Reports] via GET /legacy_reporting/usage_reports/messaging

Returns a single MDR (Message Detail Record) usage report by its identifier, including its parameters and current status. [MDR Usage Reports] via GET /legacy_reporting/usage_reports/messaging/{id}

Retrieve a paginated list of telco data usage reports [Telco Data Usage Reports] via GET /legacy_reporting/usage_reports/number_lookup

Retrieve a specific telco data usage report by its ID [Telco Data Usage Reports] via GET /legacy_reporting/usage_reports/number_lookup/{id}

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. [Speech to text Usage Reports] via GET /legacy_reporting/usage_reports/speech_to_text

Fetch all previous requests for cdr usage reports. [CDR Usage Reports] via GET /legacy_reporting/usage_reports/voice

Returns a single CDR (Call Detail Record) usage report by its identifier, including its parameters and current status. [CDR Usage Reports] via GET /legacy_reporting/usage_reports/voice/{id}

Retrieve a list of all phone numbers using Channel Billing, grouped by Zone. [Voice Channels] via GET /list

Retrieve a list of phone numbers using Channel Billing for a specific Zone. [Voice Channels] via GET /list/{channel_zone_id}

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts. [Managed Accounts] via GET /managed_accounts

Display information about allocatable global outbound channels for the current user. Only usable by account managers. [Managed Accounts] via GET /managed_accounts/allocatable_global_outbound_channels

Retrieves the details of a single managed account. [Managed Accounts] via GET /managed_accounts/{id}

Returns a list of the media files stored on your account, with support for filtering. [Media Storage API] via GET /media

Returns the information about a stored media file. [Media Storage API] via GET /media/{media_name}

Returns a list of meeting sessions, optionally filtered by status. [Meeting Sessions] via GET /meeting_sessions

Retrieves a single meeting session by ID. A session that does not exist or that belongs to a different account both return 404. [Meeting Sessions] via GET /meeting_sessions/{id}

Returns a list of artifacts for a meeting session. [Meeting Session Artifacts] via GET /meeting_sessions/{id}/artifacts

Retrieves a single meeting session artifact by ID. [Meeting Session Artifacts] via GET /meeting_sessions/{id}/artifacts/{artifact_id}

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. [Meeting Session Data] via GET /meeting_sessions/{id}/events

Returns recordings for a meeting session. [Meeting Session Data] via GET /meeting_sessions/{id}/recordings

Returns transcript segments ordered by ascending seq. Default limit is 100 and maximum is 1,000. Continue with after=meta.next_after. A long-poll timeout returns 200 with empty data and meta.next_after: null; retain the cursor supplied to that request because null is not a replacement cursor. [Meeting Session Data] via GET /meeting_sessions/{id}/transcript

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. [Messages] via GET /messages/{id}

Retrieve all messages in a group MMS conversation by the group message ID. [Messages] via GET /messages/group/{message_id}

Generate a deeplink URL that can be used to start an RCS conversation with a specific agent. [RCS] via GET /messages/rcs_deeplinks/{agent_id}

Returns hosted-messaging orders for the authenticated account. Apply the documented filters and pagination parameters to narrow the result set. [Hosted Numbers] via GET /messaging_hosted_number_orders

Returns the current state, phone numbers, and required actions for the specified hosted-messaging order. [Hosted Numbers] via GET /messaging_hosted_number_orders/{id}

List all hosted numbers associated with the authenticated user. [Messaging] via GET /messaging_hosted_numbers

Retrieve a specific messaging hosted number by its ID or phone number. [Messaging] via GET /messaging_hosted_numbers/{id}

Returns processing status and results for a bulk messaging-settings update order. [Number Settings] via GET /messaging_numbers_bulk_updates/{order_id}

Returns a paginated list of opt-out blocks created when message recipients opt out. Supports filtering and optional redaction of recipient numbers. [Opt-Out Management] via GET /messaging_optouts

List high-level metrics for all messaging profiles belonging to the authenticated user. [Messaging] via GET /messaging_profile_metrics

Lists the messaging profiles owned by the authenticated account. Apply the documented filters and pagination parameters to narrow the result set. [Profiles] via GET /messaging_profiles

Returns the complete configuration of the specified messaging profile, including webhook and sender-selection settings. [Profiles] via GET /messaging_profiles/{id}

List all alphanumeric sender IDs associated with a specific messaging profile. [Messaging] via GET /messaging_profiles/{id}/alphanumeric_sender_ids

Get detailed metrics for a specific messaging profile, broken down by time interval. [Messaging] via GET /messaging_profiles/{id}/metrics

Returns the phone numbers currently associated with the specified messaging profile. [Profiles] via GET /messaging_profiles/{id}/phone_numbers

Returns the short codes currently associated with the specified messaging profile. [Profiles] via GET /messaging_profiles/{id}/short_codes

Returns the auto-response rules configured for the specified messaging profile. [Opt-Out Management] via GET /messaging_profiles/{profile_id}/autoresp_configs

Returns the matching criteria and response content for the specified auto-response rule. [Opt-Out Management] via GET /messaging_profiles/{profile_id}/autoresp_configs/{autoresp_cfg_id}

Returns RCS agents available to the authenticated account. [RCS] via GET /messaging/rcs/agents

Returns the configuration and current state of the specified RCS agent. [RCS] via GET /messaging/rcs/agents/{id}

Returns the RCS features supported by the specified recipient for the selected agent. [RCS] via GET /messaging/rcs/capabilities/{agent_id}/{phone_number}

Get a list of previously-submitted tollfree verification requests [Verification Requests] via GET /messaging_tollfree/verification/requests

Get a single verification request by its ID. [Verification Requests] via GET /messaging_tollfree/verification/requests/{id}

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. [Verification Requests] via GET /messaging_tollfree/verification/requests/{id}/status_history

Returns the URL domains available to the authenticated account for message URL shortening. [Messaging URL Domains] via GET /messaging_url_domains

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. Still, it's available so it can be used as a support resource that can be related to other resources or become a configuration option. [Mobile Network Operators] via GET /mobile_network_operators

Returns the messaging configuration for the specified mobile phone number. [Mobile Number Settings] via GET /mobile_phone_numbers/{id}/messaging

Returns mobile phone numbers with their current messaging configuration. [Mobile Number Settings] via GET /mobile_phone_numbers/messaging

Returns a paginated list of the mobile push credentials on your account, with support for filtering. [Push Credentials] via GET /mobile_push_credentials

Retrieves mobile push credential based on the given push_credential_id [Push Credentials] via GET /mobile_push_credentials/{push_credential_id}

List all locations and the interfaces that region supports [Coverage] via GET /network_coverage

Returns a paginated list of the private networks on your account, with support for filtering. [Networks] via GET /networks

Returns the details of a single network by its identifier. [Networks] via GET /networks/{id}

Returns the status of the default gateway configured on the specified network. [Networks] via GET /networks/{id}/default_gateway

Returns a paginated list of the interfaces attached to the specified network, with support for filtering. [Networks] via GET /networks/{id}/network_interfaces

Returns a paginated list of your notification channels, the destinations that receive notifications. [Notifications] via GET /notification_channels

Returns the details of a single notification channel by its identifier. [Notifications] via GET /notification_channels/{id}

Returns a list of your notifications events conditions. [Notifications] via GET /notification_event_conditions

Returns a list of your notifications events. [Notifications] via GET /notification_events

Returns a list of your notifications profiles. [Notifications] via GET /notification_profiles

Returns the details of a single notification profile by its identifier. [Notifications] via GET /notification_profiles/{id}

Returns a paginated list of your notification settings, which map notification event types to profiles and channels. [Notifications] via GET /notification_settings

Returns the details of a single notification setting by its identifier. [Notifications] via GET /notification_settings/{id}

Get a paginated list of number block orders. [Phone Number Block Orders] via GET /number_block_orders

Get an existing phone number block order. [Phone Number Block Orders] via GET /number_block_orders/{number_block_order_id}

Returns information about the provided phone number. [Number Lookup] via GET /number_lookup/{phone_number}

Get a list of phone numbers associated to orders. [Phone Number Orders] via GET /number_order_phone_numbers

Get an existing phone number in number order. [Phone Number Orders] via GET /number_order_phone_numbers/{number_order_phone_number_id}

Returns a paginated list of your phone number orders, with support for filtering. [Phone Number Orders] via GET /number_orders

Returns the details of an existing phone number order, including its status and the numbers included. [Phone Number Orders] via GET /number_orders/{number_order_id}

Gets a paginated list of phone number reservations. [Phone Number Reservations] via GET /number_reservations

Returns the details of a single phone number reservation, including its status and the reserved numbers. [Phone Number Reservations] via GET /number_reservations/{number_reservation_id}

Retrieve a paginated list of OAuth clients for the authenticated user [OAuth Clients] via GET /oauth_clients

Returns the details of a single OAuth client on your account by its ID. [OAuth Clients] via GET /oauth_clients/{id}

Retrieve a paginated list of OAuth grants for the authenticated user [OAuth Grants] via GET /oauth_grants

Returns the details of a single OAuth grant on your account by its ID. [OAuth Grants] via GET /oauth_grants/{id}

Retrieve the JSON Web Key Set for token verification [OAuth Protocol] via GET /oauth/jwks

Returns a list of the users in your organization. [Organization Users] via GET /organizations/users

Returns the details of a user in your organization, optionally including the groups the user belongs to. [Organization Users] via GET /organizations/users/{id}

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. [Organization Users] via GET /organizations/users/users_groups_report

Retrieve a paginated list of over-the-air (OTA) update operations for your SIM cards. [OTA updates] via GET /ota_updates

This API returns the details of an Over the Air (OTA) update. [OTA updates] via GET /ota_updates/{id}

Get all outbound voice profiles belonging to the user that match the given filters. [Outbound Voice Profiles] via GET /outbound_voice_profiles

Retrieves the details of an existing outbound voice profile. [Outbound Voice Profiles] via GET /outbound_voice_profiles/{id}

Returns the payment auto recharge preferences. [AutoRechargePreferences] via GET /payment/auto_recharge_prefs

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. [Phone Number Blocks Background Jobs] via GET /phone_number_blocks/jobs

Returns the status and details of the phone-number-block background job identified by id. [Phone Number Blocks Background Jobs] via GET /phone_number_blocks/jobs/{id}

Returns phone numbers associated with the account. Results support pagination, sorting, and filters for number attributes, status, source, connections, billing groups, emergency addresses, tags, and customer references. [Phone Number Configurations] via GET /phone_numbers

Returns the detailed configuration and current state of the phone number identified by id. [Phone Number Configurations] via GET /phone_numbers/{id}

Returns the messaging product and messaging-profile assignment for the specified phone number. [Number Settings] via GET /phone_numbers/{id}/messaging

Returns the specified phone number together with its current voice configuration. [Phone Number Configurations] via GET /phone_numbers/{id}/voice

Returns the voicemail settings for a phone number [Voicemail] via GET /phone_numbers/{phone_number_id}/voicemail

Returns CSV export jobs created for account phone numbers, including each export's current status and pagination metadata. [CSV Downloads] via GET /phone_numbers/csv_downloads

Returns the current status and download details for the CSV export identified by id. [CSV Downloads] via GET /phone_numbers/csv_downloads/{id}

Returns background jobs that operate on phone numbers. Results can be filtered by job type and sorted by creation time, and include pagination metadata. [Bulk Phone Number Operations] via GET /phone_numbers/jobs

Returns the status and details of the phone-number background job identified by id. [Bulk Phone Number Operations] via GET /phone_numbers/jobs/{id}

Returns phone numbers with their current messaging product and messaging-profile assignments. [Number Settings] via GET /phone_numbers/messaging

Returns the regulatory requirements that apply to the supplied comma-separated phone numbers. The response includes the matching requirement records and pagination metadata. [Regulatory Requirements] via GET /phone_numbers_regulatory_requirements

List phone numbers, This endpoint is a lighter version of the /phone_numbers endpoint having higher performance and rate limit. [Phone Number Configurations] via GET /phone_numbers/slim

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. [Phone Number Configurations] via GET /phone_numbers/voice

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. [Porting Orders] via GET /porting/events

Returns the details of a single porting event, including its type and payload. [Porting Orders] via GET /porting/events/{id}

Returns a paginated list of your LOA (Letter of Authorization) configurations. LOA configurations customize the company details and branding used on generated LOA documents. [Porting Orders] via GET /porting/loa_configurations

Returns the details of a single LOA (Letter of Authorization) configuration by its identifier. [Porting Orders] via GET /porting/loa_configurations/{id}

Returns a paginated list of your porting orders. Supports filtering and sorting, and can optionally include the phone numbers attached to each order. [Porting Orders] via GET /porting_orders

Retrieves the details of an existing porting order. [Porting Orders] via GET /porting_orders/{id}

Returns a list of your porting activation jobs. [Porting Orders] via GET /porting_orders/{id}/activation_jobs

Returns the details of a single activation job for the porting order, including its current status. [Porting Orders] via GET /porting_orders/{id}/activation_jobs/{activationJobId}

Returns a list of additional documents for a porting order. [Porting Orders] via GET /porting_orders/{id}/additional_documents

Returns a list of allowed FOC dates for a porting order. [Porting Orders] via GET /porting_orders/{id}/allowed_foc_windows

Returns a list of all comments of a porting order. [Porting Orders] via GET /porting_orders/{id}/comments

Returns a list of all requirements based on country/number type for this porting order. [Porting Orders] via GET /porting_orders/{id}/requirements

Retrieve the associated V1 sub_request_id and port_request_id [Porting Orders] via GET /porting_orders/{id}/sub_request

Returns a list of verification codes for a porting order. [Porting Orders] via GET /porting_orders/{id}/verification_codes

Returns a list of action requirements for a specific porting order. [Porting Orders] via GET /porting_orders/{porting_order_id}/action_requirements

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. [Porting Orders] via GET /porting_orders/{porting_order_id}/associated_phone_numbers

Returns a list of all phone number blocks of a porting order. [Porting Orders] via GET /porting_orders/{porting_order_id}/phone_number_blocks

Returns a list of all phone number extensions of a porting order. [Porting Orders] via GET /porting_orders/{porting_order_id}/phone_number_extensions

Returns a list of all possible exception types for a porting order. [Porting Orders] via GET /porting_orders/exception_types

Returns a list of phone number configurations paginated. [Porting Orders] via GET /porting_orders/phone_number_configurations

Returns a list of your porting phone numbers. [Porting Orders] via GET /porting_phone_numbers

List the reports generated about porting operations. [Porting Orders] via GET /porting/reports

Returns the details of a previously requested porting report, including its status and parameters. [Porting Orders] via GET /porting/reports/{id}

Returns the list of UK carriers available for porting, for use when preparing porting orders for UK numbers. [Porting Orders] via GET /porting/uk_carriers

Returns the portout requests according to filters [Number Portout] via GET /portouts

Returns the portout request based on the ID provided [Number Portout] via GET /portouts/{id}

Returns a list of comments for a portout request. [Number Portout] via GET /portouts/{id}/comments

List every supporting documents for a portout request. [Number Portout] via GET /portouts/{id}/supporting_documents

Returns a paginated list of port-out events on your account, such as status changes on port-out requests, with support for filtering. [Number Portout] via GET /portouts/events

Returns the details of a single port-out event, including its type and payload. [Number Portout] via GET /portouts/events/{id}

Given a port-out ID, list rejection codes that are eligible for that port-out [Number Portout] via GET /portouts/rejections/{portout_id}

List the reports generated about port-out operations. [Number Portout] via GET /portouts/reports

Returns the details of a previously requested port-out report, including its status and parameters. [Number Portout] via GET /portouts/reports/{id}

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}. [Pricing] via GET /pricing/products

Returns pricing entries for a single product. Most products return standard rate entries with fields like rate, unit, country_iso, direction, and tiers. Inference products return model-specific fields (model, input_rate, output_rate, cached_input_rate) with tiered pricing. Some products use rate decks (pricing_type: rate_deck) where rates are determined dynamically. [Pricing] via GET /pricing/products/{slug}

Get all Private Wireless Gateways belonging to the user. [Private Wireless Gateways] via GET /private_wireless_gateways

Retrieve information about a Private Wireless Gateway. [Private Wireless Gateways] via GET /private_wireless_gateways/{id}

List all pronunciation dictionaries for the authenticated organization. Results are paginated using offset-based pagination. [Pronunciation Dictionaries] via GET /pronunciation_dicts

Retrieve a single pronunciation dictionary by ID. [Pronunciation Dictionaries] via GET /pronunciation_dicts/{id}

Returns a paginated list of the public internet gateways on your account, with support for filtering. [Public Internet Gateways] via GET /public_internet_gateways

Returns the details of a single public internet gateway by its identifier. [Public Internet Gateways] via GET /public_internet_gateways/{id}

List all queues for the authenticated user. [Queue Commands] via GET /queues

Returns the details of an existing call queue, including its current configuration. [Queue Commands] via GET /queues/{queue_name}

Retrieve the list of calls in an existing queue [Queue Commands] via GET /queues/{queue_name}/calls

Retrieve an existing call from an existing queue [Queue Commands] via GET /queues/{queue_name}/calls/{call_control_id}

Lists RCS agents owned by the authenticated organization, optionally filtered by brand. [RCS Agents] via GET /rcs/agents

Retrieves an RCS agent, section statuses, test devices, carrier approvals, and provider capabilities. [RCS Agents] via GET /rcs/agents/{id}

Lists carrier approval records for an RCS agent. The provider may expose per-carrier, hub-level, or bot-level approval status. [RCS Agents] via GET /rcs/agents/{id}/carrier_approvals

Lists test devices attached to an RCS agent. [RCS Agents] via GET /rcs/agents/{id}/test_devices

Lists RCS brands owned by the authenticated organization. [RCS Brands] via GET /rcs/brands

Retrieves an RCS brand and its current lifecycle status. [RCS Brands] via GET /rcs/brands/{id}

Returns a list of your recording transcriptions. [Call Recordings] via GET /recording_transcriptions

Retrieves the details of an existing recording transcription. [Call Recordings] via GET /recording_transcriptions/{recording_transcription_id}

Returns a paginated list of your call recordings, with support for filtering to locate specific recordings. [Call Recordings] via GET /recordings

Retrieves the details of an existing call recording. [Call Recordings] via GET /recordings/{recording_id}

List all regions and the interfaces that region supports [Regions] via GET /regions

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. [Regulatory Requirements] via GET /regulatory_requirements

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. [CDR Usage Reports] via GET /reports/cdr_usage_reports/sync

Fetch all messaging usage reports. Usage reports are aggregated messaging data for specified time period and breakdown [MDR Usage Reports] via GET /reports/mdr_usage_reports

Fetch a single messaging usage report by id [MDR Usage Reports] via GET /reports/mdr_usage_reports/{id}

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. [MDR Usage Reports] via GET /reports/mdr_usage_reports/sync

Returns message detail records (MDRs) matching the provided criteria, such as date range, direction, status, and message type. [MDR Detail Reports] via GET /reports/mdrs

Returns wireless detail records (WDRs) matching the provided criteria, such as date range, SIM card, IMSI, or phone number, with pagination and sorting. [WDR Detail Reports] via GET /reports/wdrs

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

Convenience alias for GET /v2/enterprises/{enterprise_id}/reputation/numbers/{phone_number}. [Reputation] via GET /reputation/numbers/{phone_number}

Returns regulatory requirement groups for the account. Results can be filtered by country, number type, action, approval status, and customer reference. [Requirement Groups] via GET /requirement_groups

Returns the regulatory requirement group identified by id, including its requirement values and current approval status. [Requirement Groups] via GET /requirement_groups/{id}

List all requirement types ordered by created_at descending [Requirement Types] via GET /requirement_types

Returns the details of a single requirement type by its identifier, describing a kind of documentation needed for regulatory purposes. [Requirement Types] via GET /requirement_types/{id}

List all requirements with filtering, sorting, and pagination [Requirements] via GET /requirements

Returns a single document requirement record by its identifier, describing the documentation needed for number-related actions. A specific requirement version can be requested. [Requirements] via GET /requirements/{id}

Returns a paginated list of room compositions. Filter compositions by creation date, room session, or processing status. [Room Compositions] via GET /room_compositions

Returns the composition identified by room_composition_id, including its room and session, processing status, media details, video layout, lifecycle timestamps, and download URL. [Room Compositions] via GET /room_compositions/{room_composition_id}

Returns a paginated list of room participants across sessions. Filter participants by session, join, update, or leave date and by participant context. [Room Participants] via GET /room_participants

Returns the participant identified by room_participant_id, including its session, context, and join, update, and leave timestamps. [Room Participants] via GET /room_participants/{room_participant_id}

Returns a paginated list of room recordings. Filter recordings by room, session, participant, recording type, status, duration, or start and end dates. [Room Recordings] via GET /room_recordings

Returns the recording identified by room_recording_id, including its room, session, participant, status, media details, lifecycle timestamps, and download URL. [Room Recordings] via GET /room_recordings/{room_recording_id}

Returns a paginated list of room sessions across the account. Filter sessions by room, creation, update, or end date and active status, and use include_participants to include participant records. [Room Sessions] via GET /room_sessions

Returns the room session identified by room_session_id, including its room, active status, and lifecycle timestamps. Use include_participants to include its participant records. [Room Sessions] via GET /room_sessions/{room_session_id}

Returns a paginated list of participants for the specified room session. Filter participants by join, update, or leave date and by participant context. [Room Sessions] via GET /room_sessions/{room_session_id}/participants

Returns a paginated list of rooms. Filter the results by creation or update date and unique name, and use include_sessions to include each room’s sessions. [Rooms] via GET /rooms

Returns the room identified by room_id, including its participant limit, recording and webhook configuration, and active session identifier. Use include_sessions to include its sessions. [Rooms] via GET /rooms/{room_id}

Returns a paginated list of sessions for the specified room. Filter sessions by creation, update, or end date and active status, and use include_participants to include participant records. [Rooms] via GET /rooms/{room_id}/sessions

Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages. [Session Analysis] via GET /session_analysis/{record_type}/{event_id}

Returns all available record types and supported query parameters for session analysis. [Session Analysis] via GET /session_analysis/metadata

Returns detailed metadata for a specific record type, including relationships and examples. [Session Analysis] via GET /session_analysis/metadata/{record_type}

Returns the results of the various black box tests [SETI Observability] via GET /seti/black_box_test_results

Returns short codes owned by the authenticated account. Apply the documented filters and pagination parameters to narrow the result set. [Short Codes] via GET /short_codes

Returns the messaging configuration and assignment details for the specified short code. [Short Codes] via GET /short_codes/{id}

This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters. [SIM Card Actions] via GET /sim_card_actions

This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation. [SIM Card Actions] via GET /sim_card_actions/{id}

Lists a paginated collection of SIM card data usage notifications. It enables exploring the collection using specific filters. [SIM Cards] via GET /sim_card_data_usage_notifications

Get a single SIM Card Data Usage Notification. [SIM Cards] via GET /sim_card_data_usage_notifications/{id}

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. [SIM Card Group Actions] via GET /sim_card_group_actions

This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation. [SIM Card Group Actions] via GET /sim_card_group_actions/{id}

Get all SIM card groups belonging to the user that match the given filters. [SIM Card Groups] via GET /sim_card_groups

Returns the details regarding a specific SIM card group [SIM Card Groups] via GET /sim_card_groups/{id}

Get all SIM card orders according to filters. [SIM Card Orders] via GET /sim_card_orders

Returns the details of a single SIM card order by its ID, including its status. [SIM Card Orders] via GET /sim_card_orders/{id}

Get all SIM cards belonging to the user that match the given filters. [SIM Cards] via GET /sim_cards

Returns the details regarding a specific SIM card. [SIM Cards] via GET /sim_cards/{id}

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. [SIM Cards] via GET /sim_cards/{id}/activation_code

It returns the device details where a SIM card is currently being used. [SIM Cards] via GET /sim_cards/{id}/device_details

It returns the public IP requested for a SIM card. [SIM Cards] via GET /sim_cards/{id}/public_ip

This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes. [SIM Cards] via GET /sim_cards/{id}/wireless_connectivity_logs

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. The endpoint supports three credential types, selected with the credential_type query parameter. Each type is keyed by a different identifier: | credential_type | Keyed by | Use case | | --- | --- | --- | | uac_external_credential | connection_id | A UAC (SIP attach) connection that registers to an external PBX. | | telephony_credential | username | An ephemeral, one-time-use telephony credential. | | sip_credential_connection | username | A traditional SIP credential connection that registers directly to Telnyx. | The authenticated account is taken from your API key; you can only read the registration status of connections and credentials your account owns. [UAC Connections] via GET /sip_registration_status

Returns details of a stored SIPREC connector. [SIPREC Connectors] via GET /siprec_connectors/{connector_name}

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. * file_based — file-based transcription via /ai/audio/transcriptions. * in_call — live call transcription via Call Control transcription_start. * ai_assistant — STT configured on a Call Control AI Assistant via voice-assistant TranscriptionConfig (covers both live-streaming and non-streaming/batch models). Use this endpoint to discover which (provider, model) combinations are available for the surface you need, and which language codes each accepts. auto in a languages array indicates the provider performs language detection. [Speech To Text Capabilities] via GET /speech-to-text/providers

Returns the stored certificate detail of a bucket, if applicable. [Bucket SSL Certificate] via GET /storage/buckets/{bucketName}/ssl_certificate

Returns the detail on API usage on a bucket of a particular time period, group by method category. [Bucket Usage] via GET /storage/buckets/{bucketName}/usage/api

Returns the amount of storage space and number of files a bucket takes up. [Bucket Usage] via GET /storage/buckets/{bucketName}/usage/storage

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. [cloudfs filesystems] via GET /storage/cloudfs

Retrieves a CloudFS filesystem by its ID. The returned meta_url 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. [cloudfs filesystems] via GET /storage/cloudfs/{id}

Lists the KV namespaces for the authenticated user's organization. Results use page-based pagination (page[number]/page[size]). [kv namespaces] via GET /storage/kvs

Retrieves a KV namespace by its ID, including its provisioning status. [kv namespaces] via GET /storage/kvs/{id}

Lists the keys in a namespace. Returns key names and metadata only, never values. Results are paginated with limit and an opaque cursor. [kv keys] via GET /storage/kvs/{id}/keys

List the external storage providers and regions supported as migration sources. [Data Migration] via GET /storage/migration_source_coverage

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. [Data Migration] via GET /storage/migration_sources

Retrieve the details of a specific migration source. [Data Migration] via GET /storage/migration_sources/{id}

Retrieve a list of the storage migrations on your account. [Data Migration] via GET /storage/migrations

Retrieve the details and status of a specific storage migration. [Data Migration] via GET /storage/migrations/{id}

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. [sql databases] via GET /storage/sqldbs

Retrieves a SQL database by its ID, including its provisioning status. [sql databases] via GET /storage/sqldbs/{id}

Get a paginated list of sub number orders. [Phone Number Orders] via GET /sub_number_orders

Returns the details of an existing sub number order, with support for filtering. [Phone Number Orders] via GET /sub_number_orders/{sub_number_order_id}

Get the status and details of a sub number orders report. [Phone Number Orders] via GET /sub_number_orders_report/{report_id}

Download the CSV file for a completed sub number orders report. The report status must be 'success' before the file can be downloaded. [Phone Number Orders] via GET /sub_number_orders_report/{report_id}/download

Returns a paginated list of the on-demand telephony credentials on your account, with support for filtering. [Credentials] via GET /telephony_credentials

Get the details of an existing On-demand Credential. [Credentials] via GET /telephony_credentials/{id}

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. Results are paginated with the standard page[number] / page[size] parameters; the response uses the standard {data, meta} JSON:API envelope. By default this returns agreements for all products the user has agreed to. Pass the product_type query parameter to scope the result to a single product. [Terms of Service] via GET /terms_of_service/agreements

Retrieve a single ToS agreement record. Returns 404 if the agreement does not exist or does not belong to the authenticated user. [Terms of Service] via GET /terms_of_service/agreements/{agreement_id}

Returns the available Terms of Service agreements (product, current version, terms URL, effective date). Omit product_type to return all products; pass it to scope to one. [Terms of Service] via GET /terms_of_service/info

Returns whether the authenticated user has agreed to the current Terms of Service for the product given by product_type. Used during onboarding to decide whether to prompt the user with the ToS dialog before continuing. agreement_required: true means the user has not yet agreed (or has agreed to an outdated version) and must agree before using that product's endpoints. [Terms of Service] via GET /terms_of_service/status

Returns multiple call resouces for an account. This endpoint is eventually consistent. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Calls

Returns an individual call identified by its CallSid. This endpoint is eventually consistent. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Calls/{call_sid}

Returns recordings for a call identified by call_sid. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Calls/{call_sid}/Recordings.json

Returns a paginated list of conference resources for the account, with support for filtering by friendly name, status, and creation or update dates. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Conferences

Returns a single conference resource for the account by its ConferenceSid. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}

Returns the list of participants currently in the specified conference. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants

Returns a single conference participant resource by call SID or participant label. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Participants/{call_sid_or_participant_label}

Returns the list of recordings made for the specified conference. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings

Returns recordings for a conference identified by conference_sid. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Conferences/{conference_sid}/Recordings.json

Returns a paginated list of queue resources for the account, with support for filtering by creation or update dates. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Queues

Returns a single queue resource for the account by its QueueSid. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Queues/{queue_sid}

Returns recording resource identified by recording id. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Recordings/{recording_sid}.json

Returns multiple recording resources for an account. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Recordings.json

Returns the recording transcription resource identified by its ID. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Transcriptions/{recording_transcription_sid}.json

Returns multiple recording transcription resources for an account. [TeXML REST Commands] via GET /texml/Accounts/{account_sid}/Transcriptions.json

Returns a list of your TeXML Applications. [TeXML Applications] via GET /texml_applications

Retrieves the details of an existing TeXML Application. [TeXML Applications] via GET /texml_applications/{id}

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. Supported providers: aws, telnyx, azure, murfai, minimax, rime, resemble, elevenlabs, xai, humain. Connection flow: 1. Open WebSocket with query parameters specifying provider, voice, and model. 2. Send an initial handshake message {"text": " "} (single space) with optional voice_settings to initialize the session. 3. Send text messages as {"text": "Hello world"}. 4. Receive audio chunks as JSON frames with base64-encoded audio. 5. A final frame with isFinal: true indicates the end of audio for the current text. To interrupt and restart synthesis mid-stream, send {"force": true} — the current worker is stopped and a new one is started. Note: The Telnyx Ultra model is not available over WebSocket. Use the HTTP POST /text-to-speech/speech endpoint instead. [Text To Speech Commands] via GET /text-to-speech/speech

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, Resemble) require an API key to list voices. [Text To Speech Commands] via GET /text-to-speech/voices

Get all traffic policy profiles belonging to the user that match the given filters. [Traffic Policy Profiles] via GET /traffic_policy_profiles

Returns the details regarding a specific traffic policy profile. [Traffic Policy Profiles] via GET /traffic_policy_profiles/{id}

Get all available PCEF services that can be used in traffic policy profiles. [Traffic Policy Profiles] via GET /traffic_policy_profiles/services

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. Use UAC when your PBX doesn’t support outbound SIP registration or you need Telnyx to maintain the registration. [UAC Connections] via GET /uac_connections

Retrieves the details of an existing UAC connection. [UAC Connections] via GET /uac_connections/{id}

Get Telnyx usage data by product, broken out by the specified dimensions [Usage Reports (BETA)] via GET /usage_reports

Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions [Usage Reports (BETA)] via GET /usage_reports/options

Returns a paginated list of your user addresses, with support for filtering and sorting. [UserAddresses] via GET /user_addresses

Retrieves the details of an existing user address. [UserAddresses] via GET /user_addresses/{id}

Returns the user tags defined on your account, with support for filtering. Tags help organize resources such as phone numbers. [User Tags] via GET /user_tags

Retrieve a paginated list of mobile phone numbers on your account. [Mobile Phone Numbers] via GET /mobile_phone_numbers

Retrieve the details of a specific mobile phone number. [Mobile Phone Numbers] via GET /mobile_phone_numbers/{id}

Retrieve a paginated list of mobile voice connections on your account. [Mobile Voice Connections] via GET /mobile_voice_connections

Retrieve the details of a specific mobile voice connection. [Mobile Voice Connections] via GET /mobile_voice_connections/{id}

Returns the WhatsApp user-data settings associated with the authenticated Telnyx account. [Whatsapp Business Accounts] via GET /whatsapp/user_data

Returns a paginated list of verifications associated with the specified phone number. [Verify] via GET /verifications/by_phone_number/{phone_number}

Returns the verification identified by ID, including its channel, phone number, Verify profile, timeout, and current status. [Verify] via GET /verifications/{verification_id}

Gets a paginated list of Verified Numbers. [Verified Numbers] via GET /verified_numbers

Retrieve the details of a verified number on your account. [Verified Numbers] via GET /verified_numbers/{phone_number}

Gets a paginated list of Verify profiles. [Verify] via GET /verify_profiles

Returns the details of a single Verify profile by its ID, including its verification channel configuration. [Verify] via GET /verify_profiles/{verify_profile_id}

List all Verify profile message templates. [Verify] via GET /verify_profiles/templates

Returns a paginated list of the virtual cross connects on your account, with support for filtering. [Virtual Cross Connects] via GET /virtual_cross_connects

Returns the details of a single virtual cross connect by its identifier. [Virtual Cross Connects] via GET /virtual_cross_connects/{id}

List Virtual Cross Connects Cloud Coverage. This endpoint shows which cloud regions are available for the location_code your Virtual Cross Connect will be provisioned in. [Virtual Cross Connects] via GET /virtual_cross_connects_coverage

Returns a paginated list of voice clones belonging to the authenticated account. [Voice Clones] via GET /voice_clones

Returns a paginated list of voice designs belonging to the authenticated account. [Voice Designs] via GET /voice_designs

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. [Voice Designs] via GET /voice_designs/{id}

Returns paginated raw call report stats JSON payloads stored for the authenticated user. The user is derived from Telnyx authentication, not from request parameters. [Voice SDK Stats] via GET /voice_sdk_call_reports

Returns raw call report stats JSON payloads stored for the authenticated user and call_id. The user is derived from Telnyx authentication, not from request parameters. [Voice SDK Stats] via GET /voice_sdk_call_reports/{call_id}

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. [Research] via GET /web_search/research/{task_id}

Lists webhook_deliveries for the authenticated user [Webhooks] via GET /webhook_deliveries

Provides webhook_delivery debug data, such as timestamps, delivery status and attempts. [Webhooks] via GET /webhook_deliveries/{id}

OAuth 2.0 Authorization Server Metadata (RFC 8414) [OAuth Discovery] via GET /.well-known/oauth-authorization-server

OAuth 2.0 Protected Resource Metadata for resource discovery [OAuth Discovery] via GET /.well-known/oauth-protected-resource

Retrieve a list of the WhatsApp Business Accounts (WABAs) connected to your Telnyx account. [Whatsapp Business Accounts] via GET /whatsapp/business_accounts

Retrieve the details of a specific WhatsApp Business Account. [Whatsapp Business Accounts] via GET /whatsapp/business_accounts/{id}

List the phone numbers associated with a WhatsApp Business Account. [Whatsapp Business Accounts] via GET /whatsapp/business_accounts/{id}/phone_numbers

Retrieve the settings of a WhatsApp Business Account. [Whatsapp Business Accounts] via GET /whatsapp/business_accounts/{id}/settings

Retrieve the WhatsApp message templates for your WhatsApp Business Accounts. [Whatsapp Message Templates] via GET /whatsapp/message_templates

Retrieve a specific WhatsApp message template by its ID. [Whatsapp Message Templates] via GET /whatsapp/message_templates/{id}

Retrieve a list of the phone numbers registered for WhatsApp on your account. [Whatsapp Phone Numbers] via GET /whatsapp/phone_numbers

Retrieve the WhatsApp calling settings for a phone number. [Whatsapp Phone Numbers] via GET /whatsapp/phone_numbers/{phone_number}/calling_settings

Returns whether the 24-hour conversation window is currently open for a given source/destination pair. If window_active is false, only template messages may be sent. [Whatsapp Phone Numbers] via GET /whatsapp/phone_numbers/{phone_number}/conversation_window

Retrieve the conversational components configuration for a WhatsApp phone number. [Whatsapp Phone Numbers] via GET /whatsapp/phone_numbers/{phone_number}/conversational_components

Retrieve the WhatsApp business profile associated with a phone number. [Whatsapp Phone Numbers] via GET /whatsapp/phone_numbers/{phone_number}/profile

Retrieve the profile photo of a WhatsApp phone number. [Whatsapp Phone Numbers] via GET /whatsapp/phone_numbers/{phone_number}/profile/photo

Returns a paginated list of the WireGuard interfaces on your account, with support for filtering. [WireGuard Interfaces] via GET /wireguard_interfaces

Returns the details of a single WireGuard interface by its identifier. [WireGuard Interfaces] via GET /wireguard_interfaces/{id}

Returns a paginated list of your WireGuard peers, with support for filtering. [WireGuard Interfaces] via GET /wireguard_peers

Returns the details of a single WireGuard peer by its identifier. [WireGuard Interfaces] via GET /wireguard_peers/{id}

Retrieve Wireguard config template for Peer [WireGuard Interfaces] via GET /wireguard_peers/{id}/config

Retrieve all wireless blocklist values for a given blocklist type. [Wireless Blocklists] via GET /wireless_blocklist_values

Get all Wireless Blocklists belonging to the user. [Wireless Blocklists] via GET /wireless_blocklists

Retrieve information about a Wireless Blocklist. [Wireless Blocklists] via GET /wireless_blocklists/{id}

Returns the WDR Reports that match the given parameters. [Reporting] via GET /wireless/detail_records_reports

Returns a single Wireless Detail Record (WDR) report by its identifier, including its parameters and current status. [Reporting] via GET /wireless/detail_records_reports/{id}

Retrieve all wireless regions for the given product. [Wireless Regions] via GET /wireless/regions

Update campaign details by campaignId. Please note: Only webhook urls are editable. [Shared Campaigns] via PATCH /10dlc/partner_campaigns/{campaignId}

Updates the requirement-group configuration for the specified advanced number order. The response contains the updated advanced order. [Advanced Number Orders] via PATCH /advanced_orders/{advanced-order-id}/requirement_group

Updates a collection's metadata (name and/or description). Sources and settings are managed through their own sub-resources. [AI Collections] via PATCH /ai/collections/{uuid}

Partially updates the collection's retrieval settings. [AI Collections] via PATCH /ai/collections/{uuid}/settings

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. [Missions] via PATCH /ai/missions/{mission_id}/runs/{run_id}

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. [Missions] via PATCH /ai/missions/{mission_id}/runs/{run_id}/plan/steps/{step_id}

Update the configuration of an existing AI tool. [Assistants] via PATCH /ai/tools/{tool_id}

Updates settings of an existing authentication provider. [Authentication Providers] via PATCH /authentication_providers/{id}

Update the properties of an existing billing group. [Billing Groups] via PATCH /billing_groups/{id}

Updates settings of an existing call control application. [Call Control Applications] via PATCH /call_control_applications/{id}

Marks the specified comment as read. The response contains the updated read state for the comment. [Phone Number Orders] via PATCH /comments/{id}/read

Update properties of a conference participant. [Conference Commands] via PATCH /conferences/{id}/participants/{participant_id}

Updates settings of an existing credential connection. [Credential Connections] via PATCH /credential_connections/{id}

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/{dir_id}/submit explicitly. A verified DIR can also be edited in place: a PATCH that changes any value returns the DIR to draft and branded delivery stops until you re-submit and the DIR is approved again, while a PATCH that changes nothing (an empty body or values identical to the current ones) leaves the DIR verified, so idempotent retries are safe. DIRs in any other status (submitted, in_review, expired, infringement_claimed, permanently_rejected) cannot be edited. [Display Identity Records] via PATCH /dir/{dir_id}

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. The phone number and timezone may only be changed while a scheduled call has not yet been dialed; if a call is in progress or all attempts are complete, those fields are locked. Changing the timezone reschedules any pending call into the new local calling window. [DIR References] via PATCH /dir/{dir_id}/references/{ref_type}/{slot}

Updates the specified document's attributes and returns the updated document. [Documents] via PATCH /documents/{id}

Update a webhook's URL and/or event subscription. A webhook is bound to its domain — domain_id is not mutable. [Email Webhooks] via PATCH /email_domains/{domain_id}/webhooks/{id}

Updates mutable settings for an existing email domain, including inbound delivery and tracking configuration. Shared domains are read-only for non-owner accounts. [Email Domains] via PATCH /email_domains/{id}

Identical to PUT; both apply a partial update to the supplied fields. [Email Drafts] via PATCH /email_inboxes/{inbox_id}/drafts/{draft_id}

Updates the explicit read state of an account-scoped inbound message. Set read_at 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. [Email Inboxes] via PATCH /email_inboxes/{inbox_id}/messages/{message_id}

Updates one or more fields of the specified email template and returns the updated template. [Email Templates] via PATCH /email_templates/{id}

Partial update (only name / description). PUT is not routed. [Email Unsubscribe Groups] via PATCH /email_unsubscribe_groups/{id}

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. A request made while the status is pending is rejected with 400 Bad Request. [Reputation] via PATCH /enterprises/{enterprise_id}/reputation/frequency

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. [Reputation] via PATCH /enterprises/{enterprise_id}/reputation/loa

Updates settings of an existing External Connection based on the parameters of the request. [External Connections] via PATCH /external_connections/{id}

Update the static emergency address assigned to a specific location of an external connection. [External Connections] via PATCH /external_connections/{id}/locations/{location_id}

Asynchronously update settings of the phone number associated with the given external connection. [External Connections] via PATCH /external_connections/{id}/phone_numbers/{phone_number_id}

Updates settings of an existing Fax Application based on the parameters of the request. [Programmable Fax Applications] via PATCH /fax_applications/{id}

Updates the FQDN authentication strategy for a specific FQDN connection. [FQDN Connections] via PATCH /fqdn_connections/{fqdn_connection_id}/fqdn_authentication

Updates settings of an existing FQDN connection. [FQDN Connections] via PATCH /fqdn_connections/{id}

Updates the details of the specified FQDN record and returns the updated FQDN. [FQDNs] via PATCH /fqdns/{id}

Updates the specified Global IP assignment with the provided fields and returns the updated assignment. [Global IPs] via PATCH /global_ip_assignments/{id}

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. [Voice Channels] via PATCH /inbound_channels

Updates settings of an existing IP connection. [IP Connections] via PATCH /ip_connections/{id}

Updates the details of the specified IP record and returns the updated IP. [IPs] via PATCH /ips/{id}

Updates the specified managed account's attributes and returns the updated account. [Managed Accounts] via PATCH /managed_accounts/{id}

Update the amount of allocatable global outbound channels allocated to a specific managed account. [Managed Accounts] via PATCH /managed_accounts/{id}/update_global_channel_limit

Updates mutable properties of a meeting session. Only sessions in the scheduled state can be updated; any other state returns 409 with the invalid_state error code. All request fields are optional, and an empty object is a valid no-op update. [Meeting Sessions] via PATCH /meeting_sessions/{id}

Update the messaging settings for a hosted number. [Messaging] via PATCH /messaging_hosted_numbers/{id}

Updates the supplied settings on the specified messaging profile. Settings omitted from the request remain unchanged. [Profiles] via PATCH /messaging_profiles/{id}

Updates the supplied configuration fields on the specified RCS agent. [RCS] via PATCH /messaging/rcs/agents/{id}

Update an existing tollfree verification request. This is particularly useful when there are pending customer actions to be taken. [Verification Requests] via PATCH /messaging_tollfree/verification/requests/{id}

Updates the specified network's attributes and returns the updated network. [Networks] via PATCH /networks/{id}

Updates the specified notification channel and returns the updated channel. [Notifications] via PATCH /notification_channels/{id}

Updates the specified notification profile and returns the updated profile. [Notifications] via PATCH /notification_profiles/{id}

Updates requirements for a single phone number within a number order. [Phone Number Orders] via PATCH /number_order_phone_numbers/{number_order_phone_number_id}

Updates an existing phone number order, for example to satisfy regulatory requirements attached to the order, and returns the updated order. [Phone Number Orders] via PATCH /number_orders/{number_order_id}

Updates an existing outbound voice profile. [Outbound Voice Profiles] via PATCH /outbound_voice_profiles/{id}

Update payment auto recharge preferences. [AutoRechargePreferences] via PATCH /payment/auto_recharge_prefs

Updates the configurable settings of the specified phone number. The response contains the complete updated phone-number representation. [Phone Number Configurations] via PATCH /phone_numbers/{id}

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. [Phone Number Configurations] via PATCH /phone_numbers/{id}/actions/bundle_status_change

Updates the messaging product, messaging profile, or both for the specified phone number. [Number Settings] via PATCH /phone_numbers/{id}/messaging

Updates the voice configuration for the specified phone number. The response contains the phone number with its updated voice settings. [Phone Number Configurations] via PATCH /phone_numbers/{id}/voice

Update voicemail settings for a phone number. You can also configure a custom greeting by setting the greeting object: use mode custom_greeting together with a media_name that points to an audio file uploaded through the Media Storage API, or mode default to use the standard system greeting. [Voicemail] via PATCH /phone_numbers/{phone_number_id}/voicemail

Updates the specified LOA configuration with the provided fields and returns the updated configuration. [Porting Orders] via PATCH /porting/loa_configurations/{id}

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. If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values. To explicitly set something to null, it must be included in the request with a null value. [Porting Orders] via PATCH /porting_orders/{id}

Updates the activation time of a porting activation job. [Porting Orders] via PATCH /porting_orders/{id}/activation_jobs/{activationJobId}

Updates the status of the specified port-out request, using the status path segment to authorize or reject the port-out. [Number Portout] via PATCH /portouts/{id}/{status}

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. [Pronunciation Dictionaries] via PATCH /pronunciation_dicts/{id}

Update queued call's keep_after_hangup flag [Queue Commands] via PATCH /queues/{queue_name}/calls/{call_control_id}

Updates one or more fields on an agent while its status is CREATED. Submitted agents cannot be changed through this endpoint. [RCS Agents] via PATCH /rcs/agents/{id}

Updates one or more fields on a brand while its status is CREATED. Submitted brands cannot be changed. [RCS Brands] via PATCH /rcs/brands/{id}

Updates the customer reference or regulatory requirement values on the specified requirement group. The response contains the updated group. [Requirement Groups] via PATCH /requirement_groups/{id}

Synchronously updates the specified video room's configuration and returns the updated room. [Rooms] via PATCH /rooms/{room_id}

Update the settings for a specific short code. To unbind a short code from a profile, set the messaging_profile_id to null or an empty string. To add or update tags, include the tags field as an array of strings. [Short Codes] via PATCH /short_codes/{id}

Updates information for a SIM Card Data Usage Notification. [SIM Cards] via PATCH /sim_card_data_usage_notifications/{id}

Updates the specified SIM card group's attributes and returns the updated group. [SIM Card Groups] via PATCH /sim_card_groups/{id}

Updates the specified SIM card's attributes and returns the updated SIM card. [SIM Cards] via PATCH /sim_cards/{id}

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. [cloudfs filesystems] via PATCH /storage/cloudfs/{id}

Updates the requirements of an existing sub number order and returns the updated order. [Phone Number Orders] via PATCH /sub_number_orders/{sub_number_order_id}

Allows you to cancel a sub number order in 'pending' status. [Phone Number Orders] via PATCH /sub_number_orders/{sub_number_order_id}/cancel

Updates the specified telephony credential and returns the updated credential. [Credentials] via PATCH /telephony_credentials/{id}

Updates settings of an existing TeXML Application. [TeXML Applications] via PATCH /texml_applications/{id}

Updates the specified traffic policy profile and returns the updated profile. [Traffic Policy Profiles] via PATCH /traffic_policy_profiles/{id}

Updates settings of an existing UAC connection. [UAC Connections] via PATCH /uac_connections/{id}

Update the settings of a specific mobile phone number. [Mobile Phone Numbers] via PATCH /mobile_phone_numbers/{id}

Update the settings of a specific mobile voice connection. [Mobile Voice Connections] via PATCH /mobile_voice_connections/{id}

Updates the supplied WhatsApp user-data settings for the authenticated Telnyx account. [Whatsapp Business Accounts] via PATCH /whatsapp/user_data

Updates the specified Verify profile's name, webhook destinations, language, daily spend limits, or channel-specific settings. Returns the updated profile. [Verify] via PATCH /verify_profiles/{verify_profile_id}

Update an existing Verify profile message template. [Verify] via PATCH /verify_profiles/templates/{template_id}

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. Once the Virtual Cross Connect has moved to provisioning, the IPs can no longer be patched. Once the Virtual Cross Connect has moved to provisioned and you are ready to enable routing, you can toggle the routing announcements to true. [Virtual Cross Connects] via PATCH /virtual_cross_connects/{id}

Updates the name, language, or gender of a voice clone. [Voice Clones] via PATCH /voice_clones/{id}

Updates the name of a voice design. All versions retain their other properties. [Voice Designs] via PATCH /voice_designs/{id}

Update the settings of a WhatsApp Business Account. [Whatsapp Business Accounts] via PATCH /whatsapp/business_accounts/{id}/settings

Update an existing WhatsApp message template. [Whatsapp Message Templates] via PATCH /whatsapp/message_templates/{id}

Enable or disable WhatsApp calling for a phone number and manage its calling configuration. [Whatsapp Phone Numbers] via PATCH /whatsapp/phone_numbers/{phone_number}/calling_settings

Update the conversational components configuration, such as welcome messages and commands, for a WhatsApp phone number. [Whatsapp Phone Numbers] via PATCH /whatsapp/phone_numbers/{phone_number}/conversational_components

Update the WhatsApp business profile associated with a phone number. [Whatsapp Phone Numbers] via PATCH /whatsapp/phone_numbers/{phone_number}/profile

Updates the specified WireGuard peer and returns the updated peer. [WireGuard Interfaces] via PATCH /wireguard_peers/{id}

Updates the specified wireless blocklist. The update is processed asynchronously, so the request is accepted and completes in the background. [Wireless Blocklists] via PATCH /wireless_blocklists/{id}

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. Each brand creation will entail an upfront, non-refundable $4 expense. [Brands] via POST /10dlc/brand

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. [Brands] via POST /10dlc/brand/{brandId}/2faEmail

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. [Brands] via POST /10dlc/brand/{brandId}/externalVetting

Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification. Important Notes: * Only allowed for Sole Proprietor (SOLE_PROPRIETOR) brands * Triggers generation of a one-time password sent to the mobilePhone number in the brand's profile * Campaigns cannot be created until OTP verification is complete * US/CA numbers only for real OTPs; mock brands can use non-US/CA numbers for testing * Returns a referenceId that can be used to check OTP status via the GET /10dlc/brand/smsOtp/{referenceId} endpoint Use Cases: * Initial OTP trigger after Sole Proprietor brand creation * Re-triggering OTP if the user didn't receive or needs a new code [Brands] via POST /10dlc/brand/{brandId}/smsOtp

Manually accept a campaign shared with Telnyx [Campaign] via POST /10dlc/campaign/acceptSharing/{campaignId}

Submits an appeal for rejected native campaigns in TELNYX_FAILED or MNO_REJECTED status. The appeal is recorded for manual compliance team review and the campaign status is reset to TCR_ACCEPTED. Note: Appeal forwarding is handled manually to allow proper review before incurring upstream charges. [Campaign] via POST /10dlc/campaign/{campaignId}/appeal

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. Creating a campaign will entail an upfront, non-refundable three month's cost that will depend on the campaign's use case (see 10DLC Costs section for details). [Campaign] via POST /10dlc/campaignBuilder

Assigns a phone number to a 10DLC campaign. The assignment controls which registered campaign is used for traffic from that number. [Phone Number Campaigns] via POST /10dlc/phone_number_campaigns

This endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign. Please note: if you want to assign phone numbers to a campaign that you did not create with Telnyx 10DLC services, this endpoint allows that provided that you've shared the campaign with Telnyx. In this case, only provide the parameter, tcrCampaignId, and not campaignId. In all other cases (where the campaign you're assigning was created with Telnyx 10DLC services), only provide campaignId, not tcrCampaignId. [Bulk Phone Number Campaigns] via POST /10dlc/phoneNumberAssignmentByProfile

Create a new access IP address entry on your account. [IP Addresses] via POST /access_ip_address

Create a new access IP range on your account. [IP Ranges] via POST /access_ip_ranges

Purchases and registers the specified amount of eSIMs to the current user's account. If sim_card_group_id is provided, the eSIMs will be associated with that group. Otherwise, the default group for the current user will be used. [SIM Cards] via POST /actions/purchase/esims

Register the SIM cards associated with the provided registration codes to the current user's account. If sim_card_group_id is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used. [SIM Cards] via POST /actions/register/sim_cards

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. [Addresses] via POST /addresses

Validates an address for emergency services. [Addresses] via POST /addresses/actions/validate

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. [Addresses] via POST /addresses/{id}/actions/accept_suggestions

Creates an advanced number order from the requested order configuration. The response contains the resulting advanced order and its initial state. [Advanced Number Orders] via POST /advanced_orders

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. The endpoint translates Anthropic-format requests into Telnyx's inference internals, then translates the response back to the Anthropic message shape. Streaming responses use Anthropic SSE event types (message_start, content_block_start, content_block_delta, content_block_stop, message_delta, message_stop). [Anthropic Messages] via POST /ai/anthropic/v1/messages

Creates a new AI assistant from the provided configuration, including its model, instructions, and attached tools, and returns the created assistant. [Assistants] via POST /ai/assistants

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. [Assistants] via POST /ai/assistants/{assistant_id}

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. [Assistants] via POST /ai/assistants/{assistant_id}/canary-deploys

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. Refer to the Conversation API to create a conversation, filter existing conversations, fetch messages for a conversation, and manually add messages to a conversation. [Assistants] via POST /ai/assistants/{assistant_id}/chat

Send an SMS message for an assistant. This endpoint: 1. Validates the assistant exists and has messaging profile configured 2. If should_create_conversation is true, creates a new conversation with metadata 3. Sends the SMS message (If text is set, this will be sent. Otherwise, if this is the first message in the conversation and the assistant has a greeting configured, this will be sent. Otherwise the assistant will generate the text to send.) 4. Updates conversation metadata if provided 5. Returns the conversation ID [Assistants] via POST /ai/assistants/{assistant_id}/chat/sms

Clone an existing assistant, excluding telephony and messaging settings. [Assistants] via POST /ai/assistants/{assistant_id}/clone

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. Optionally provide an enhancement_prompt to steer the changes (for example, "make the instructions more concise" or "add error handling guidance"). When omitted, the assistant's existing instructions are used as the basis for the enhancement. The enhancement focuses on tool-calling reliability, clarity and precision, completeness and error handling, tool schema alignment, and conversation flow structure. The response is streamed as text/plain using chunked transfer encoding; consume the body incrementally to render the enhanced instructions as they arrive. [Assistants] via POST /ai/assistants/{assistant_id}/instructions/enhance

Create a scheduled event for an assistant [Assistants] via POST /ai/assistants/{assistant_id}/scheduled_events

Add a tag to an AI assistant. Tags help you organize and filter your assistants. [Assistants] via POST /ai/assistants/{assistant_id}/tags

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. [Assistants] via POST /ai/assistants/{assistant_id}/tools/{tool_id}/test

Updates the configuration of a specific assistant version. Can not update main version [Assistants] via POST /ai/assistants/{assistant_id}/versions/{version_id}

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. [Assistants] via POST /ai/assistants/{assistant_id}/versions/{version_id}/promote

Import assistants from external providers. Any assistant that has already been imported will be overwritten with its latest version from the importing provider. [Assistants] via POST /ai/assistants/import

Creates a comprehensive test configuration for evaluating AI assistant performance [Assistants] via POST /ai/assistants/tests

Initiates immediate execution of a specific assistant test [Assistants] via POST /ai/assistants/tests/{test_id}/runs

Executes all tests within a specific test suite as a batch operation [Assistants] via POST /ai/assistants/tests/test-suites/{suite_name}/runs

Deprecated: Use POST /v2/ai/openai/chat/completions instead. 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. [Chat] via POST /ai/chat/completions

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. [Clusters] via POST /ai/clusters

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. [AI Collections] via POST /ai/collections

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. [AI Collections] via POST /ai/collections/{uuid}/sources

Creates a new AI conversation, the container for messages exchanged with an assistant, and returns the created conversation. [Conversations] via POST /ai/conversations

Add a new message to the conversation. Used to insert a new messages to a conversation manually ( without using chat endpoint ) [Conversations] via POST /ai/conversations/{conversation_id}/message

Creates a new insight template group for organizing related insight templates, and returns the created group. [Conversations] via POST /ai/conversations/insight-groups

Assigns the specified insight template to the specified insight template group. [Conversations] via POST /ai/conversations/insight-groups/{group_id}/insights/{insight_id}/assign

Creates a new insight template defining an analysis to run over conversations, and returns the created template. [Conversations] via POST /ai/conversations/insights

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. Any files not matching the above types will be attempted to be embedded as unstructured text. This process can be slow, so it runs in the background and the user can check the status of the task using the endpoint /ai/embeddings/{task_id}. Important Note: When you update documents in a Telnyx Storage bucket, their associated embeddings are automatically kept up to date. If you add or update a file, it is automatically embedded. If you delete a file, the embeddings are deleted for that particular file. You can also specify a custom loader param. Currently the only supported loader value is intercom which loads Intercom article jsons as specified by the Intercom article API This loader will split each article into paragraphs and save additional parameters relevant to Intercom docs, such as article_url and heading. These values will be returned by the /v2/ai/embeddings/similarity-search endpoint in the loader_metadata field. [Embeddings] via POST /ai/embeddings

Perform a similarity search on a Telnyx Storage Bucket, returning the most similar num_docs document chunks to the query. Currently the only available distance metric is cosine similarity which will return a distance between 0 and 1. The lower the distance, the more similar the returned document chunks are to the query. A certainty will also be returned, which is a value between 0 and 1 where the higher the certainty, the more similar the document. You can read more about Weaviate distance metrics here: Weaviate Docs If a bucket was embedded using a custom loader, such as intercom, the additional metadata will be returned in the loader_metadata field. [Embeddings] via POST /ai/embeddings/similarity-search

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. As soon as each webpage is added to the bucket, its content is immediately processed for embeddings, that can be used for similarity search and clustering. [Embeddings] via POST /ai/embeddings/url

Creates a new fine-tuning job that trains a model on the provided dataset, and returns the created job. [Fine Tuning] via POST /ai/fine_tuning/jobs

Cancels the specified in-progress fine-tuning job and returns the updated job. [Fine Tuning] via POST /ai/fine_tuning/jobs/{job_id}/cancel

Creates a new MCP server configuration on your account and returns the created server. [MCP Servers] via POST /ai/mcp_servers

Creates a new mission definition from the provided configuration and returns the created mission. Execute the mission by starting runs against it. [Missions] via POST /ai/missions

Creates a copy of the specified mission as a new mission definition, so you can iterate on its configuration without modifying the original. [Missions] via POST /ai/missions/{mission_id}/clone

Create a new knowledge base for a mission [Missions] via POST /ai/missions/{mission_id}/knowledge-bases

Adds an MCP server to the specified mission, making the server's tools available to agents during runs of this mission. [Missions] via POST /ai/missions/{mission_id}/mcp-servers

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. [Missions] via POST /ai/missions/{mission_id}/runs

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. [Missions] via POST /ai/missions/{mission_id}/runs/{run_id}/cancel

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. [Missions] via POST /ai/missions/{mission_id}/runs/{run_id}/events

Pauses a currently running run and returns the updated run object. Execution halts until the run is resumed. [Missions] via POST /ai/missions/{mission_id}/runs/{run_id}/pause

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. [Missions] via POST /ai/missions/{mission_id}/runs/{run_id}/plan

Add one or more steps to an existing plan [Missions] via POST /ai/missions/{mission_id}/runs/{run_id}/plan/steps

Resumes a previously paused run and returns the updated run object, letting execution continue from where it was paused. [Missions] via POST /ai/missions/{mission_id}/runs/{run_id}/resume

Link a Telnyx AI agent (voice/messaging) to a run [Missions] via POST /ai/missions/{mission_id}/runs/{run_id}/telnyx-agents

Adds a new tool to the specified mission, defining an action agents can invoke during runs of this mission. [Missions] via POST /ai/missions/{mission_id}/tools

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. [OpenAI Chat] via POST /ai/openai/chat/completions

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. [OpenAI Embeddings] via POST /ai/openai/embeddings

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. The conversation parameter refers to a Telnyx Conversation rather than an OpenAI-hosted conversation object. To persist a thread across turns, first create a conversation with POST /ai/conversations, then pass that conversation's id in the Responses request as conversation. The endpoint appends the new input, assistant output, reasoning, and tool-call messages to that conversation. Reuse the same conversation id on subsequent Responses requests, including tool-result followups, so the model receives the prior context. If conversation is omitted, the request is processed without persisting messages to a Telnyx conversation. Use the Conversations API to manage history: list conversations (optionally filtered by metadata), fetch messages for a conversation, and optionally add messages outside the Responses flow. You can attach arbitrary metadata when creating a conversation (for example to tag the conversation's source, channel, or user) and later filter by it when listing conversations. [OpenAI Chat] via POST /ai/openai/responses

Deprecated: Use POST /v2/ai/openai/responses instead. This endpoint is compatible with the OpenAI Responses API and may be used with the OpenAI JS or Python SDK. Response id parameter is not supported at the moment. Use the conversation parameter with a Telnyx Conversation ID to leverage persistent conversations. [Chat] via POST /ai/responses

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 [Chat] via POST /ai/summarize

Create a new custom AI tool that can be attached to AI assistants. [Assistants] via POST /ai/tools

Create a new alphanumeric sender ID associated with a messaging profile. [Messaging] via POST /alphanumeric_sender_ids

Creates a new authentication provider for single sign-on, configured from the provided identity provider details, and returns the created resource. [Authentication Providers] via POST /authentication_providers

Create a new billing group, which can be used to organize resources for billing purposes. [Billing Groups] via POST /billing_groups

Creates multiple user bundles for the user. [User Bundles] via POST /bundle_pricing/user_bundles/bulk

Creates a call control application, which defines the webhook endpoints and settings used to control calls on associated connections. [Call Control Applications] via POST /call_control_applications

Check up to 10 candidate call_reasons strings against Telnyx's vetting heuristics before sending them on a DIR create or update. The endpoint flags strings that are likely to be rejected during vetting (too generic, banned phrases, length issues, etc.) so you can fix them up front. [Reference Data] via POST /call_reasons/validate

Dial a number or SIP URI from a given connection. A successful response will include a call_leg_id which can be used to correlate the command with subsequent webhooks. Expected Webhooks: - call.initiated - call.answered or call.hangup - call.hold and call.unhold if the call is held/unheld - call.machine.detection.ended if answering_machine_detection was requested - call.machine.greeting.ended if answering_machine_detection was requested to detect the end of machine greeting - call.machine.premium.detection.ended if answering_machine_detection=premium was requested - call.machine.premium.greeting.ended if answering_machine_detection=premium was requested and a beep was detected - call.deepfake_detection.result if deepfake_detection was enabled - call.deepfake_detection.error if deepfake_detection was enabled and an error occurred - streaming.started, streaming.stopped or streaming.failed if stream_url was set When the record parameter is set to record-from-answer, the response will include a recording_id field. [Call Commands] via POST /calls

Add messages to the conversation started by an AI assistant on the call. [Call Commands] via POST /calls/{call_control_id}/actions/ai_assistant_add_messages

Add a participant to an existing AI assistant conversation. Use this command to bring an additional call leg into a running AI conversation. [Call Commands] via POST /calls/{call_control_id}/actions/ai_assistant_join

Start an AI assistant on the call. Expected Webhooks: - call.conversation.ended - call.conversation_insights.generated [Call Commands] via POST /calls/{call_control_id}/actions/ai_assistant_start

Stops the AI assistant currently engaged on the call. The call remains active and can continue with other call control commands. [Call Commands] via POST /calls/{call_control_id}/actions/ai_assistant_stop

Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call. Expected Webhooks: - call.answered - call.hold and call.unhold if the call is held/unheld - call.deepfake_detection.result if deepfake_detection was enabled - call.deepfake_detection.error if deepfake_detection was enabled and an error occurred - streaming.started, streaming.stopped or streaming.failed if stream_url was set When the record parameter is set to record-from-answer, the response will include a recording_id field. [Call Commands] via POST /calls/{call_control_id}/actions/answer

Bridge two call control calls. Expected Webhooks: - call.bridged for Leg A - call.bridged for Leg B [Call Commands] via POST /calls/{call_control_id}/actions/bridge

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. Only one AI Assistant or Conversation Relay session can be active on a call at a time. Expected Webhooks: - call.conversation.ended - Sent when the Conversation Relay session ends. If the customer WebSocket disconnects, the webhook payload reason is customer_disconnect. [Call Commands] via POST /calls/{call_control_id}/actions/conversation_relay_start

Stop the active Conversation Relay session on a call. [Call Commands] via POST /calls/{call_control_id}/actions/conversation_relay_stop

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. [Call Commands] via POST /calls/{call_control_id}/actions/enqueue

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. Requests must specify either the target attribute or the rx and tx attributes. Expected Webhooks: - call.fork.started - call.fork.stopped [Call Commands] via POST /calls/{call_control_id}/actions/fork_start

Stop forking a call. Expected Webhooks: - call.fork.stopped [Call Commands] via POST /calls/{call_control_id}/actions/fork_stop

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 [Call Commands] via POST /calls/{call_control_id}/actions/gather

Stop current gather. Expected Webhooks: - call.gather.ended [Call Commands] via POST /calls/{call_control_id}/actions/gather_stop

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. Expected Webhooks: - call.ai_gather.ended - call.conversation.ended - call.ai_gather.partial_results (if send_partial_results is set to true) - call.ai_gather.message_history_updated (if send_message_history_updates is set to true) [Call Commands] via POST /calls/{call_control_id}/actions/gather_using_ai

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 'invalid_audio_url', which will be played back at the beginning of each prompt. Playback will be interrupted when a DTMF signal is received. The Answer command must be issued before the gather_using_audio command. Expected Webhooks: - call.playback.started - call.playback.ended - call.dtmf.received (you may receive many of these webhooks) - call.gather.ended [Call Commands] via POST /calls/{call_control_id}/actions/gather_using_audio

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 'invalid_payload', which will be played back at the beginning of each prompt. Speech will be interrupted when a DTMF signal is received. The Answer command must be issued before the gather_using_speak command. Expected Webhooks: - call.dtmf.received (you may receive many of these webhooks) - call.gather.ended [Call Commands] via POST /calls/{call_control_id}/actions/gather_using_speak

Hang up the call. Expected Webhooks: - call.hangup - call.recording.saved [Call Commands] via POST /calls/{call_control_id}/actions/hangup

Removes the call from the queue it is currently waiting in. The call remains active and can be directed with further call commands. [Call Commands] via POST /calls/{call_control_id}/actions/leave_queue

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. When payment_token is supplied, the DTMF collection steps are skipped and the existing token is sent to the connector. Expected Webhooks: - call.payment.progress - call.payment.completed Test mode card numbers: 4111111111111111 (Visa), 5555555555554444 (Mastercard), 378282246310005 (American Express), 6011111111111117 (Discover), 3065930009020004 (Diners Club), 3566002020360505 (JCB), 6200000000000005 (UnionPay), and 6771798021000008 (Maestro). Test-mode connectors reject other card numbers before contacting the configured processor. The UnionPay and Maestro numbers are accepted for processor testing, but Pay currently does not emit a card type for them. [Call Commands] via POST /calls/{call_control_id}/actions/pay

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, target_legs is limited to self. - A customer cannot Play Audio with overlay=true unless there is a Play Audio with overlay=false actively playing. Expected Webhooks: - call.playback.started - call.playback.ended [Call Commands] via POST /calls/{call_control_id}/actions/playback_start

Stop audio being played on the call. Expected Webhooks: - call.playback.ended or call.speak.ended [Call Commands] via POST /calls/{call_control_id}/actions/playback_stop

Pause recording the call. Recording can be resumed via Resume recording command. Expected Webhooks: There are no webhooks associated with this command. [Call Commands] via POST /calls/{call_control_id}/actions/record_pause

Resume recording the call. Expected Webhooks: There are no webhooks associated with this command. [Call Commands] via POST /calls/{call_control_id}/actions/record_resume

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 [Call Commands] via POST /calls/{call_control_id}/actions/record_start

Stop recording the call. Expected Webhooks: - call.recording.saved [Call Commands] via POST /calls/{call_control_id}/actions/record_stop

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 [Call Commands] via POST /calls/{call_control_id}/actions/refer

Reject an incoming call. Expected Webhooks: - call.hangup [Call Commands] via POST /calls/{call_control_id}/actions/reject

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. [Call Commands] via POST /calls/{call_control_id}/actions/send_dtmf

Sends SIP info from this leg. Expected Webhooks: - call.sip_info.received (to be received on the target call leg) [Call Commands] via POST /calls/{call_control_id}/actions/send_sip_info

Start siprec session to configured in SIPREC connector SRS. Expected Webhooks: - siprec.started - siprec.stopped - siprec.failed [Call Commands] via POST /calls/{call_control_id}/actions/siprec_start

Stop SIPREC session. Expected Webhooks: - siprec.stopped [Call Commands] via POST /calls/{call_control_id}/actions/siprec_stop

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 [Call Commands] via POST /calls/{call_control_id}/actions/speak

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. Please find more details about media streaming messages specification under the link. [Call Commands] via POST /calls/{call_control_id}/actions/streaming_start

Stop streaming a call to a WebSocket. Expected Webhooks: - streaming.stopped [Call Commands] via POST /calls/{call_control_id}/actions/streaming_stop

Start noise suppression on an active call to reduce background noise. This feature is currently in beta. [Call Commands] via POST /calls/{call_control_id}/actions/suppression_start

Stop noise suppression previously started on an active call. This feature is currently in beta. [Call Commands] via POST /calls/{call_control_id}/actions/suppression_stop

Switch the supervisor role for a bridged call. This allows switching between different supervisor modes during an active call [Call Commands] via POST /calls/{call_control_id}/actions/switch_supervisor_role

Start real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command. Expected Webhooks: - call.transcription [Call Commands] via POST /calls/{call_control_id}/actions/transcription_start

Stops real-time transcription on the call. Transcription webhooks cease once the command takes effect; the call itself is unaffected. [Call Commands] via POST /calls/{call_control_id}/actions/transcription_stop

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. The original call will remain active and may be issued additional commands, potentially transfering the call to an alternate destination. Expected Webhooks: - call.initiated - call.bridged to Leg B - call.answered or call.hangup - call.machine.detection.ended if answering_machine_detection was requested - call.machine.greeting.ended if answering_machine_detection was requested to detect the end of machine greeting - call.machine.premium.detection.ended if answering_machine_detection=premium was requested - call.machine.premium.greeting.ended if answering_machine_detection=premium was requested and a beep was detected [Call Commands] via POST /calls/{call_control_id}/actions/transfer

Creates a comment associated with a supported number-order record. The response contains the created comment. [Phone Number Orders] via POST /comments

Create a conference from an existing call leg using a call_control_id and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants. Expected Webhooks: - conference.created - conference.participant.joined - conference.participant.left - conference.ended - conference.recording.saved - conference.floor.changed [Conference Commands] via POST /conferences

End a conference and terminate all active participants. [Conference Commands] via POST /conferences/{id}/actions/end

Play an audio file to a specific conference participant and gather DTMF input. [Conference Commands] via POST /conferences/{id}/actions/gather_using_audio

Hold a list of participants in a conference call [Conference Commands] via POST /conferences/{id}/actions/hold

Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the call_control_id of the leg you wish to join to the conference as an attribute. The conference can have up to a certain amount of active participants, as set by the max_participants parameter in conference creation request. Expected Webhooks: - conference.participant.joined - conference.participant.left [Conference Commands] via POST /conferences/{id}/actions/join

Removes a call leg from a conference and moves it back to parked state. Expected Webhooks: - conference.participant.left [Conference Commands] via POST /conferences/{id}/actions/leave

Mute a list of participants in a conference call [Conference Commands] via POST /conferences/{id}/actions/mute

Play audio to all or some participants on a conference call. [Conference Commands] via POST /conferences/{id}/actions/play

Pauses the active recording of the specified conference. Resume it later with the record_resume action. [Conference Commands] via POST /conferences/{id}/actions/record_pause

Resumes a previously paused recording of the specified conference, continuing capture from the point it was paused. [Conference Commands] via POST /conferences/{id}/actions/record_resume

Start recording the conference. Recording will stop on conference end, or via the Stop Recording command. Expected Webhooks: - conference.recording.saved [Conference Commands] via POST /conferences/{id}/actions/record_start

Stop recording the conference. Expected Webhooks: - conference.recording.saved [Conference Commands] via POST /conferences/{id}/actions/record_stop

Send DTMF tones to one or more conference participants. [Conference Commands] via POST /conferences/{id}/actions/send_dtmf

Convert text to speech and play it to all or some participants. [Conference Commands] via POST /conferences/{id}/actions/speak

Stop audio being played to all or some participants on a conference call. [Conference Commands] via POST /conferences/{id}/actions/stop

Unhold a list of participants in a conference call [Conference Commands] via POST /conferences/{id}/actions/unhold

Unmute a list of participants in a conference call [Conference Commands] via POST /conferences/{id}/actions/unmute

Update conference participant supervisor_role [Conference Commands] via POST /conferences/{id}/actions/update

Creates a new credential-based SIP connection. Credential connections authenticate with a username and password rather than by IP address. [Credential Connections] via POST /credential_connections

Checks the registration_status for a credential connection, (registration_status) as well as the timestamp for the last SIP registration event (registration_status_updated_at) [Credential Connections] via POST /credential_connections/{id}/actions/check_registration_status

Creates a custom storage credentials configuration. [Call Recordings] via POST /custom_storage_credentials/{connection_id}

Create a new customer service record for the provided phone number. [Customer Service Record] via POST /customer_service_records

Verify the coverage for a list of phone numbers. [Customer Service Record] via POST /customer_service_records/phone_number_coverages

Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services. [Dialogflow Integration] via POST /dialogflow_connections/{connection_id}

Post a customer comment on a DIR (for example, to respond to reviewer notes). Send only content (1–5000 chars) and an optional parent_comment_id; the server sets the comment type, visibility, and author automatically. The enterprise is resolved server-side from the DIR id. [Comments] via POST /dir/{dir_id}/comments

Register phone numbers under a DIR. The enterprise is resolved server-side from the DIR id. Same body, failure modes, and batch semantics whichever path form you use. Pricing: This is a billable action. See https://telnyx.com/pricing/numbers for current pricing. [Phone Numbers] via POST /dir/{dir_id}/phone_numbers

Submit the two business references and one financial reference for a DIR. The DIR's authorizer email must be verified first (see the email-verification endpoint). Until it is, this returns 409 and no references are stored. The request body carries exactly two business references plus one financial reference. The first submission stores them and returns 201. Resubmitting returns 200: identical values are simply confirmed and nothing is written, while changed values replace those references. Replacing a reference is allowed only while the DIR itself is still editable, the same window in which a single reference may be updated; once the DIR has been submitted for vetting this returns 400. A replaced reference's pending verification call is cancelled and its dial-in code stops working, and the replacement contact is emailed fresh scheduling details. References whose details did not change keep their existing call, code, and the notice already sent to them. The response always echoes the stored references in the same shape as the GET. Who qualifies: the two business references confirm the company's reputation and operations. Each should be a senior contact at an organization the business works with, such as a vendor, partner, or client: a C-suite executive (CEO, CFO, CTO, COO), an owner or founder as reflected in the company's corporate records, or a senior manager, director, or executive. The financial reference confirms the company pays its bills and should be a licensed certified public accountant (CPA) the company uses, a contact at a bank or financial institution that has a relationship with the company, or a reasonable alternative banking or financial reference. [DIR References] via POST /dir/{dir_id}/references

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. When re-submitting from verified, the existing registration stays live throughout the new vetting cycle. Returns 400 from submitted/in_review/permanently_rejected. Returns 400 if the DIR's business and financial references have not been submitted. Returns 409 if the DIR has an unresolved infringement claim. [Display Identity Records] via POST /dir/{dir_id}/submit

Email a 6-digit code to the DIR's authorizer email to confirm ownership of that address. The code expires in 15 minutes. Requesting a new code invalidates any previous one. Resends are rate limited (a short cooldown plus a daily cap). Submit the code to POST /dir/{dir_id}/verify_email/confirm. [Email Verification] via POST /dir/{dir_id}/verify_email

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. [Email Verification] via POST /dir/{dir_id}/verify_email/confirm

Upload a document. Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted. [Documents] via POST /documents

Creates a dynamic emergency address, the validated physical location used when provisioning dynamic emergency endpoints. [Dynamic Emergency Addresses] via POST /dynamic_emergency_addresses

Creates a dynamic emergency endpoint, associating a callback number and location with a device for emergency calling. [Dynamic Emergency Endpoints] via POST /dynamic_emergency_endpoints

Creates a suppression with reason: manual_block and source: manual. Caller-supplied reason / source are ignored; scope is derived server-side from domain_id / from and is never trusted. Idempotent: if a matching row already exists (NULL-safe dedupe key: account_id, scope, to, reason, domain_id, from), returns the existing record with 200 (no new audit event). bounce_category, dsn_code, meta, and group_id are not accepted on the public surface. Use the unsubscribe-group suppression endpoint or the internal create surface for those. [Email Suppressions] via POST /email_blocks

Registers a domain for email sending and optional inbound delivery. The response includes the domain configuration and current verification state. [Email Domains] via POST /email_domains

Checks the published DNS records against the records required for the email domain and returns the latest verification results. [Email Domain DNS Records] via POST /email_domains/{domain_id}/verify

Creates a webhook endpoint subscribed to a specific allowlist of event types. Both email.* events (published by email-api) and email_domain.* events (published by this service) flow through the same webhooks. [Email Webhooks] via POST /email_domains/{domain_id}/webhooks

Creates an inbox on an inbound-enabled domain. When domain_id 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. [Email Inboxes] via POST /email_inboxes

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. Drafts are unbillable and emit no Email Detail Records until they are sent. [Email Drafts] via POST /email_inboxes/{inbox_id}/drafts

Sends the draft through the standard send pipeline — the same domain resolution, suppression, reputation, daily-quota, persistence and Detail Record behaviour as POST /v2/email_messages. The response body is the created email message. If the draft has no explicit from_email, the inbox address is used. The draft is marked sent only after the send is accepted; a send rejected for suppression, quota or reputation leaves the draft editable so it can be fixed and retried. A draft that is already sent returns 422 rather than sending twice. [Email Drafts] via POST /email_inboxes/{inbox_id}/drafts/{draft_id}/send

Adds entries to either the allowlist or blocklist. The operation is an idempotent set union: entries already present remain unchanged. [Email Inboxes] via POST /email_inboxes/{inbox_id}/filters

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. Optional text and html are prepended to a forwarded-message block containing the original metadata and available body content. The subject is prefixed with Fwd: unless it already has that prefix. Threading headers are derived from the original message: In-Reply-To is set to its RFC Message-ID, and References contains the original References values plus that Message-ID, de-duplicated and limited to the most recent 20 values. [Email Inboxes] via POST /email_inboxes/{inbox_id}/messages/{message_id}/actions/forward

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. Threading headers are derived from the original message: In-Reply-To is set to its RFC Message-ID, and References contains the original References values plus that Message-ID, de-duplicated and limited to the most recent 20 values. [Email Inboxes] via POST /email_inboxes/{inbox_id}/messages/{message_id}/actions/reply

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. The inbox address is excluded, and recipients are de-duplicated case-insensitively across To and Cc. Bcc is always empty. The subject is prefixed with Re: unless it already has that prefix. Threading headers are derived from the original message: In-Reply-To is set to its RFC Message-ID, and References contains the original References values plus that Message-ID, de-duplicated and limited to the most recent 20 values. [Email Inboxes] via POST /email_inboxes/{inbox_id}/messages/{message_id}/actions/reply_all

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. reply_to_message_id and thread_id are inherited from the parent message and cannot be set by the caller. The recipient, Re: subject and In-Reply-To/References headers are pre-filled from the parent using the same rules as a live reply, so sending the draft threads identically. Supplying to or subject explicitly overrides the pre-filled value. [Email Drafts] via POST /email_inboxes/{inbox_id}/messages/{message_id}/drafts

Adds one or more mutable labels to a message. Labels carry agent workflow state such as spam, needs_review, or processed. Labels are not the same as the send-time tags on outbound messages: tags are immutable and propagate to Email Detail Records and Mission Control for billing attribution, while labels are mailbox state that never reaches the reporting contract. The operation is an idempotent set union — adding a label the message already carries is a no-op and still returns 200. Labels are case-sensitive, and message labels are independent of thread labels. [Email Inboxes] via POST /email_inboxes/{inbox_id}/messages/{message_id}/labels

Adds one or more mutable labels to a thread, letting an agent mark a whole conversation (for example needs_review) without labelling each message individually. Thread labels are independent of message labels: labelling a thread does not label its messages, and labelling a message does not label its thread. Idempotent and case-sensitive. [Email Inboxes] via POST /email_inboxes/{inbox_id}/threads/{thread_id}/labels

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 template_id is supplied. When using template_id, do not also provide subject, html_body, or text_body; the template is rendered with template_variables. Note: template lookup failures (not found, wrong account) return 400, not 404. [Email Messages] via POST /email_messages

Creates up to 50 email messages in a single request. [Email Messages] via POST /email_messages/batch

Creates a Liquid email template. Variables are auto-extracted when omitted. [Email Templates] via POST /email_templates

Renders a template using the provided Liquid variables. Missing template_variables defaults to {}. [Email Templates] via POST /email_templates/{id}/render

Creates an account-owned unsubscribe group for associating email categories with separate recipient suppression lists. [Email Unsubscribe Groups] via POST /email_unsubscribe_groups

Creates a suppression with reason: unsubscribe, source: manual, group_id: . All other body fields are ignored; only to is read. Idempotent (same dedupe key → 200, no new event). [Email Unsubscribe Groups] via POST /email_unsubscribe_groups/{id}/suppressions

Validates a single email address and returns deliverability checks. [Email Validations] via POST /email_validations

Creates an asynchronous batch validation job for up to 1,000 email addresses. [Email Validations] via POST /email_validations/batch

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. Common failure modes: - 422 - a required field is missing or malformed (the response errors[].source.pointer names the field). - 409 - an enterprise with the same identifying details already exists under your account. [Enterprises] via POST /enterprises

Branded Calling is a paid product that must be activated on each enterprise. Activation is idempotent: - First call: marks the enterprise as activated and begins onboarding it with the Branded Calling platform asynchronously. Returns 200 with branded_calling_enabled: true. - Re-call after success: no-op, returns the same enterprise body. - Re-call after a prior failure: re-queues onboarding, returns 200. Prerequisite: the calling user must have agreed to the Branded Calling Terms of Service (POST /terms_of_service/branded_calling/agree). Without that, this endpoint returns 403 terms_of_service_not_accepted. Failure modes: - 403 - Branded Calling Terms of Service not accepted. - 404 - enterprise does not exist or does not belong to your account. Pricing: This is a billable action. See https://telnyx.com/pricing/numbers for current pricing. [Enterprises] via POST /enterprises/{enterprise_id}/branded_calling

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. Field rules - display_name: 1–35 characters, no emoji or whitespace-only strings; this is the name shown to recipients. - call_reasons: 1–10 strings, each ≤64 characters; describe why your business calls customers (e.g. 'Appointment reminders', 'Billing inquiries'). Validate the wording against POST /call_reasons/validate. - logo_url: HTTPS URL (max 128 chars) to a 256×256 BMP (max 1 MB). The image is downloaded and hashed at submission time. - documents: up to 20 entries; each document_id must be obtained by uploading the file via the Telnyx Documents API first. Within one DIR a document_id may only appear once. - certify_brand_is_accurate, certify_no_shaft_content, certify_ip_ownership MUST all be true. Failure modes - 422 - validation error; errors[].source.pointer names the offending field. - 403 - Branded Calling not activated on this enterprise (see POST /enterprises/{id}/branded_calling). - 404 - enterprise does not exist or does not belong to your account. [Display Identity Records] via POST /enterprises/{enterprise_id}/dir

Activate Phone Number Reputation for the given enterprise. Requires an uploaded Letter of Authorization document (the loa_document_id references the Telnyx Documents API) and a refresh-frequency selection. After activation, individual phone numbers can be registered via POST .../reputation/numbers. Prerequisite: the calling user must have agreed to the Phone Number Reputation Terms of Service (POST /terms_of_service/number_reputation/agree). Failure modes: - 403 - Phone Number Reputation Terms of Service not accepted. - 404 - enterprise does not exist or does not belong to your account. - 400 - reputation already enabled for this enterprise. - 422 - loa_document_id missing or check_frequency invalid. Pricing: This is a billable action. See https://telnyx.com/pricing/numbers for current pricing. [Reputation] via POST /enterprises/{enterprise_id}/reputation

Add up to 100 phone numbers to reputation monitoring on this enterprise. Each must be in E.164 format (+1NPANXXXXXX for US/CA) and belong to your Telnyx phone-number inventory. Prerequisite: reputation must already be enabled on this enterprise (see POST .../reputation). Pricing: This is a billable action. See https://telnyx.com/pricing/numbers for current pricing. [Reputation] via POST /enterprises/{enterprise_id}/reputation/numbers

Immediately refresh the stored reputation data for the listed numbers. This is in addition to the periodic refresh determined by check_frequency. Up to 100 numbers per call. The response carries the kicked-off jobs; the actual refresh runs asynchronously. Pricing: Forcing a refresh performs live reputation lookups, which are billable. See https://telnyx.com/pricing/numbers for current pricing. [Reputation] via POST /enterprises/{enterprise_id}/reputation/numbers/refresh

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. Use the GET endpoints to poll status and per-number results. Each phone number must be in E.164 format and belong to this enterprise. A number that already has an in-flight remediation request is rejected. [Reputation] via POST /enterprises/{enterprise_id}/reputation/remediation

Creates a new External Connection based on the parameters sent in the request. The external_sip_connection and outbound voice profile id are required. Once created, you can assign phone numbers to your application using the /phone_numbers endpoint. [External Connections] via POST /external_connections

Creates a new Upload request to Microsoft teams with the included phone numbers. Only one of civic_address_id or location_id must be provided, not both. The maximum allowed phone numbers for the numbers_ids array is 1000. [External Connections] via POST /external_connections/{id}/uploads

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. Please check the ticket_id in the response to determine if a new upload request was created. [External Connections] via POST /external_connections/{id}/uploads/{ticket_id}/retry

Forces a recheck of the status of all pending Upload requests for the given external connection in the background. [External Connections] via POST /external_connections/{id}/uploads/refresh

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 /phone_numbers endpoint. [Programmable Fax Applications] via POST /fax_applications

Send a fax. Files have size limits and page count limit validations. If a file is bigger than 50MB or has more than 350 pages it will fail with file_size_limit_exceeded and page_count_limit_exceeded respectively. Supported file formats: - PDF (application/pdf) - TIFF (application/tiff, image/tiff) - JPEG (image/jpeg) - PNG (image/png) - Microsoft Word .doc (application/msword) - Microsoft Word .docx (application/vnd.openxmlformats-officedocument.wordprocessingml.document) - Rich Text Format .rtf (application/rtf) - Plain text .txt (text/plain) Expected Webhooks: - fax.queued - fax.media.processed - fax.sending.started - fax.delivered - fax.failed [Programmable Fax Commands] via POST /faxes

Cancel the outbound fax that is in one of the following states: queued, media.processed, originated or sending [Programmable Fax Commands] via POST /faxes/{id}/actions/cancel