Connectors
Communication, Email & Calendar
Telnyx
Communications API: SMS, voice calls, phone numbers, and messaging events
Telnyx API referenceAPI checked August 18, 2026
- Signs in with
- API token
- Runs on
- Cloud or On-Prem Worker
- Operations
- 1,261
- Ready-made triggers
- 0
Connect Telnyx
- In Neblex open Connect › Connections and click New Connection.
- Search for Telnyx and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Access tokenRequiredSecret |
Use it in a flow
- Open a flow, open the node library and search for Telnyx.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
Operations
1,261 operations in 195 groups. Each one is a step you can add to a flow.
Access Token1
Create an Access Token.CreateTelephonyCredentialToken | POST | Create an Access Token (JWT) for the credential. |
Address6
Accepts this address suggestion as a new emergency address foracceptAddressSuggestions | POST | |
Creates an addressCreateAddress | POST | Creates an address. |
Deletes an addressDeleteAddress | DELETE | Deletes an existing address. |
List all addressesFindAddresses | GET | Returns a list of your addresses. |
Retrieve an addressGetAddress | GET | Retrieves the details of an existing address. |
Validate an addressValidateAddress | POST | Validates an address for emergency services. |
Advanced Number Order4
Create Advanced Ordercreate_advanced_order_v2 | POST | |
Get Advanced Orderget_advanced_order_v2 | GET | |
List Advanced Orderslist_advanced_orders_v2 | GET | |
Update Advanced Orderupdate_advanced_order_v2 | PATCH |
Anthropic Message1
Create a message (Anthropic-compatible)create_anthropic_message | POST | Send a message to a language model using the Anthropic Messages API format. |
Assistant46
Add Assistant Tagadd_assistant_tag | POST | |
Add Assistant Tooladd_assistant_tool | PUT | |
Assistant Chat (BETA)assistant_chat_public_assistants_assistant_id_chat_post | POST | This endpoint allows a client to send a chat message to a specific AI Assistant. |
Assistant Sms Chatassistant_sms_chat_assistants_assistant_id_chat_sms_post | POST | Send an SMS message for an assistant. |
Clone Assistantclone_assistant_public_assistants_assistant_id_clone_post | POST | Clone an existing assistant, excluding telephony and messaging settings. |
Create a new assistant testcreate_assistant_test_public_assistants_tests_post | POST | Creates a comprehensive test configuration for evaluating AI assistant performance |
Create a scheduled eventcreate_scheduled_event | POST | Create a scheduled event for an assistant |
Create an assistantcreate_new_assistant_public_assistants_post | POST | Create a new AI Assistant. |
Create Canary Deploycreate_canary_deploy_assistants_assistant_id_canary_deploys_post | POST | Endpoint to create a canary deploy configuration for an assistant. |
Create Toolcreate_tool_post | POST | |
Delete a scheduled eventdelete_scheduled_event | DELETE | If the event is pending, this will cancel the event. |
Delete a specific assistant versiondelete_assistant_version_public_assistants_assistant_id_versions_version_id_delete | DELETE | Permanently removes a specific version of an assistant. |
Delete an assistantdelete_assistant_public_assistants_assistant_id_delete | DELETE | Delete an AI Assistant by assistant id. |
Delete an assistant testdelete_assistant_test_public_assistants_tests_test_id_delete | DELETE | Permanently removes an assistant test and all associated data |
Delete Canary Deploydelete_canary_deploy_assistants_assistant_id_canary_deploys_delete | DELETE | Endpoint to delete a canary deploy configuration for an assistant. |
Delete Tooldelete_tool_tool_id | DELETE | |
Enhance Assistant Instructionsenhance_assistant_instructions_public_assistants_assistant_id_instructions_enhance_post | POST | Enhance an assistant's instructions using an LLM. |
Get a scheduled eventget_scheduled_event | GET | Retrieve a scheduled event by event ID |
Get a specific assistant versionget_assistant_version_public_assistants_assistant_id_versions_version_id_get | GET | Retrieves a specific version of an assistant by assistant id and version id |
Get All Tagsget_all_assistant_tags | GET | |
Get all test suite namesfetch_test_suites_public_assistants_tests_test_suites_get | GET | Retrieves a list of all distinct test suite names available to the current user |
Get all versions of an assistantget_assistant_versions_public_assistants_assistant_id_versions_get | GET | Retrieves all versions of a specific assistant with complete configuration and metadata |
Get an assistantget_assistant_public_assistants_assistant_id_get | GET | Retrieve an AI Assistant configuration by assistant id. |
Get assistant test by IDget_assistant_test_public_assistants_tests_test_id_get | GET | Retrieves detailed information about a specific assistant test |
Get assistant texmlget_assistant_texml_public_assistants_assistant_id_texml_get | GET | Get an assistant texml by assistant id. |
Get Canary Deployget_canary_deploy_assistants_assistant_id_canary_deploys_get | GET | Endpoint to get a canary deploy configuration for an assistant. |
Get specific test run detailsget_test_run_public_assistants_tests_test_id_runs_run_id_get | GET | Retrieves detailed information about a specific test run execution |
Get test run history for a specific testget_test_runs_for_test_public_assistants_tests_test_id_runs_get | GET | Retrieves paginated execution history for a specific assistant test with filtering options |
Get test suite run historyget_test_suite_runs_for_test_public_assistants_tests_test_suites_suite_name_runs_get | GET | Retrieves paginated history of test runs for a specific test suite with filtering options |
Get Toolget_tool_tool_id | GET | |
Import assistants from external providerimport_assistants_public_assistants_import_post | POST | Import assistants from external providers. |
List assistant tests with paginationget_assistant_tests_public_assistants_tests_get | GET | Retrieves a paginated list of assistant tests with optional filtering capabilities |
List assistantsget_assistants_public_assistants_get | GET | Retrieve a list of all AI Assistants configured by the user. |
List scheduled eventsget_scheduled_events | GET | Get scheduled events for an assistant with pagination and filtering |
List Toolslist_tools | GET | |
Promote an assistant version to mainpromote_assistant_version_public_assistants_assistant_id_versions_version_id_promote_post | POST | Promotes a specific version to be the main/current version of the assistant. |
Remove Assistant Tagremove_assistant_tag | DELETE | |
Remove Assistant Toolremove_assistant_tool | DELETE | |
Test Assistant Tooltest_assistant_tool_public_assistants_assistant_id_tools_tool_id_test_post | POST | Test a webhook tool for an assistant |
Trigger a manual test runtrigger_test_run_public_assistants_tests_test_id_runs_post | POST | Initiates immediate execution of a specific assistant test |
Trigger test suite executiontrigger_test_suite_runs_public_assistants_tests_test_suites_suite_name_runs_post | POST | Executes all tests within a specific test suite as a batch operation |
Update a specific assistant versionupdate_assistant_version_public_assistants_assistant_id_versions_version_id_post | POST | Updates the configuration of a specific assistant version. |
Update an assistantupdate_assistant_public_assistants_assistant_id_post | POST | Update an AI Assistant's attributes. |
Update an assistant testupdate_assistant_test_public_assistants_tests_test_id_put | PUT | Updates an existing assistant test configuration with new settings |
Update Canary Deployupdate_canary_deploy_assistants_assistant_id_canary_deploys_put | PUT | Endpoint to update a canary deploy configuration for an assistant. |
Update Toolupdate_tool_tool_id | PATCH |
Audio1
Transcribe speech to textaudio_public_audio_transcriptions_post | POST | Transcribe speech to text. |
Audit Log1
List Audit LogsListAuditLogs | GET | Retrieve a list of audit log entries. |
Authentication Provider5
Creates an authentication providerCreateAuthenticationProvider | POST | Creates an authentication provider. |
Deletes an authentication providerDeleteAuthenticationProvider | DELETE | Deletes an existing authentication provider. |
List all SSO authentication providersFindAuthenticationProviders | GET | Returns a list of your SSO authentication providers. |
Retrieve an authentication providerGetAuthenticationProvider | GET | Retrieves the details of an existing authentication provider. |
Update an authentication providerUpdateAuthenticationProvider | PATCH | Updates settings of an existing authentication provider. |
AutoRechargePreference2
List auto recharge preferencesGetAutoRechargePrefs | GET | Returns the payment auto recharge preferences. |
Update auto recharge preferencesUpdateAutoRechargePrefs | PATCH | Update payment auto recharge preferences. |
Billing1
Get user balance detailsGetUserBalance | GET |
Billing Group5
Create a billing groupCreateBillingGroup | POST | |
Delete a billing groupDeleteBillingGroup | DELETE | |
Get a billing groupGetBillingGroup | GET | |
List all billing groupsListBillingGroups | GET | |
Update a billing groupUpdateBillingGroup | PATCH |
Brand16
Create BrandCreateBrandPost | POST | This endpoint is used to create a new brand. |
Delete BrandDeleteBrand | DELETE | Delete Brand. |
Get BrandGetBrand | GET | Retrieve a brand by brandId. |
Get Brand Feedback By IdGetBrandFeedbackById | GET | Get feedback about a brand by ID. |
Get Brand Feedback By IdGetBrandFeedbackById_get_10dlc_brand_feedback_brandId | GET | Get feedback about a brand by ID. |
Get Brand SMS OTP StatusGetBrandSmsOtpStatus | GET | Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification. |
Get Brand SMS OTP Status by Brand IDGetBrandSmsOtpStatusByBrandId | GET | Query the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID. |
Import External Vetting RecordPutExternalVettingRecord | PUT | This operation can be used to import an external vetting record from a TCR-approved vetting provider. |
List BrandsGetBrands | GET | This endpoint is used to list all brands associated with your organization. |
List External VettingsListExternalVettings | GET | Get list of valid external vetting record for a given brand |
Order Brand External VettingPostOrderExternalVetting | POST | Order new external vetting for a brand. |
Resend brand 2FA emailResendBrand2faEmail | POST | |
Revet BrandRevetBrand | PUT | This operation allows you to revet the brand. |
Trigger Brand SMS OTPTriggerBrandSmsOtp | POST | Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification. |
Update BrandUpdateBrand | PUT | Update a brand's attributes by brandId. |
Verify Brand SMS OTPVerifyBrandSmsOtp | PUT | Verify the SMS OTP (One-Time Password) for Sole Proprietor brand verification. |
Bucket SSL Certificate3
Add SSL CertificateAddStorageSSLCertificate | PUT | Uploads an SSL certificate and its matching secret so that you can use Telnyx's storage as your CDN. |
Get Bucket SSL CertificateGetStorageSSLCertificates | GET | Returns the stored certificate detail of a bucket, if applicable. |
Remove SSL CertificateRemoveStorageSSLCertificate | DELETE | Deletes an SSL certificate and its matching secret. |
Bucket Usage2
Get API UsageGetStorageAPIUsage | GET | Returns the detail on API usage on a bucket of a particular time period, group by method category. |
Get Bucket UsageGetBucketUsage | GET | Returns the amount of storage space and number of files a bucket takes up. |
Bulk Phone Number Campaign3
Assign Messaging Profile To CampaignPostAssignMessagingProfileToCampaign | POST | This endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign. |
Get Assignment Task StatusGetAssignmentTaskStatus | GET | Check the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by taskId. |
Get Phone Number StatusGetPhoneNumberStatus | GET | Check the status of the individual phone number/campaign assignments associated with the supplied taskId. |
Bulk Phone Number Operation5
Delete a batch of numbersCreateDeletePhoneNumbersJob | POST | Creates a new background job to delete a batch of numbers. |
Lists the phone numbers jobsListPhoneNumbersJobs | GET | |
Retrieve a phone numbers jobRetrievePhoneNumbersJob | GET | |
Update a batch of numbersCreateUpdatePhoneNumbersJob | POST | Creates a new background job to update a batch of numbers. |
Update the emergency settings from a batch of numbersCreatePhoneNumbersJobUpdateEmergencySettings | POST | Creates a background job to update the emergency settings of a collection of phone numbers. |
Bundle2
Get Bundle By IdGetBillingBundleById | GET | Get a single bundle by ID. |
Retrieve BundlesGetUserBillingBundles | GET | Get all allowed bundles. |
Call Command42
Add messages to AI AssistantCallAddMessagesToAIAssistant | POST | Add messages to the conversation started by an AI assistant on the call. |
Answer callAnswerCall | POST | Answer an incoming call. |
Bridge callsBridgeCall | POST | Bridge two call control calls. |
Collect payment detailsPayCall | POST | Collect payment details from the caller using DTMF and either charge or tokenize the payment method through a configured Pay connector. |
DialDialCall | POST | Dial a number or SIP URI from a given connection. |
Enqueue callEnqueueCall | POST | Put the call in a queue. |
Forking startStartCallFork | POST | Call forking allows you to stream the media from a call to a specific target in realtime. |
Forking stopStopCallFork | POST | Stop forking a call. |
GatherGatherCall | POST | Gather DTMF signals to build interactive menus. |
Gather stopStopCallGather | POST | Stop current gather. |
Gather using AIcallGatherUsingAI | POST | Gather parameters defined in the request payload using a voice assistant. |
Gather using audioGatherUsingAudio | POST | Play an audio file on the call until the required DTMF signals are gathered to build interactive menus. |
Gather using speakGatherUsingSpeak | POST | Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus. |
Hangup callHangupCall | POST | Hang up the call. |
Join AI Assistant ConversationCallJoinAIAssistant | POST | Add a participant to an existing AI assistant conversation. |
Noise Suppression Start (BETA)noiseSuppressionStart | POST | |
Noise Suppression Stop (BETA)noiseSuppressionStop | POST | |
Play audio URLStartCallPlayback | POST | Play an audio file on the call. |
Record pausePauseCallRecording | POST | Pause recording the call. |
Record resumeResumeCallRecording | POST | Resume recording the call. |
Recording startStartCallRecord | POST | Start recording the call. |
Recording stopStopCallRecording | POST | Stop recording the call. |
Reject a callRejectCall | POST | Reject an incoming call. |
Remove call from a queueLeaveQueue | POST | Removes the call from a queue. |
Send DTMFSendDTMF | POST | Sends DTMF tones from this leg. |
Send SIP infoSendSIPInfo | POST | Sends SIP info from this leg. |
SIP Refer a callReferCall | POST | Initiate a SIP Refer on a Call Control call. |
SIPREC startStartSiprecSession | POST | Start siprec session to configured in SIPREC connector SRS. |
SIPREC stopStopSiprecSession | POST | Stop SIPREC session. |
Speak textSpeakCall | POST | Convert text to speech and play it back on the call. |
Start AI AssistantCallStartAIAssistant | POST | Start an AI assistant on the call. |
Start Conversation RelayCallStartConversationRelay | POST | Start a Conversation Relay session on an active call. |
Stop AI AssistantCallStopAIAssistant | POST | Stop an AI assistant on the call. |
Stop audio playbackStopCallPlayback | POST | Stop audio being played on the call. |
Stop Conversation RelayCallStopConversationRelay | POST | Stop the active Conversation Relay session on a call. |
Streaming startStartCallStreaming | POST | Start streaming the media from a call to a specific WebSocket address or Dialogflow connection in near-realtime. |
Streaming stopStopCallStreaming | POST | Stop streaming a call to a WebSocket. |
Switch supervisor roleSwitchSupervisorRole | POST | Switch the supervisor role for a bridged call. |
Transcription startStartCallTranscription | POST | Start real-time transcription. |
Transcription stopStopCallTranscription | POST | Stop real-time transcription. |
Transfer callTransferCall | POST | Transfer a call to a new destination. |
Update client stateUpdateClientState | PUT | Updates client state |
Call Control Application5
Create a call control applicationCreateCallControlApplication | POST | Create a call control application. |
Delete a call control applicationDeleteCallControlApplication | DELETE | Deletes a call control application. |
List call control applicationsListCallControlApplications | GET | Return a list of call control applications. |
Retrieve a call control applicationRetrieveCallControlApplication | GET | Retrieves the details of an existing call control application. |
Update a call control applicationUpdateCallControlApplication | PATCH | Updates settings of an existing call control application. |
Call Information2
List all active calls for given connectionListConnectionActiveCalls | GET | Lists all active calls for given connection. |
Retrieve a call statusRetrieveCallStatus | GET | Returns the status of a call (data is available 10 minutes after call ended). |
Call Recording11
Create a custom storage credentialCreateCustomStorageCredentials | POST | Creates a custom storage credentials configuration. |
Delete a call recordingDeleteRecording | DELETE | Permanently deletes a call recording. |
Delete a list of call recordingsDeleteRecordings | POST | Permanently deletes a list of call recordings. |
Delete a recording transcriptiondeleteRecordingTranscription | DELETE | Permanently deletes a recording transcription. |
Delete a stored credentialDeleteCustomStorageCredentials | DELETE | Deletes a stored custom credentials configuration. |
List all call recordingsGetRecordings | GET | Returns a list of your call recordings. |
List all recording transcriptionsgetRecordingTranscriptions | GET | Returns a list of your recording transcriptions. |
Retrieve a call recordingGetRecording | GET | Retrieves the details of an existing call recording. |
Retrieve a recording transcriptiongetRecordingTranscription | GET | Retrieves the details of an existing recording transcription. |
Retrieve a stored credentialGetCustomStorageCredentials | GET | Returns the information about custom storage credentials. |
Update a stored credentialUpdateCustomStorageCredentials | PUT | Updates a stored custom credentials configuration. |
Campaign15
Accept Shared CampaignAcceptCampaign | POST | Manually accept a campaign shared with Telnyx |
Deactivate campaignDeactivateCampaign | DELETE | Terminate a campaign. |
Get campaignGetCampaign | GET | Retrieve campaign details by campaignId. |
Get Campaign CostGetCampaignCost | GET | |
Get Campaign CostGetCampaignCost_get_10dlc_campaign_usecase_cost | GET | |
Get Campaign Mno MetadataGetCampaignMnoMetadata | GET | Get the campaign metadata for each MNO it was submitted to. |
Get campaign operation statusGetCampaignOperationStatus | GET | Retrieve campaign's operation status at MNO level. |
Get OSR campaign attributesGetCampaignOsrAttributes | GET | |
Get OSR campaign attributesGetCampaignOsrAttributes_get_10dlc_campaign_campaignId_osr_attributes | GET | |
Get Sharing StatusGetCampaignSharingStatus | GET | |
List CampaignsGetCampaigns | GET | Retrieve a list of campaigns associated with a supplied brandId. |
Qualify By UsecaseGetUsecaseQualification | GET | This endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case. |
Submit CampaignPostCampaign | POST | 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. |
Submit campaign appeal for manual reviewAppealCampaign | POST | Submits an appeal for rejected native campaigns in TELNYX FAILED or MNO REJECTED status. |
Update campaignUpdateCampaign | PUT | Update a campaign's properties by campaignId. |
CDR Report10
Create a new CDR report requestsubmitCdrRequest | POST | Creates a new CDR report request with the specified filters |
Create a new CDR report requestsubmitCdrRequest_post_legacy_reporting_batch_detail_records_voice | POST | Creates a new CDR report request with the specified filters |
Delete a CDR report requestdeleteCdrRequest | DELETE | Deletes a specific CDR report request by ID |
Delete a CDR report requestdeleteCdrRequest_delete_legacy_reporting_batch_detail_records_voice_id | DELETE | Deletes a specific CDR report request by ID |
Get a specific CDR report requestgetCdrRequest | GET | Retrieves a specific CDR report request by ID |
Get a specific CDR report requestgetCdrRequest_get_legacy_reporting_batch_detail_records_voice_id | GET | Retrieves a specific CDR report request by ID |
Get all CDR report requestsgetCdrRequests | GET | Retrieves all CDR report requests for the authenticated user |
Get all CDR report requestsgetCdrRequests_get_legacy_reporting_batch_detail_records_voice | GET | Retrieves all CDR report requests for the authenticated user |
Get available CDR report fieldsgetCdrsAvailableFields | GET | Retrieves all available fields that can be used in CDR reports |
Get available CDR report fieldsgetCdrsAvailableFields_get_legacy_reporting_batch_detail_records_voice_fields | GET | Retrieves all available fields that can be used in CDR reports |
CDR Usage Report9
Create a new legacy usage V2 CDR report requestsubmitCdrUsageReport | POST | Creates a new legacy usage V2 CDR report request with the specified filters |
Create a new legacy usage V2 CDR report requestsubmitCdrUsageReport_post_legacy_reporting_usage_reports_voice | POST | Creates a new legacy usage V2 CDR report request with the specified filters |
Delete a V2 legacy usage CDR report requestdeleteCdrUsageReport | DELETE | Deletes a specific V2 legacy usage CDR report request by ID |
Delete a V2 legacy usage CDR report requestdeleteCdrUsageReport_delete_legacy_reporting_usage_reports_voice_id | DELETE | Deletes a specific V2 legacy usage CDR report request by ID |
Generates and fetches CDR Usage ReportsGetCDRUsageReportSync | GET | Generate and fetch voice usage report synchronously. |
Get a CDR usage reportgetCdrUsageReport | GET | Fetch single cdr usage report by id. |
Get a CDR usage reportgetCdrUsageReport_get_legacy_reporting_usage_reports_voice_id | GET | Fetch single cdr usage report by id. |
List CDR usage reportsgetCdrUsageReports | GET | Fetch all previous requests for cdr usage reports. |
List CDR usage reportsgetCdrUsageReports_get_legacy_reporting_usage_reports_voice | GET | Fetch all previous requests for cdr usage reports. |
Charges Breakdown1
Charges Breakdown charges breakdownGetMonthlyChargesBreakdown | GET | Retrieve a detailed breakdown of monthly charges for phone numbers in a specified date range. |
Charges Summary1
Charges Summary charges summaryGetMonthlyChargesSummary | GET | Retrieve a summary of monthly charges for a specified date range. |
Chat4
Create a chat completionchat_public_chat_completions_post | POST | Deprecated : Use POST /v2/ai/openai/chat/completions instead. |
Create a responsechat_public_responses_completions_post | POST | Deprecated : Use POST /v2/ai/openai/responses instead. |
Get available modelsget_models_public_models_get | GET | Deprecated : Use GET /v2/ai/openai/models instead. |
Summarize file contentPostSummary | POST | Generate a summary of a file's contents. |
Cloudfs Filesystem6
Create a CloudFS filesystemCreateCloudfsFilesystem | POST | Creates a CloudFS filesystem. |
Delete a CloudFS filesystemDeleteCloudfsFilesystem | DELETE | Permanently deletes a CloudFS filesystem, removing its S3 bucket and its metadata database. |
Get a CloudFS filesystemGetCloudfsFilesystem | GET | Retrieves a CloudFS filesystem by its ID. |
List CloudFS filesystemsListCloudfsFilesystems | GET | Lists the CloudFS filesystems for the authenticated user's organization. |
Rotate the metadata tokenRotateCloudfsMetaToken | POST | Issues a new metadata access token for the filesystem and returns the full filesystem, including the new meta token and credential-bearing meta url. |
Update a CloudFS filesystemUpdateCloudfsFilesystem | PATCH | Updates a CloudFS filesystem. |
Cluster5
Compute new clusterscompute_new_cluster_public_text_clusters_post | POST | Starts a background task to compute how the data in an embedded storage bucket is clustered. |
Delete a clusterdelete_cluster_by_task_id_public_text_clusters_task_id_delete | DELETE | |
Fetch a clusterfetch_cluster_by_task_id_public_text_clusters_task_id_get | GET | |
Fetch a cluster visualizationfetch_cluster_image_by_task_id_public_text_clusters_task_id_image_get | GET | |
List all clusterslist_all_requested_clusters_public_text_clusters_get | GET |
Comment2
List comments on a DIRlistCommentsSimple | GET | List the comments on a DIR. |
Post a comment on a DIRcreateCommentSimple | POST | Post a customer comment on a DIR (for example, to respond to reviewer notes). |
Conference Command23
Conference recording pausePauseConferenceRecording | POST | Pause conference recording. |
Conference recording resumeResumeConferenceRecording | POST | Resume conference recording. |
Conference recording startStartConferenceRecording | POST | Start recording the conference. |
Conference recording stopStopConferenceRecording | POST | Stop recording the conference. |
Create conferenceCreateConference | POST | Create a conference from an existing call leg using a call control id and a conference name. |
End a conferenceEndConference | POST | End a conference and terminate all active participants. |
Gather DTMF using audio prompt in a conferenceConferenceGatherUsingAudio | POST | Play an audio file to a specific conference participant and gather DTMF input. |
Hold conference participantsHoldConferenceParticipants | POST | Hold a list of participants in a conference call |
Join a conferenceJoinConference | POST | Join an existing call leg to a conference. |
Leave a conferenceLeaveConference | POST | Removes a call leg from a conference and moves it back to parked state. |
List conference participantsListConferenceParticipants | GET | Lists conference participants |
List conferencesListConferences | GET | Lists conferences. |
Mute conference participantsMuteConferenceParticipants | POST | Mute a list of participants in a conference call |
Play audio to conference participantsPlayConferenceAudio | POST | Play audio to all or some participants on a conference call. |
Retrieve a conferenceRetrieveConference | GET | Retrieve an existing conference |
Retrieve a conference participantRetrieveConferenceParticipant | GET | Retrieve details of a specific conference participant by their ID or label. |
Send DTMF to conference participantsConferenceSendDTMF | POST | Send DTMF tones to one or more conference participants. |
Speak text to conference participantsSpeakTextToConference | POST | Convert text to speech and play it to all or some participants. |
Stop audio being played on the conferenceStopConferenceAudio | POST | Stop audio being played to all or some participants on a conference call. |
Unhold conference participantsUnholdConferenceParticipants | POST | Unhold a list of participants in a conference call |
Unmute conference participantsUnmuteConferenceParticipants | POST | Unmute a list of participants in a conference call |
Update a conference participantUpdateConferenceParticipant | PATCH | Update properties of a conference participant. |
Update conference participantUpdateConference | POST | Update conference participant supervisor role |
Connection2
List connectionsListConnections | GET | Returns a list of your connections irrespective of type. |
Retrieve a connectionRetrieveConnection | GET | Retrieves the high-level details of an existing connection. |
Conversation21
Aggregate Conversation Insightsaggregate_conversation_insights | GET | Aggregate conversation insights by specified fields |
Assign Insight Template To Groupassign_insight_to_group | POST | Assign an insight to a group |
Create a conversationcreate_new_conversation_public_conversations_post | POST | Create a new AI Conversation. |
Create Insight Templatecreate_insight | POST | Create a new insight |
Create Insight Template Groupcreate_insight_group | POST | Create a new insight group |
Create Messageadd_new_message | POST | Add a new message to the conversation. |
Delete a conversationdelete_conversation_by_id_public_conversations_delete | DELETE | Delete a specific conversation by its ID. |
Delete Insight Templatedelete_insight_by_id | DELETE | Delete insight by ID |
Delete Insight Template Groupdelete_insight_group_by_id | DELETE | Delete insight group by ID |
Get a conversationget_conversation_by_id_public_conversations_get | GET | Retrieve a specific AI conversation by its ID. |
Get conversation messagesget_conversations_public_conversation_id_messages_get | GET | Retrieve messages for a specific conversation, including tool calls made by the assistant. |
Get Insight Templateget_insight_by_id | GET | Get insight by ID |
Get Insight Template Groupget_insight_group_by_id | GET | Get insight group by ID |
Get Insight Template Groupsget_all_insight_groups | GET | Get all insight groups |
Get Insight Templatesget_all_insights | GET | Get all insights |
Get insights for a conversationget_conversations_public_conversation_id_insights_get | GET | Retrieve insights for a specific conversation |
List conversationsget_conversations_public_conversations_get | GET | Retrieve a list of all AI conversations configured by the user. |
Unassign Insight Template From Groupunassign_insight_from_group | DELETE | Remove an insight from a group |
Update conversation metadataupdate_conversation_by_id_public_conversations_put | PUT | Update metadata for a specific conversation. |
Update Insight Templateupdate_insight_by_id | PUT | Update an insight template |
Update Insight Template Groupupdate_insight_group_by_id | PUT | Update an insight template group |
Conversation History1
Search conversation historiesSearchConversationHistories | GET | Performs semantic vector search across conversation history records. |
Country Coverage2
Get country coverageretreiveCountryCoverage | GET | Get country coverage |
Get coverage for a specific countryretreiveSpecificCountryCoverage | GET | Get coverage for a specific country |
Coverage1
List network coverage locationsListNetworkCoverage | GET | List all locations and the interfaces that region supports |
Credential5
Create a credentialCreateTelephonyCredential | POST | Create a credential. |
Delete a credentialDeleteTelephonyCredential | DELETE | Delete an existing credential. |
Get a credentialGetTelephonyCredential | GET | Get the details of an existing On-demand Credential. |
List all credentialsFindTelephonyCredentials | GET | List all On-demand Credentials. |
Update a credentialUpdateTelephonyCredential | PATCH | Update an existing credential. |
Credential Connection6
Check a Credential Connection Registration StatusCheckRegistrationStatus | POST | 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) |
Create a credential connectionCreateCredentialConnection | POST | Creates a credential connection. |
Delete a credential connectionDeleteCredentialConnection | DELETE | Deletes an existing credential connection. |
List credential connectionsListCredentialConnections | GET | Returns a list of your credential connections. |
Retrieve a credential connectionRetrieveCredentialConnection | GET | Retrieves the details of an existing credential connection. |
Update a credential connectionUpdateCredentialConnection | PATCH | Updates settings of an existing credential connection. |
CSV Download3
Create a CSV downloadCreateCsvDownload | POST | |
List CSV downloadsListCsvDownloads | GET | |
Retrieve a CSV downloadGetCsvDownload | GET |
Customer Service Record4
Create a customer service recordCreateCustomerServiceRecord | POST | Create a new customer service record for the provided phone number. |
Get a customer service recordGetCustomerServiceRecord | GET | Get a specific customer service record. |
List customer service recordsListCustomerServiceRecords | GET | List customer service records. |
Verify CSR phone number coverageVerifyPhoneNumberCoverage | POST | Verify the coverage for a list of phone numbers. |
Data Migration9
Create a MigrationCreateMigration | POST | Initiate a migration of data from an external provider into Telnyx Cloud Storage. |
Create a Migration SourceCreateMigrationSource | POST | Create a source from which data can be migrated from. |
Delete a Migration SourceDeleteMigrationSource | DELETE | |
Get a MigrationGetMigration | GET | |
Get a Migration SourceGetMigrationSource | GET | |
List all Migration SourcesListMigrationSources | GET | |
List all MigrationsListMigrations | GET | |
List Migration Source coverageListMigrationSourceCoverage | GET | |
Stop a MigrationStopMigration | POST |
Debugging1
List call eventsListCallEvents | GET | Filters call events by given filter parameters. |
Detail Record1
Search detail recordsSearchDetailRecords | GET | Search for any detail record across the Telnyx Platform |
Dialogflow Integration4
Create a Dialogflow ConnectionCreateDialogflowConnection | POST | Save Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services. |
Delete stored Dialogflow ConnectionDeleteDialogflowConnection | DELETE | Deletes a stored Dialogflow Connection. |
Retrieve stored Dialogflow ConnectionGetDialogflowConnection | GET | Return details of the Dialogflow connection associated with the given CallControl connection. |
Update stored Dialogflow ConnectionUpdateDialogflowConnection | PUT | Updates a stored Dialogflow Connection. |
DIR Reference3
List a DIR's referenceslistDirReferences | GET | List the business and financial references submitted for a DIR. |
Submit a DIR's referencessubmitDirReferences | POST | Submit the two business references and one financial reference for a DIR. |
Update a DIR referenceupdateDirReference | PATCH | Partially update one reference, addressed by the DIR id plus the reference's type (business or financial) and slot. |
Display Identity Record8
Create a Display Identity Record (DIR)createDir | POST | Create a new DIR under the given enterprise. |
Delete a DIRdeleteDirSimple | DELETE | Delete a DIR. |
Get a DIR by idgetDirByIdSimple | GET | Returns a single DIR by id. |
List all DIRs across your enterpriseslistAllDirs | GET | Returns every DIR (Display Identity Record) you own, across all of your enterprises, as a single list. |
List DIRs in an enterpriselistDirsForEnterprise | GET | Return the DIRs (Display Identity Records) belonging to a single enterprise. |
Render the Branded Calling LOA for a DIRrenderDirLoa | POST | Generate a pre-filled Letter of Authorization (LOA) PDF for a DIR. |
Submit a DIR for vettingsubmitDirSimple | POST | Submit a DIR for vetting. |
Update a DIRupdateDirSimple | PATCH | Edit a DIR. |
Document8
Delete a documentDeleteDocument | DELETE | Delete a document. |
Download a documentDownloadDocument | GET | Download a document. |
Generate a temporary download link for a documentgetDocumentDownloadLink | GET | Generates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication. |
List all document linksListDocumentLinks | GET | List all documents links ordered by created at descending. |
List all documentsListDocuments | GET | List all documents ordered by created at descending. |
Retrieve a documentRetrieveDocument | GET | Retrieve a document. |
Update a documentUpdateDocument | PATCH | Update a document. |
Upload a documentCreateDocument | POST | Upload a document. |
Dynamic Emergency Address4
Create a dynamic emergency address.CreateDynamicEmergencyAddress | POST | Creates a dynamic emergency address. |
Delete a dynamic emergency addressDeleteDynamicEmergencyAddress | DELETE | Deletes the dynamic emergency address based on the ID provided |
Get a dynamic emergency addressGetDynamicEmergencyAddress | GET | Returns the dynamic emergency address based on the ID provided |
List dynamic emergency addressesListDynamicEmergencyAddresses | GET | Returns the dynamic emergency addresses according to filters |
Dynamic Emergency Endpoint4
Create a dynamic emergency endpoint.CreateDynamicEmergencyEndpoint | POST | Creates a dynamic emergency endpoints. |
Delete a dynamic emergency endpointDeleteDynamicEmergencyEndpoint | DELETE | Deletes the dynamic emergency endpoint based on the ID provided |
Get a dynamic emergency endpointGetDynamicEmergencyEndpoint | GET | Returns the dynamic emergency endpoint based on the ID provided |
List dynamic emergency endpointsListDynamicEmergencyEndpoints | GET | Returns the dynamic emergency endpoints according to filters |
Email Domain6
Create an email domaincreateEmailDomain | POST | |
Delete an email domaindeleteEmailDomain | DELETE | |
Get domain health summarygetEmailDomainHealth | GET | Returns a summary of domain health including verification status and usability. |
List email domainslistEmailDomains | GET | Shared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains. |
Retrieve an email domaingetEmailDomain | GET | Shared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains. |
Update an email domainupdateEmailDomain | PATCH |
Email Domain DNS Record2
List DNS records for an email domainlistEmailDomainDnsRecords | GET | |
Verify DNS records for an email domainverifyEmailDomainDnsRecords | POST |
Email Draft8
Create a draftCreateEmailDraft | POST | Creates an unsent draft in the inbox. |
Create a reply draftCreateEmailReplyDraft | POST | Creates an unsent reply draft for an inbound message. |
Delete a draftDeleteEmailDraft | DELETE | Permanently deletes an unsent draft. |
List drafts in an inboxListEmailDrafts | GET | Lists drafts newest first using stable cursor pagination. |
Retrieve a draftGetEmailDraft | GET | Returns a single draft. |
Send a draftSendEmailDraft | POST | 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. |
Update a draftUpdateEmailDraft | PUT | Updates the supplied fields on a draft. |
Update a draft (alias)PatchEmailDraft | PATCH | Identical to PUT; both apply a partial update to the supplied fields. |
Email Event2
Get email event statisticsGetEmailEventStats | GET | Returns counts and rates for email events over a time range. |
List account email eventsListEmailEvents | GET | Lists account-level email events sorted oldest first by occurred at asc, id asc. |
Email Inbox19
Add labels to an inbox messageAddEmailInboxMessageLabels | POST | Adds one or more mutable labels to a message. |
Add labels to an inbox threadAddEmailInboxThreadLabels | POST | 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. |
Add sender filter entries to an inboxAddEmailInboxFilterEntries | POST | Adds entries to either the allowlist or blocklist. |
Create an email inboxCreateEmailInbox | POST | Creates an inbox on an inbound-enabled domain. |
Delete an email inboxDeleteEmailInbox | DELETE | Soft-deletes an account-scoped inbox. |
Forward an inbox messageForwardEmailInboxMessage | POST | Sends from the inbox address through the standard email send pipeline to caller-supplied To, Cc, and Bcc recipients. |
Get a thread and a page of its messagesGetEmailInboxThread | GET | Returns a bounded page of inbound and outbound thread messages interleaved in chronological order using stable cursor pagination. |
Get an email inboxGetEmailInbox | GET | Returns an account-scoped, non-deleted inbox. |
List and search messages in an inboxListEmailInboxMessages | GET | Lists inbound messages newest first. |
List email inboxesListEmailInboxes | GET | Lists the account's non-deleted inboxes newest first using stable cursor pagination. |
List sender filters for an inboxListEmailInboxFilters | GET | Returns the inbox's sender allowlist and blocklist. |
List threads in an inboxListEmailInboxThreads | GET | Lists thread summaries newest first using stable cursor pagination. |
Remove labels from an inbox messageRemoveEmailInboxMessageLabels | DELETE | Removes one or more labels from a message. |
Remove labels from an inbox threadRemoveEmailInboxThreadLabels | DELETE | Removes one or more labels from a thread. |
Remove sender filter entries from an inboxRemoveEmailInboxFilterEntries | DELETE | Removes entries from either the allowlist or blocklist. |
Replace sender filters for an inboxReplaceEmailInboxFilters | PUT | Replaces both sender filter lists atomically. |
Reply all to an inbox messageReplyAllToEmailInboxMessage | POST | Sends from the inbox address through the standard email send pipeline. |
Reply to an inbox messageReplyToEmailInboxMessage | POST | Sends from the inbox address through the standard email send pipeline. |
Update an inbox messageUpdateEmailInboxMessage | PATCH | Updates the explicit read state of an account-scoped inbound message. |
Email Message10
Cancel a scheduled email messageCancelScheduledEmailMessage | DELETE | Cancels a scheduled email and returns it with status cancelled. |
Create a batch of email messagesCreateEmailMessageBatch | POST | Creates up to 50 email messages in a single request. |
Create or send an email messageCreateEmailMessage | POST | Queues, schedules, or sandbox-sends an email message. |
Delete an email messageDeleteEmailMessage | DELETE | Permanently deletes an account-scoped email message, its events, its durable recipients, and unshared attachment objects. |
Delete email messages by addressDeleteEmailMessagesByAddress | DELETE | Permanently deletes every email in the authenticated account sent from or to the supplied address, including retained events whose parent message has expired. |
Get a single recipient's delivery stateGetEmailMessageRecipient | GET | Returns the current delivery state of a single recipient, including status, billable flag, SMTP detail, and lifecycle timestamps. |
Get an email messageGetEmailMessage | GET | The legacy /v2/emails/{id} GET route is a backward-compatible alias for this operation. |
List email messagesListEmailMessages | GET | Lists messages sorted newest first by inserted at desc, id desc. |
List events for an email messageListEmailMessageEvents | GET | Lists events for a single message sorted oldest first by occurred at asc, id asc. |
List recipients for an email messageListEmailMessageRecipients | GET | Lists per-recipient delivery states for a single message with cursor pagination. |
Email Suppression6
Create a manual suppressioncreateEmailBlock | POST | Creates a suppression with reason: manual block and source: manual. |
Export suppressions as CSVexportEmailBlocks | GET | Streams the account's suppressions as a chunked CSV (server-side cursor; never materialized). |
List audit events for a suppressionlistEmailBlockEvents | GET | Offset pagination only (page[number] default 1, page[size] default 50 , max 100). |
List suppressionslistEmailBlocks | GET | Account-scoped list. |
Retrieve a suppressionshowEmailBlock | GET | |
Soft-delete a suppressiondeleteEmailBlock | DELETE | Soft-deletes (status → removed; tombstone retained). |
Email Suppression Import2
Create an async CSV import jobcreateEmailBlockImport | POST | Accepts multipart/form-data with a file field (the CSV) and an optional block ttl days (integer 0, default 30). |
Poll an import jobshowEmailBlockImport | GET | Account-scoped fetch (cross-account → 404; malformed UUID → 404). |
Email Template7
Create an email templateCreateEmailTemplate | POST | Creates a Liquid email template. |
Delete an email templateDeleteEmailTemplate | DELETE | |
Get an email templateGetEmailTemplate | GET | |
List email templatesListEmailTemplates | GET | Lists templates sorted newest first by inserted at desc, id desc. |
Render an email templateRenderEmailTemplate | POST | Renders a template using the provided Liquid variables. |
Replace an email templateReplaceEmailTemplate | PUT | Replaces template fields. |
Update an email templateUpdateEmailTemplate | PATCH | Updates one or more template fields. |
Email Thread2
Get an account-wide thread and a page of its messagesGetEmailThread | GET | Returns a thread and a bounded page of its inbound and outbound messages, interleaved in chronological order. |
List threads across every inbox in the accountListEmailThreads | GET | Lists thread summaries for the whole account, newest first, using stable cursor pagination. |
Email Unsubscribe Group8
Add a group suppressionaddGroupSuppression | POST | Creates a suppression with reason: unsubscribe, source: manual, group id: . |
Create an unsubscribe groupcreateUnsubscribeGroup | POST | |
Delete an unsubscribe groupdeleteUnsubscribeGroup | DELETE | If the group has 0 active suppressions, hard-deletes the row. |
List suppressions in a grouplistGroupSuppressions | GET | Account + group scoped. |
List unsubscribe groupslistUnsubscribeGroups | GET | Offset pagination only (page[number] default 1, page[size] default 25, max 100). |
Remove a group suppressionremoveGroupSuppression | DELETE | Soft-deletes all active blocks for (account, group, normalized email) - one removed audit event per block (actor: manual). |
Retrieve an unsubscribe groupshowUnsubscribeGroup | GET | |
Update an unsubscribe groupupdateUnsubscribeGroup | PATCH | Partial update (only name / description). |
Email Validation3
Create a batch email validation jobCreateEmailValidationBatch | POST | Creates an asynchronous batch validation job for up to 1,000 email addresses. |
Get a batch email validation jobGetEmailValidationBatch | GET | Retrieves the current status and, once completed, validation results for a batch job. |
Validate a single email addressCreateEmailValidation | POST | Validates a single email address and returns deliverability checks. |
Email Verification3
Confirm an email-ownership verification codeconfirmDirEmailVerification | POST | Submit the 6-digit code that was emailed to the DIR's authorizer email. |
Get email-ownership verification statusgetDirEmailVerificationStatus | GET | Whether the DIR's current authorizer email has been verified. |
Send an email-ownership verification coderequestDirEmailVerification | POST | Email a 6-digit code to the DIR's authorizer email to confirm ownership of that address. |
Email Webhook5
Create a webhook for an email domaincreateEmailDomainWebhook | POST | Creates a webhook endpoint subscribed to a specific allowlist of event types. |
Delete a webhookdeleteEmailDomainWebhook | DELETE | |
List webhooks for an email domainlistEmailDomainWebhooks | GET | |
Retrieve a webhookgetEmailDomainWebhook | GET | |
Update a webhookupdateEmailDomainWebhook | PATCH | Update a webhook's URL and/or event subscription. |
Embedding8
Disable AI for an Embedded Bucketembedding_bucket_files_public_embedding_buckets_bucket_name_delete | DELETE | Deletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing. |
Embed documentsPostEmbedding | POST | Perform embedding on a Telnyx Storage Bucket using the a embedding model. |
Embed URL contentPostEmbeddingUrl | POST | Embed website content from a specified URL, including child pages up to 5 levels deep within the same domain. |
Get an embedding task's statusGetEmbeddingTask | GET | Check the status of a current embedding task. |
Get file-level embedding statuses for a bucketGetBucketName | GET | Get all embedded files for a given user bucket, including their processing status. |
Get Tasks by StatusGetTasksByStatus | GET | Retrieve tasks for the user that are either queued, processing, failed, success or partial success based on the query string. |
List embedded bucketsGetEmbeddingBuckets | GET | Get all embedding buckets for a user. |
Search for documentsPostEmbeddingSimilaritySearch | POST | Perform a similarity search on a Telnyx Storage Bucket, returning the most similar num docs document chunks to the query. |
Enterprise6
Activate Branded Calling on an enterpriseactivateBrandedCalling | POST | Branded Calling is a paid product that must be activated on each enterprise. |
Create an enterprisecreateEnterprise | POST | Create the legal entity (enterprise) that represents your business on the Telnyx platform. |
Delete an enterprisedeleteEnterprise | DELETE | Soft-delete an enterprise. |
Get an enterprisegetEnterprise | GET | Retrieve a single enterprise by id. |
List enterpriseslistEnterprises | GET | Return the enterprises you own, paginated. |
Replace an enterpriseupdateEnterprise | PUT | Replace the enterprise's mutable fields. |
Enum1
Get EnumGetEnumEndpoint | GET |
External Connection23
Creates an External ConnectionCreateExternalConnection | POST | Creates a new External Connection based on the parameters sent in the request. |
Creates an Upload requestCreateExternalConnectionUpload | POST | Creates a new Upload request to Microsoft teams with the included phone numbers. |
Deletes an External ConnectionDeleteExternalConnection | DELETE | Permanently deletes an External Connection. |
Dismiss a log messageDeleteExternalConnectionLogMessage | DELETE | Dismiss a log message for an external connection associated with your account. |
Get the count of pending upload requestsGetExternalConnectionUploadsStatus | GET | Returns the count of all pending upload requests for the given external connection. |
List all civic addresses and locationsListCivicAddresses | GET | Returns the civic addresses and locations from Microsoft Teams. |
List all External ConnectionsListExternalConnections | GET | This endpoint returns a list of your External Connections inside the 'data' attribute of the response. |
List all log messagesListExternalConnectionLogMessages | GET | Retrieve a list of log messages for all external connections associated with your account. |
List all phone numbersListExternalConnectionPhoneNumbers | GET | Returns a list of all active phone numbers associated with the given external connection. |
List all ReleasesListExternalConnectionReleases | GET | Returns a list of your Releases for the given external connection. |
List all Upload requestsListExternalConnectionUploads | GET | Returns a list of your Upload requests for the given external connection. |
Refresh Operator Connect integrationOperatorConnectRefresh | POST | This endpoint will make an asynchronous request to refresh the Operator Connect integration with Microsoft Teams for the current user. |
Refresh the status of all Upload requestsRefreshExternalConnectionUploads | POST | Forces a recheck of the status of all pending Upload requests for the given external connection in the background. |
Retrieve a Civic AddressGetExternalConnectionCivicAddress | GET | Return the details of an existing Civic Address with its Locations inside the 'data' attribute of the response. |
Retrieve a log messageGetExternalConnectionLogMessage | GET | Retrieve a log message for an external connection associated with your account. |
Retrieve a phone numberGetExternalConnectionPhoneNumber | GET | Return the details of a phone number associated with the given external connection. |
Retrieve a Release requestGetExternalConnectionRelease | GET | Return the details of a Release request and its phone numbers. |
Retrieve an External ConnectionGetExternalConnection | GET | Return the details of an existing External Connection inside the 'data' attribute of the response. |
Retrieve an Upload requestGetExternalConnectionUpload | GET | Return the details of an Upload request and its phone numbers. |
Retry an Upload requestRetryUpload | POST | If there were any errors during the upload process, this endpoint will retry the upload request. |
Update a location's static emergency addressupdateLocation | PATCH | |
Update a phone numberUpdateExternalConnectionPhoneNumber | PATCH | Asynchronously update settings of the phone number associated with the given external connection. |
Update an External ConnectionUpdateExternalConnection | PATCH | Updates settings of an existing External Connection based on the parameters of the request. |
Fine Tuning4
Cancel a fine tuning jobcancel_new_finetuningjob_public_finetuning_post | POST | Cancel a fine tuning job. |
Create a fine tuning jobcreate_new_finetuningjob_public_finetuning_post | POST | Create a new fine tuning job. |
Get a fine tuning jobget_finetuningjob_public_finetuning_job_id_get | GET | Retrieve a fine tuning job by job id. |
List fine tuning jobsget_finetuningjob_public_finetuning_get | GET | Retrieve a list of all fine tuning jobs created by the user. |
FQDN5
Create an FQDNCreateFqdn | POST | Create a new FQDN object. |
Delete an FQDNDeleteFqdn | DELETE | Delete an FQDN. |
List FQDNsListFqdns | GET | Get all FQDNs belonging to the user that match the given filters. |
Retrieve an FQDNRetrieveFqdn | GET | Return the details regarding a specific FQDN. |
Update an FQDNUpdateFqdn | PATCH | Update the details of a specific FQDN. |
FQDN Connection5
Create an FQDN connectionCreateFqdnConnection | POST | Creates a FQDN connection. |
Delete an FQDN connectionDeleteFqdnConnection | DELETE | Deletes an FQDN connection. |
List FQDN connectionsListFqdnConnections | GET | Returns a list of your FQDN connections. |
Retrieve an FQDN connectionRetrieveFqdnConnection | GET | Retrieves the details of an existing FQDN connection. |
Update an FQDN connectionUpdateFqdnConnection | PATCH | Updates settings of an existing FQDN connection. |
Global IP21
Create a Global IPCreateGlobalIp | POST | Create a Global IP. |
Create a Global IP assignmentCreateGlobalIpAssignment | POST | Create a Global IP assignment. |
Create a Global IP health checkCreateGlobalIpHealthCheck | POST | Create a Global IP health check. |
Delete a Global IPDeleteGlobalIp | DELETE | Delete a Global IP. |
Delete a Global IP assignmentDeleteGlobalIpAssignment | DELETE | Delete a Global IP assignment. |
Delete a Global IP health checkDeleteGlobalIpHealthCheck | DELETE | Delete a Global IP health check. |
Global IP Assignment Health Check MetricsGetGlobalIpAssignmentHealth | GET | |
Global IP Assignment Usage MetricsGetGlobalIpAssignmentUsage | GET | |
Global IP Assignment Usage MetricsGetGlobalIpAssignmentUsage_get_global_ip_assignments_usage | GET | |
Global IP Latency MetricsGetGlobalIpLatency | GET | |
Global IP Usage MetricsGetGlobalIpUsage | GET | |
List all Global IP Allowed PortsListGlobalIpAllowedPorts | GET | List all Global IP Allowed Ports |
List all Global IP assignmentsListGlobalIpAssignments | GET | List all Global IP assignments. |
List all Global IP Health check typesListGlobalIpHealthCheckTypes | GET | List all Global IP Health check types. |
List all Global IP health checksListGlobalIpHealthChecks | GET | List all Global IP health checks. |
List all Global IP ProtocolsListGlobalIpProtocols | GET | List all Global IP Protocols |
List all Global IPsListGlobalIps | GET | List all Global IPs. |
Retrieve a Global IPGetGlobalIp | GET | Retrieve a Global IP. |
Retrieve a Global IPGetGlobalIpAssignment | GET | Retrieve a Global IP assignment. |
Retrieve a Global IP health checkGetGlobalIpHealthCheck | GET | Retrieve a Global IP health check. |
Update a Global IP assignmentUpdateGlobalIpAssignment | PATCH | Update a Global IP assignment. |
Hosted Number9
Check hosted messaging eligibilityCheckEligibilityNumbers | POST | |
Create a messaging hosted number orderCreateMessagingHostedNumberOrder | POST | |
Create hosted number verification codesCreateVerificationCodesForMessagingHostedNumberOrder | POST | Create verification codes to validate numbers of the hosted order. |
Delete a messaging hosted numberDeleteMessagingHostedNumber | DELETE | |
Delete a messaging hosted number orderDeleteMessagingHostedNumberOrder | DELETE | Delete a messaging hosted number order and all associated phone numbers. |
List messaging hosted number ordersListMessagingHostedNumberOrders | GET | |
Retrieve a messaging hosted number orderGetMessagingHostedNumberOrder | GET | |
Upload hosted number documentUploadMessagingHostedNumberOrderFile | POST | |
Validate hosted number codesValidateVerificationCodesForMessagingHostedNumberOrder | POST | Validate the verification codes sent to the numbers of the hosted order. |
Inexplicit Number Order3
Create an inexplicit number orderCreateInexplicitNumberOrder | POST | Create an inexplicit number order to programmatically purchase phone numbers without specifying exact numbers. |
List inexplicit number ordersListInexplicitNumberOrders | GET | Get a paginated list of inexplicit number orders. |
Retrieve an inexplicit number orderRetrieveInexplicitNumberOrder | GET | Get an existing inexplicit number order by ID. |
Infringement Claim4
Contest an infringement claimcontestInfringementClaim | POST | Submit a written response and supporting documents disputing the claim. |
Get an infringement claimgetInfringementClaim | GET | Retrieve a single claim by id. |
List infringement claims for a DIRlistInfringementClaimsForDir | GET | Return the trademark or copyright claims filed against this DIR. |
Update a DIR to resolve an infringement concernupdateDirInfringement | PUT | Push a fix for a DIR that is suspended with an open infringement claim back into vetting. |
Integration5
Delete Integration Connectiondelete_integration_connection | DELETE | Delete a specific integration connection. |
Get User Integration connection By Idget_user_integration_by_id_public_integrations_connections_user_connection_id_get | GET | Get user setup integrations |
List Integration By Idlist_integration_by_id_public_integrations_integration_id_get | GET | Retrieve integration details |
List Integrationslist_integrations_public_integrations_get | GET | List all available integrations. |
List User Integrationslist_user_integrations_public_integrations_connections_get | GET | List user setup integrations |
Integration Secret3
Create a secretcreate_integration_secret | POST | Create a new secret with an associated identifier that can be used to securely integrate with other services. |
Delete an integration secretdelete_integration_secret | DELETE | Delete an integration secret given its ID. |
List integration secretslist_integration_secrets | GET | Retrieve a list of all integration secrets configured by the user. |
Inventory Level1
Create an inventory coverage requestCreateInventoryCoverage | GET | Creates an inventory coverage request. |
Invoice2
Get invoiceGetInvoiceById | GET | Retrieve a single invoice by its unique identifier. |
List invoicesListInvoices | GET | Retrieve a paginated list of invoices. |
IP5
Create an IpCreateIp | POST | Create a new IP object. |
Delete an IpDeleteIp | DELETE | Delete an IP. |
List IpsListIps | GET | Get all IPs belonging to the user that match the given filters. |
Retrieve an IpRetrieveIp | GET | Return the details regarding a specific IP. |
Update an IpUpdateIp | PATCH | Update the details of a specific IP. |
IP Address4
Create new Access IP AddressCreateAccessIpAddress | POST | |
Delete access IP addressDeleteAccessIpAddress | DELETE | |
List all Access IP AddressesListAccessIpAddresses | GET | |
Retrieve an access IP addressGetAccessIpAddress | GET |
IP Connection5
Create an Ip connectionCreateIpConnection | POST | Creates an IP connection. |
Delete an Ip connectionDeleteIpConnection | DELETE | Deletes an existing IP connection. |
List Ip connectionsListIpConnections | GET | Returns a list of your IP connections. |
Retrieve an Ip connectionRetrieveIpConnection | GET | Retrieves the details of an existing ip connection. |
Update an Ip connectionUpdateIpConnection | PATCH | Updates settings of an existing IP connection. |
IP Range3
Create new Access IP RangeCreateAccessIPRange | POST | |
Delete access IP rangesDeleteAccessIpRange | DELETE | |
List all Access IP RangesListAccessIpRanges | GET |
Kv Key4
Delete a keyDeleteKvKey | DELETE | Deletes a key. |
Get a key's valueGetKvKey | GET | Returns the raw stored value for a key. |
List keysListKvKeys | GET | Lists the keys in a namespace. |
Set a key's valuePutKvKey | PUT | Creates or replaces the value for a key. |
Kv Namespace4
Create a KV namespaceCreateKvNamespace | POST | Creates a new KV namespace. |
Delete a KV namespaceDeleteKvNamespace | DELETE | Deletes a KV namespace and all of the keys it contains. |
Get a KV namespaceGetKvNamespace | GET | Retrieves a KV namespace by its ID, including its provisioning status. |
List KV namespacesListKvNamespaces | GET | Lists the KV namespaces for the authenticated user's organization. |
Managed Account8
Create a new managed account.CreateManagedAccount | POST | Create a new managed account owned by the authenticated user. |
Disables a managed accountDisableManagedAccount | POST | Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. |
Display information about allocatable global outbound channelsListAllocatableGlobalOutboundChannels | GET | Display information about allocatable global outbound channels for the current user. |
Enables a managed accountEnableManagedAccount | POST | Enables a managed account and its sub-users to use Telnyx services. |
Lists accounts managed by the current user.ListManagedAccounts | GET | Lists the accounts managed by the current user. |
Retrieve a managed accountRetrieveManagedAccount | GET | Retrieves the details of a single managed account. |
Update a managed accountUpdateManagedAccount | PATCH | Update a single managed account. |
Update the amount of allocatable global outbound channelsUpdateManagedAccountGlobalChannelLimit | PATCH | Update the amount of allocatable global outbound channels allocated to a specific managed account. |
MCP Server5
Create MCP Servercreate_mcp_server | POST | Create a new MCP server. |
Delete MCP Serverdelete_mcp_server | DELETE | Delete a specific MCP server. |
Get MCP Serverget_mcp_server | GET | Retrieve details for a specific MCP server. |
List MCP Serverslist_mcp_servers | GET | Retrieve a list of MCP servers. |
Update MCP Serverupdate_mcp_server | PUT | Update an existing MCP server. |
MDR Detail Report1
Fetch all Mdr recordsGetPaginatedMdrs | GET | Fetch all Mdr records |
MDR Detailed Report8
Create a new MDR detailed report requestsubmitMdrRequest | POST | Creates a new MDR detailed report request with the specified filters |
Create a new MDR detailed report requestsubmitMdrRequest_post_legacy_reporting_batch_detail_records_messaging | POST | Creates a new MDR detailed report request with the specified filters |
Delete a MDR detailed report requestdeleteMdrRequest | DELETE | Deletes a specific MDR detailed report request by ID |
Delete a MDR detailed report requestdeleteMdrRequest_delete_legacy_reporting_batch_detail_records_messaging_id | DELETE | Deletes a specific MDR detailed report request by ID |
Get a specific MDR detailed report requestgetMdrRequest | GET | Retrieves a specific MDR detailed report request by ID |
Get a specific MDR detailed report requestgetMdrRequest_get_legacy_reporting_batch_detail_records_messaging_id | GET | Retrieves a specific MDR detailed report request by ID |
Get all MDR detailed report requestsgetMdrRequests | GET | Retrieves all MDR detailed report requests for the authenticated user |
Get all MDR detailed report requestsgetMdrRequests_get_legacy_reporting_batch_detail_records_messaging | GET | Retrieves all MDR detailed report requests for the authenticated user |
MDR Usage Report13
Create a new legacy usage V2 MDR report requestsubmitMdrUsageReport | POST | Creates a new legacy usage V2 MDR report request with the specified filters |
Create a new legacy usage V2 MDR report requestsubmitMdrUsageReport_post_legacy_reporting_usage_reports_messaging | POST | Creates a new legacy usage V2 MDR report request with the specified filters |
Create MDR Usage ReportSubmitUsageReport | POST | Submit request for new new messaging usage report. |
Delete a V2 legacy usage MDR report requestdeleteMdrUsageReport | DELETE | Deletes a specific V2 legacy usage MDR report request by ID |
Delete a V2 legacy usage MDR report requestdeleteMdrUsageReport_delete_legacy_reporting_usage_reports_messaging_id | DELETE | Deletes a specific V2 legacy usage MDR report request by ID |
Delete MDR Usage ReportDeleteUsageReport | DELETE | Delete messaging usage report by id |
Fetch all Messaging usage reportsGetMdrUsageReports | GET | Fetch all messaging usage reports. |
Generate and fetch MDR Usage ReportGetMDRUsageReportSync | GET | Generate and fetch messaging usage report synchronously. |
Get an MDR usage reportgetMdrUsageReport | GET | Fetch single MDR usage report by id. |
Get an MDR usage reportgetMdrUsageReport_get_legacy_reporting_usage_reports_messaging_id | GET | Fetch single MDR usage report by id. |
List MDR usage reportsgetMdrUsageReports | GET | Fetch all previous requests for MDR usage reports. |
List MDR usage reportsgetMdrUsageReports_get_legacy_reporting_usage_reports_messaging | GET | Fetch all previous requests for MDR usage reports. |
Retrieve messaging reportGetUsageReport | GET | Fetch a single messaging usage report by id |
Media Storage API6
Deletes stored mediaDeleteMediaStorage | DELETE | Deletes a stored media file. |
Download stored mediaDownloadMedia | GET | Downloads a stored media file. |
List uploaded mediaListMediaStorage | GET | Returns a list of stored media files. |
Retrieve stored mediaGetMediaStorage | GET | Returns the information about a stored media file. |
Update stored mediaUpdateMediaStorage | PUT | Updates a stored media file. |
Upload mediaCreateMediaStorage | POST | Upload media file to Telnyx so it can be used with other Telnyx services |
Message11
Cancel a scheduled messageCancelMessage | DELETE | Cancel a scheduled message that has not yet been sent. |
Retrieve a messageGetMessage | GET | Note: This API endpoint can only retrieve messages that are no older than 10 days since their creation. |
Retrieve group MMS messagesGetGroupMmsMessages | GET | Retrieve all messages in a group MMS conversation by the group message ID. |
Schedule a messageScheduleMessage | POST | Schedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool. |
Send a group MMS messageCreateGroupMmsMessage | POST | |
Send a long code messageCreateLongCodeMessage | POST | |
Send a messageSendMessage | POST | Send a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool. |
Send a message using an alphanumeric sender IDSendAlphanumericSenderIdMessage | POST | Send an SMS message using an alphanumeric sender ID. |
Send a message using an alphanumeric sender IDSendAlphanumericSenderIdMessage_post_messages_alphanumeric_sender_id | POST | Send an SMS message using an alphanumeric sender ID. |
Send a message using number poolCreateNumberPoolMessage | POST | |
Send a short code messageCreateShortCodeMessage | POST |
Messaging15
Create an alphanumeric sender IDCreateAlphanumericSenderId | POST | Create a new alphanumeric sender ID associated with a messaging profile. |
Delete an alphanumeric sender IDDeleteAlphanumericSenderId | DELETE | Delete an alphanumeric sender ID and disassociate it from its messaging profile. |
Get detailed messaging profile metricsGetDetailedProfileMetrics | GET | Get detailed metrics for a specific messaging profile, broken down by time interval. |
Get detailed messaging profile metricsGetDetailedProfileMetrics_get_messaging_profiles_id_metrics | GET | Get detailed metrics for a specific messaging profile, broken down by time interval. |
List alphanumeric sender IDsListAlphanumericSenderIds | GET | List all alphanumeric sender IDs for the authenticated user. |
List alphanumeric sender IDs for a messaging profileListProfileAlphanumericSenderIds | GET | List all alphanumeric sender IDs associated with a specific messaging profile. |
List alphanumeric sender IDs for a messaging profileListProfileAlphanumericSenderIds_get_messaging_profiles_id_alphanumeric_sender_ids | GET | List all alphanumeric sender IDs associated with a specific messaging profile. |
List high-level messaging profile metricsGetProfileMetrics | GET | List high-level metrics for all messaging profiles belonging to the authenticated user. |
List messaging hosted numbersListMessagingHostedNumbers | GET | List all hosted numbers associated with the authenticated user. |
List messaging hosted numbersListMessagingHostedNumbers_get_messaging_hosted_numbers | GET | List all hosted numbers associated with the authenticated user. |
Regenerate messaging profile secretRegenerateMessagingProfileSecret | POST | Regenerate the v1 secret for a messaging profile. |
Regenerate messaging profile secretRegenerateMessagingProfileSecret_post_messaging_profiles_id_actions_regenerate_secret | POST | Regenerate the v1 secret for a messaging profile. |
Retrieve a messaging hosted numberGetMessagingHostedNumber | GET | Retrieve a specific messaging hosted number by its ID or phone number. |
Retrieve an alphanumeric sender IDGetAlphanumericSenderId | GET | Retrieve a specific alphanumeric sender ID. |
Update a messaging hosted numberUpdateMessagingHostedNumber | PATCH | Update the messaging settings for a hosted number. |
Messaging URL Domain1
List messaging URL domainsListMessagingUrlDomains | GET |
Mission41
Add step(s) to planpost_public_missions_missions_mission_id_runs_run_id_plan_steps | POST | Add one or more steps to an existing plan |
Cancel runpost_public_missions_missions_mission_id_runs_run_id_cancel | POST | Cancel a running or paused run |
Clone missionpost_public_missions_missions_mission_id_clone | POST | Clone an existing mission |
Create initial planpost_public_missions_missions_mission_id_runs_run_id_plan | POST | Create the initial plan for a run |
Create knowledge basepost_public_missions_missions_mission_id_knowledge_bases | POST | Create a new knowledge base for a mission |
Create MCP serverpost_public_missions_missions_mission_id_mcp_servers | POST | Create a new MCP server for a mission |
Create missionpost_public_missions_missions | POST | Create a new mission definition |
Create toolpost_public_missions_missions_mission_id_tools | POST | Create a new tool for a mission |
Delete knowledge basedelete_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id | DELETE | Delete a knowledge base from a mission |
Delete MCP serverdelete_public_missions_missions_mission_id_mcp_servers_mcp_server_id | DELETE | Delete an MCP server from a mission |
Delete missiondelete_public_missions_missions_mission_id | DELETE | Delete a mission |
Delete tooldelete_public_missions_missions_mission_id_tools_tool_id | DELETE | Delete a tool from a mission |
Get event detailsget_public_missions_missions_mission_id_runs_run_id_events_event_id | GET | Get details of a specific event |
Get knowledge baseget_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id | GET | Get a specific knowledge base by ID |
Get MCP serverget_public_missions_missions_mission_id_mcp_servers_mcp_server_id | GET | Get a specific MCP server by ID |
Get missionget_public_missions_missions_mission_id | GET | Get a mission by ID (includes tools, knowledge bases, mcp servers) |
Get planget_public_missions_missions_mission_id_runs_run_id_plan | GET | Get the plan (all steps) for a run |
Get run detailsget_public_missions_missions_mission_id_runs_run_id | GET | Get details of a specific run |
Get step detailsget_public_missions_missions_mission_id_runs_run_id_plan_steps_step_id | GET | Get details of a specific plan step |
Get toolget_public_missions_missions_mission_id_tools_tool_id | GET | Get a specific tool by ID |
Link Telnyx agent to runpost_public_missions_missions_mission_id_runs_run_id_telnyx_agents | POST | Link a Telnyx AI agent (voice/messaging) to a run |
List eventsget_public_missions_missions_mission_id_runs_run_id_events | GET | List events for a run (paginated) |
List knowledge basesget_public_missions_missions_mission_id_knowledge_bases | GET | List all knowledge bases for a mission |
List linked Telnyx agentsget_public_missions_missions_mission_id_runs_run_id_telnyx_agents | GET | List all Telnyx agents linked to a run |
List MCP serversget_public_missions_missions_mission_id_mcp_servers | GET | List all MCP servers for a mission |
List missionsget_public_missions_missions | GET | List all missions for the organization |
List recent eventsget_public_missions_missions_events | GET | List recent events across all missions |
List recent runsget_public_missions_missions_runs | GET | List recent runs across all missions |
List runs for missionget_public_missions_missions_mission_id_runs | GET | List all runs for a specific mission |
List toolsget_public_missions_missions_mission_id_tools | GET | List all tools for a mission |
Log eventpost_public_missions_missions_mission_id_runs_run_id_events | POST | Log an event for a run |
Pause runpost_public_missions_missions_mission_id_runs_run_id_pause | POST | Pause a running run |
Resume runpost_public_missions_missions_mission_id_runs_run_id_resume | POST | Resume a paused run |
Start a runpost_public_missions_missions_mission_id_runs | POST | Start a new run for a mission |
Unlink Telnyx agentdelete_public_missions_missions_mission_id_runs_run_id_telnyx_agents_telnyx_agent_id | DELETE | Unlink a Telnyx agent from a run |
Update knowledge baseput_public_missions_missions_mission_id_knowledge_bases_knowledge_base_id | PUT | Update a knowledge base definition |
Update MCP serverput_public_missions_missions_mission_id_mcp_servers_mcp_server_id | PUT | Update an MCP server definition |
Update missionput_public_missions_missions_mission_id | PUT | Update a mission definition |
Update runpatch_public_missions_missions_mission_id_runs_run_id | PATCH | Update run status and/or result |
Update step statuspatch_public_missions_missions_mission_id_runs_run_id_plan_steps_step_id | PATCH | Update the status of a plan step |
Update toolput_public_missions_missions_mission_id_tools_tool_id | PUT | Update a tool definition |
Mobile Network Operator1
List mobile network operatorsGetMobileNetworkOperators | GET | Telnyx has a set of GSM mobile operators partners that are available through our mobile network roaming. |
Mobile Number Setting2
List mobile phone numbers with messaging settingsListMobilePhoneNumbersWithMessagingSettings | GET | |
Retrieve a mobile phone number with messaging settingsGetMobilePhoneNumberMessagingSettings | GET |
Mobile Phone Number3
List Mobile Phone NumberslistMobilePhoneNumbers | GET | |
Retrieve a Mobile Phone NumberretrieveMobilePhoneNumber | GET | |
Update a Mobile Phone NumberupdateMobilePhoneNumber | PATCH |
Mobile Voice Connection5
Create a Mobile Voice ConnectioncreateMobileVoiceConnection | POST | |
Delete a Mobile Voice ConnectiondeleteMobileVoiceConnection | DELETE | |
List Mobile Voice ConnectionslistMobileVoiceConnections | GET | |
Retrieve a Mobile Voice ConnectionretrieveMobileVoiceConnection | GET | |
Update a Mobile Voice ConnectionupdateMobileVoiceConnection | PATCH |
Network9
Create a NetworkCreateNetwork | POST | Create a new Network. |
Create Default Gateway.CreateDefaultGateway | POST | Create Default Gateway. |
Delete a NetworkDeleteNetwork | DELETE | Delete a Network. |
Delete Default Gateway.DeleteDefaultGateway | DELETE | Delete Default Gateway. |
Get Default Gateway status.GetDefaultGateway | GET | Get Default Gateway status. |
List all Interfaces for a Network.ListNetworkInterfaces | GET | List all Interfaces for a Network. |
List all NetworksListNetworks | GET | List all Networks. |
Retrieve a NetworkGetNetwork | GET | Retrieve a Network. |
Update a NetworkUpdateNetwork | PATCH | Update a Network. |
Notification16
Add a Notification SettingCreateNotificationSetting | POST | Add a notification setting. |
Create a notification channelCreateNotificationChannels | POST | Create a notification channel. |
Create a notification profileCreateNotificationProfile | POST | Create a notification profile. |
Delete a notification channelDeleteNotificationChannel | DELETE | Delete a notification channel. |
Delete a notification profileDeleteNotificationProfile | DELETE | Delete a notification profile. |
Delete a notification settingDeleteNotificationSetting | DELETE | Delete a notification setting. |
Get a notification channelGetNotificationChannel | GET | Get a notification channel. |
Get a notification profileGetNotificationProfile | GET | Get a notification profile. |
Get a notification settingGetNotificationSetting | GET | Get a notification setting. |
List all Notifications EventsFindNotificationsEvents | GET | Returns a list of your notifications events. |
List all Notifications Events ConditionsFindNotificationsEventsConditions | GET | Returns a list of your notifications events conditions. |
List all Notifications ProfilesFindNotificationsProfiles | GET | Returns a list of your notifications profiles. |
List notification channelsListNotificationChannels | GET | List notification channels. |
List notification settingsListNotificationSettings | GET | List notification settings. |
Update a notification channelUpdateNotificationChannel | PATCH | Update a notification channel. |
Update a notification profileUpdateNotificationProfile | PATCH | Update a notification profile. |
Number Lookup1
Lookup phone number dataLookupNumber | GET | Returns information about the provided phone number. |
Number Portout14
Create a comment on a portout requestPostPortRequestComment | POST | Creates a comment on a portout request. |
Create a list of supporting documents on a portout requestPostPortRequestSupportingDocuments | POST | Creates a list of supporting documents on a portout request. |
Create a port-out related reportCreatePortoutReport | POST | Generate reports about port-out operations. |
Get a portout requestFindPortoutRequest | GET | Returns the portout request based on the ID provided |
List all comments for a portout requestFindPortoutComments | GET | Returns a list of comments for a portout request. |
List all port-out eventslistPortoutEvents | GET | Returns a list of all port-out events. |
List eligible port-out rejection codes for a specific orderListPortoutRejections | GET | Given a port-out ID, list rejection codes that are eligible for that port-out |
List port-out related reportsListPortoutReports | GET | List the reports generated about port-out operations. |
List portout requestsListPortoutRequest | GET | Returns the portout requests according to filters |
List supporting documents on a portout requestGetPortRequestSupportingDocuments | GET | List every supporting documents for a portout request. |
Republish a port-out eventrepublishPortoutEvent | POST | Republish a specific port-out event. |
Retrieve a reportGetPortoutReport | GET | Retrieve a specific report generated. |
Show a port-out eventshowPortoutEvent | GET | Show a specific port-out event. |
Update StatusUpdatePortoutStatus | PATCH | Authorize or reject portout request |
Number Setting7
Bulk update phone number profilesBulkUpdateMessagingSettingsOnPhoneNumbers | POST | |
Bulk update phone number profilesBulkUpdateMessagingSettingsOnPhoneNumbers_post_messaging_numbers_bulk_updates | POST | |
List phone numbers with messaging settingsListPhoneNumbersWithMessagingSettings | GET | |
Retrieve a phone number with messaging settingsGetPhoneNumberMessagingSettings | GET | |
Retrieve bulk update statusGetBulkUpdateMessagingSettingsOnPhoneNumbersStatus | GET | |
Retrieve bulk update statusGetBulkUpdateMessagingSettingsOnPhoneNumbersStatus_get_messaging_numbers_bulk_updates_order_id | GET | |
Update the messaging profile and/or messaging product of aUpdatePhoneNumberMessagingSettings | PATCH |
Numbers Feature1
Retrieve the features for a list of numbersPostNumbersFeatures | POST | Retrieve the features for a list of numbers |
OAuth Client10
Create OAuth clientCreateOAuthClient | POST | Create a new OAuth client |
Create OAuth clientCreateOAuthClient_post_oauth_clients | POST | Create a new OAuth client |
Delete OAuth clientDeleteOAuthClient | DELETE | Delete an OAuth client |
Delete OAuth clientDeleteOAuthClient_delete_oauth_clients_id | DELETE | Delete an OAuth client |
Get OAuth clientGetOAuthClient | GET | Retrieve a single OAuth client by ID |
Get OAuth clientGetOAuthClient_get_oauth_clients_id | GET | Retrieve a single OAuth client by ID |
List OAuth clientsListOAuthClients | GET | Retrieve a paginated list of OAuth clients for the authenticated user |
List OAuth clientsListOAuthClients_get_oauth_clients | GET | Retrieve a paginated list of OAuth clients for the authenticated user |
Update OAuth clientUpdateOAuthClient | PUT | Update an existing OAuth client |
Update OAuth clientUpdateOAuthClient_put_oauth_clients_id | PUT | Update an existing OAuth client |
OAuth Discovery2
Authorization server metadataGetOAuthAuthorizationServerMetadata | GET | OAuth 2.0 Authorization Server Metadata (RFC 8414) |
Protected resource metadataGetOAuthProtectedResourceMetadata | GET | OAuth 2.0 Protected Resource Metadata for resource discovery |
OAuth Grant6
Get OAuth grantGetOAuthGrant | GET | Retrieve a single OAuth grant by ID |
Get OAuth grantGetOAuthGrant_get_oauth_grants_id | GET | Retrieve a single OAuth grant by ID |
List OAuth grantsListOAuthGrants | GET | Retrieve a paginated list of OAuth grants for the authenticated user |
List OAuth grantsListOAuthGrants_get_oauth_grants | GET | Retrieve a paginated list of OAuth grants for the authenticated user |
Revoke OAuth grantRevokeOAuthGrant | DELETE | Revoke an OAuth grant |
Revoke OAuth grantRevokeOAuthGrant_delete_oauth_grants_id | DELETE | Revoke an OAuth grant |
OAuth Protocol7
Create OAuth grantCreateOAuthGrant | POST | Create an OAuth authorization grant |
Dynamic client registrationRegisterOAuthClient | POST | Register a new OAuth client dynamically (RFC 7591) |
Get OAuth consent tokenGetOAuthConsentToken | GET | Retrieve details about an OAuth consent token |
JSON Web Key SetGetOAuthJWKS | GET | Retrieve the JSON Web Key Set for token verification |
OAuth authorization endpointAuthorizeOAuth | GET | OAuth 2.0 authorization endpoint for the authorization code flow |
OAuth token endpointExchangeOAuthToken | POST | Exchange authorization code, client credentials, or refresh token for access token |
Token introspectionIntrospectOAuthToken | POST | Introspect an OAuth access token to check its validity and metadata |
OpenAI Chat3
Create a chat completion (OpenAI-compatible)create_openai_chat_completion | POST | Chat with a language model. |
Create an OpenAI-compatible responsechat_public_openai_responses_completions_post | POST | Create a response using Telnyx's OpenAI-compatible Responses API. |
Get available models (OpenAI-compatible)list_openai_models | GET | 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,... |
OpenAI Embedding2
Create embeddingscreate_openai_embeddings | POST | Creates an embedding vector representing the input text. |
List embedding modelslist_openai_embedding_models | GET | Returns a list of available embedding models. |
Opt Out Management6
Create auto-response settingCreateAutorespConfig | POST | |
Delete Auto-Response SettingDeleteAutorespConfig | DELETE | |
Get Auto-Response SettingGetAutorespConfig | GET | |
List Auto-Response SettingsGetAutorespConfigs | GET | |
List opt-outsListOptOuts | GET | Retrieve a list of opt-out blocks. |
Update Auto-Response SettingUpdateAutoRespConfig | PUT |
Organization User4
Delete organization userDeleteOrganizationUser | POST | Deletes a user in your organization. |
Get organization userGetOrganizationUser | GET | Returns a user in your organization. |
Get organization users groups reportGetOrganizationUsersGroupsReport | GET | Returns a report of all users in your organization with their group memberships. |
List organization usersListOrganizationUsers | GET | Returns a list of the users in your organization. |
OTA Update2
Get OTA updateGetOtaUpdate | GET | This API returns the details of an Over the Air (OTA) update. |
List OTA updatesListOtaUpdates | GET |
Outbound Voice Profile5
Create an outbound voice profileCreateVoiceProfile | POST | Create an outbound voice profile. |
Delete an outbound voice profileDeleteOutboundVoiceProfile | DELETE | Deletes an existing outbound voice profile. |
Get all outbound voice profilesListOutboundVoiceProfiles | GET | Get all outbound voice profiles belonging to the user that match the given filters. |
Retrieve an outbound voice profileGetOutboundVoiceProfile | GET | Retrieves the details of an existing outbound voice profile. |
Updates an existing outbound voice profile.UpdateOutboundVoiceProfile | PATCH | Updates an existing outbound voice profile. |
Phone Number3
Add phone numbers to a DIRaddDirPhoneNumbersSimplified | POST | Register phone numbers under a DIR. |
List phone numbers attached to a DIRlistDirPhoneNumbersSimplified | GET | List the phone numbers registered under a DIR. |
Remove phone numbers from a DIRdeleteDirPhoneNumbersSimplified | DELETE | Deregister phone numbers from a DIR. |
Phone Number Batch2
Get a phone-number batchgetDirPhoneNumberBatchSimplified | GET | Get a single phone-number batch by id. |
List phone-number batches for a DIRlistDirPhoneNumberBatchesSimplified | GET | List the phone-number batches submitted under a DIR. |
Phone Number Block Order3
Create a number block orderCreateNumberBlockOrder | POST | Creates a phone number block order. |
List number block ordersListNumberBlockOrders | GET | Get a paginated list of number block orders. |
Retrieve a number block orderRetrieveNumberBlockOrder | GET | Get an existing phone number block order. |
Phone Number Blocks Background Job3
Deletes all numbers associated with a phone number blockCreatePhoneNumberBlockDeletionJob | POST | Creates a new background job to delete all the phone numbers associated with the given block. |
Lists the phone number blocks jobsListPhoneNumberBlocksJobs | GET | |
Retrieves a phone number blocks jobGetPhoneNumberBlocksJob | GET |
Phone Number Campaign5
Create New Phone Number CampaignCreatePhoneNumberCampaign | POST | |
Create New Phone Number CampaignPutPhoneNumberCampaign | PUT | |
Delete Phone Number CampaignDeletePhoneNumberCampaign | DELETE | This endpoint allows you to remove a campaign assignment from the supplied phoneNumber. |
Get Single Phone Number CampaignGetSinglePhoneNumberCampaign | GET | Retrieve an individual phone number/campaign assignment by phoneNumber. |
List phone number campaignsGetAllPhoneNumberCampaigns | GET |
Phone Number Configuration11
Change the bundle status for a phone number (set to being in aPhoneNumberBundleStatusChange | PATCH | |
Delete a phone numberDeletePhoneNumber | DELETE | |
Enable emergency for a phone numberEnablePhoneNumberEmergency | POST | |
List phone numbersListPhoneNumbers | GET | |
List phone numbers with voice settingsListPhoneNumbersWithVoiceSettings | GET | |
Retrieve a phone numberRetrievePhoneNumber | GET | |
Retrieve a phone number with voice settingsGetPhoneNumberVoiceSettings | GET | |
Slim List phone numbersSlimListPhoneNumbers | GET | List phone numbers, This endpoint is a lighter version of the /phone numbers endpoint having higher performance and rate limit. |
Update a phone numberUpdatePhoneNumber | PATCH | |
Update a phone number with voice settingsUpdatePhoneNumberVoiceSettings | PATCH | |
Verify ownership of phone numbersVerifyPhoneNumberOwnership | POST | Verifies ownership of the provided phone numbers and returns a mapping of numbers to their IDs, plus a list of numbers not found in the account. |
Phone Number Order21
Cancel a sub number orderCancelSubNumberOrder | PATCH | Allows you to cancel a sub number order in 'pending' status. |
Create a commentCreateComment | POST | |
Create a number orderCreateNumberOrder | POST | Creates a phone number order. |
Create a sub number orders reportCreateSubNumberOrdersReport | POST | Create a CSV report for sub number orders. |
Create a sub number orders reportCreateSubNumberOrdersReport_post_sub_number_orders_report | POST | Create a CSV report for sub number orders. |
Download a sub number orders reportDownloadSubNumberOrdersReport | GET | Download the CSV file for a completed sub number orders report. |
Download a sub number orders reportDownloadSubNumberOrdersReport_get_sub_number_orders_report_report_id_download | GET | Download the CSV file for a completed sub number orders report. |
List number ordersListNumberOrders | GET | Get a paginated list of number orders. |
List sub number ordersListSubNumberOrders | GET | Get a paginated list of sub number orders. |
Mark a comment as readMarkCommentRead | PATCH | |
Retrieve a commentRetrieveComment | GET | |
Retrieve a list of phone numbers associated to ordersRetrieveOrderPhoneNumbers | GET | Get a list of phone numbers associated to orders. |
Retrieve a number orderRetrieveNumberOrder | GET | Get an existing phone number order. |
Retrieve a single phone number within a number order.GetNumberOrderPhoneNumber | GET | Get an existing phone number in number order. |
Retrieve a sub number orderGetSubNumberOrder | GET | Get an existing sub number order. |
Retrieve a sub number orders reportGetSubNumberOrdersReport | GET | Get the status and details of a sub number orders report. |
Retrieve a sub number orders reportGetSubNumberOrdersReport_get_sub_number_orders_report_report_id | GET | Get the status and details of a sub number orders report. |
Retrieve all commentsListComments | GET | |
Update a number orderUpdateNumberOrder | PATCH | Updates a phone number order. |
Update a sub number order's requirementsUpdateSubNumberOrder | PATCH | Updates a sub number order. |
Update requirements for a single phone number within a numberUpdateNumberOrderPhoneNumber | PATCH | Updates requirements for a single phone number within a number order. |
Phone Number Porting1
Run a portability checkPostPortabilityCheck | POST | Runs a portability check, returning the results immediately. |
Phone Number Reservation4
Create a number reservationCreateNumberReservation | POST | Creates a Phone Number Reservation for multiple numbers. |
Extend a number reservationExtendNumberReservationExpiryTime | POST | Extends reservation expiry time on all phone numbers. |
List number reservationsListNumberReservations | GET | Gets a paginated list of phone number reservations. |
Retrieve a number reservationRetrieveNumberReservation | GET | Gets a single phone number reservation. |
Phone Number Search2
List available phone number blocksListAvailablePhoneNumberBlocks | GET | |
List available phone numbersListAvailablePhoneNumbers | GET |
Porting Order53
Activate every number in a porting order asynchronously.ActivatePortingOrder | POST | Activate each number in a porting order asynchronously. |
Cancel a porting orderCancelPortingOrder | POST | Cancel a porting order |
Create a comment for a porting orderCreatePortingOrderComment | POST | Creates a new comment for a porting order. |
Create a list of additional documentsCreateAdditionalDocuments | POST | Creates a list of additional documents for a porting order. |
Create a list of phone number configurationsCreatePhoneNumberConfigurations | POST | Creates a list of phone number configurations. |
Create a LOA configurationCreateLoaConfiguration | POST | Create a LOA configuration. |
Create a phone number blockcreatePortingPhoneNumberBlock | POST | Creates a new phone number block. |
Create a phone number extensioncreatePortingPhoneNumberExtension | POST | Creates a new phone number extension. |
Create a porting orderCreatePortingOrder | POST | Creates a new porting order object. |
Create a porting related reportCreatePortingReport | POST | Generate reports about porting operations. |
Create an associated phone numbercreatePortingAssociatedPhoneNumber | POST | Creates a new associated phone number for a porting order. |
Delete a LOA configurationDeleteLoaConfiguration | DELETE | Delete a specific LOA configuration. |
Delete a phone number blockdeletePortingPhoneNumberBlock | DELETE | Deletes a phone number block. |
Delete a phone number extensiondeletePortingPhoneNumberExtension | DELETE | Deletes a phone number extension. |
Delete a porting orderDeletePortingOrder | DELETE | Deletes an existing porting order. |
Delete an additional documentDeleteAdditionalDocument | DELETE | Deletes an additional document for a porting order. |
Delete an associated phone numberdeletePortingAssociatedPhoneNumber | DELETE | Deletes an associated phone number from a porting order. |
Download a porting order loa templateGetPortingOrderLoaTemplate | GET | Download a porting order loa template |
Edit a porting orderUpdatePortingOrder | PATCH | Edits the details of an existing porting order. |
Initiate an action requirementinitiatePortingActionRequirement | POST | Initiates a specific action requirement for a porting order. |
List action requirements for a porting orderlistPortingActionRequirements | GET | Returns a list of action requirements for a specific porting order. |
List additional documentsListAdditionalDocuments | GET | Returns a list of additional documents for a porting order. |
List all associated phone numberslistPortingAssociatedPhoneNumbers | GET | Returns a list of all associated phone numbers for a porting order. |
List all comments of a porting orderListPortingOrderComments | GET | Returns a list of all comments of a porting order. |
List all exception typesListExceptionTypes | GET | Returns a list of all possible exception types for a porting order. |
List all phone number blockslistPortingPhoneNumberBlocks | GET | Returns a list of all phone number blocks of a porting order. |
List all phone number configurationsListPhoneNumberConfigurations | GET | Returns a list of phone number configurations paginated. |
List all phone number extensionslistPortingPhoneNumberExtensions | GET | Returns a list of all phone number extensions of a porting order. |
List all porting activation jobsListPortingOrderActivationJobs | GET | Returns a list of your porting activation jobs. |
List all porting eventslistPortingEvents | GET | Returns a list of all porting events. |
List all porting ordersListPortingOrders | GET | Returns a list of your porting order. |
List all porting phone numbersListPortingPhoneNumbers | GET | Returns a list of your porting phone numbers. |
List allowed FOC datesListAllowedFocWindows | GET | Returns a list of allowed FOC dates for a porting order. |
List available carriers in the UKlistPortingUKCarriers | GET | List available carriers in the UK. |
List LOA configurationsListLoaConfigurations | GET | List the LOA configurations. |
List porting order requirementsListPortingOrderRequirements | GET | Returns a list of all requirements based on country/number type for this porting order. |
List porting related reportsListPortingReports | GET | List the reports generated about porting operations. |
List verification codesListVerificationCodes | GET | Returns a list of verification codes for a porting order. |
Preview a LOA configurationPreviewLoaConfiguration | GET | Preview a specific LOA configuration. |
Preview the LOA configuration parametersPreviewLoaConfigurationParams | POST | Preview the LOA template that would be generated without need to create LOA configuration. |
Republish a porting eventrepublishPortingEvent | POST | Republish a specific porting event. |
Retrieve a LOA configurationGetLoaConfiguration | GET | Retrieve a specific LOA configuration. |
Retrieve a porting activation jobGetPortingOrdersActivationJob | GET | Returns a porting activation job. |
Retrieve a porting orderGetPortingOrder | GET | Retrieves the details of an existing porting order. |
Retrieve a reportGetPortingReport | GET | Retrieve a specific report generated. |
Retrieve the associated V1 sub_request_id and port_request_idGetPortingOrderSubRequest | GET | Retrieve the associated V1 sub request id and port request id |
Send the verification codesSendPortingVerificationCodes | POST | Send the verification code for all porting phone numbers. |
Share a porting orderSharePortingOrder | POST | Creates a sharing token for a porting order. |
Show a porting eventshowPortingEvent | GET | Show a specific porting event. |
Submit a porting order.ConfirmPortingOrder | POST | Confirm and submit your porting order. |
Update a LOA configurationUpdateLoaConfiguration | PATCH | Update a specific LOA configuration. |
Update a porting activation jobUpdatePortingOrdersActivationJob | PATCH | Updates the activation time of a porting activation job. |
Verify the verification code for a list of phone numbersVerifyPortingVerificationCodes | POST | Verifies the verification code for a list of phone numbers. |
Presigned Object URL1
Create Presigned Object URLCreatePresignedObjectUrl | POST | Returns a timed and authenticated URL to download (GET) or upload (PUT) an object. |
Pricing2
Get product pricinggetProductPricing | GET | Returns pricing entries for a single product. |
List productslistPricingProducts | GET | Returns the full product catalog with pagination. |
Private Wireless Gateway4
Create a Private Wireless GatewayCreatePrivateWirelessGateway | POST | Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network. |
Delete a Private Wireless GatewayDeleteWirelessGateway | DELETE | Deletes the Private Wireless Gateway. |
Get a Private Wireless GatewayGetPrivateWirelessGateway | GET | Retrieve information about a Private Wireless Gateway. |
Get all Private Wireless GatewaysGetPrivateWirelessGateways | GET | Get all Private Wireless Gateways belonging to the user. |
Profile7
Create a messaging profileCreateMessagingProfile | POST | |
Delete a messaging profileDeleteMessagingProfile | DELETE | |
List messaging profilesListMessagingProfiles | GET | |
List phone numbers associated with a messaging profileListProfilePhoneNumbers | GET | |
List short codes associated with a messaging profileListProfileShortCodes | GET | |
Retrieve a messaging profileRetrieveMessagingProfile | GET | |
Update a messaging profileUpdateMessagingProfile | PATCH |
Programmable Fax Application5
Creates a Fax ApplicationCreateFaxApplication | POST | Creates a new Fax Application based on the parameters sent in the request. |
Deletes a Fax ApplicationDeleteFaxApplication | DELETE | Permanently deletes a Fax Application. |
List all Fax ApplicationsListFaxApplications | GET | This endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. |
Retrieve a Fax ApplicationGetFaxApplication | GET | Return the details of an existing Fax Application inside the 'data' attribute of the response. |
Update a Fax ApplicationUpdateFaxApplication | PATCH | Updates settings of an existing Fax Application based on the parameters of the request. |
Programmable Fax Command6
Cancel a faxCancelFax | POST | Cancel the outbound fax that is in one of the following states: queued, media.processed, originated or sending |
Delete a faxDeleteFax | DELETE | |
Refresh a faxRefreshFax | POST | Refreshes the inbound fax's media url when it has expired |
Send a faxSendFax | POST | Send a fax. |
View a faxViewFax | GET | |
View a list of faxesListFaxes | GET |
Pronunciation Dictionary5
Create a pronunciation dictionaryCreatePronunciationDict | POST | Create a new pronunciation dictionary for the authenticated organization. |
Delete a pronunciation dictionaryDeletePronunciationDict | DELETE | Permanently delete a pronunciation dictionary. |
Get a pronunciation dictionaryGetPronunciationDict | GET | Retrieve a single pronunciation dictionary by ID. |
List pronunciation dictionariesListPronunciationDicts | GET | List all pronunciation dictionaries for the authenticated organization. |
Update a pronunciation dictionaryUpdatePronunciationDict | PATCH | Update the name and/or items of an existing pronunciation dictionary. |
Public Internet Gateway4
Create a Public Internet GatewayCreatePublicInternetGateway | POST | Create a new Public Internet Gateway. |
Delete a Public Internet GatewayDeletePublicInternetGateway | DELETE | Delete a Public Internet Gateway. |
List all Public Internet GatewaysListPublicInternetGateways | GET | List all Public Internet Gateways. |
Retrieve a Public Internet GatewayGetPublicInternetGateway | GET | Retrieve a Public Internet Gateway. |
Push Credential4
Creates a new mobile push credentialCreatePushCredential | POST | Creates a new mobile push credential |
Deletes a mobile push credentialDeletePushCredentialById | DELETE | Deletes a mobile push credential based on the given push credential id |
List mobile push credentialsListPushCredentials | GET | List mobile push credentials |
Retrieves a mobile push credentialGetPushCredentialById | GET | Retrieves mobile push credential based on the given push credential id |
Queue Command9
Create a queueCreateQueue | POST | Create a new call queue. |
Delete a queueDeleteQueue | DELETE | Delete an existing call queue. |
Force remove a call from a queueRemoveQueueCall | DELETE | Removes an inactive call from a queue. |
List queuesListQueues | GET | List all queues for the authenticated user. |
Retrieve a call from a queueRetrieveCallFromQueue | GET | Retrieve an existing call from an existing queue |
Retrieve a call queueRetrieveCallQueue | GET | Retrieve an existing call queue |
Retrieve calls from a queueListQueueCalls | GET | Retrieve the list of calls in an existing queue |
Update a queueUpdateQueue | POST | Update properties of an existing call queue. |
Update queued callUpdateCallInQueue | PATCH | Update queued call's keep after hangup flag |
RCS9
Add RCS test numberInviteATestNumberToRCS | PUT | Adds a test phone number to an RCS agent for testing purposes. |
Check RCS capabilitiesListRCSCapabilitiesOfAPhoneNumber | GET | |
Check RCS capabilities (batch)ListRCSCapabilitiesOfAPhoneNumbersBatch | POST | |
Generate RCS deeplinkGenerateRCSDeeplink | GET | Generate a deeplink URL that can be used to start an RCS conversation with a specific agent. |
Generate RCS deeplinkGenerateRCSDeeplink_get_messages_rcs_deeplinks_agent_id | GET | Generate a deeplink URL that can be used to start an RCS conversation with a specific agent. |
List all RCS agentsListRCSAgents | GET | |
Modify an RCS agentUpdateRCSAgentById | PATCH | |
Retrieve an RCS agentGetRCSAgentById | GET | |
Send an RCS messageSendRCSMessage | POST |
Reference Data3
List standard call reasonslistCallReasons | GET | Telnyx maintains a library of pre-vetted call-reason phrases (e.g. "Appointment reminders", "Billing inquiries") that carry through DIR vetting smoothly. |
List supported DIR document typeslistDocumentTypes | GET | Reference list of document type values accepted by DirCreateRequest.documents[].document type and the infringement-contest endpoint. |
Validate a list of call reasonsvalidateCallReasons | POST | Check up to 10 candidate call reasons strings against Telnyx's vetting heuristics before sending them on a DIR create or update. |
Region1
List all RegionsListRegions | GET | List all regions and the interfaces that region supports |
Regulatory Requirement3
Retrieve regulatory requirementsListRegulatoryRequirements | GET | |
Retrieve regulatory requirements for a list of phone numbersListRegulatoryRequirementsPhoneNumbers | GET | |
Retrieve regulatory requirements for a list of phone numbersListRegulatoryRequirementsPhoneNumbers_get_phone_numbers_regulatory_requirements | GET |
Report2
Create a ledger billing group reportCreateBillingGroupReport | POST | |
Get a ledger billing group reportGetBillingGroupReport | GET |
Reporting8
Create a Wireless Detail Records (WDRs) ReportCreateWdrReport | POST | Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period. |
Create a Wireless Detail Records (WDRs) ReportCreateWdrReport_post_wireless_detail_records_reports | POST | Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period. |
Delete a Wireless Detail Record (WDR) ReportDeleteWdrReport | DELETE | Deletes one specific WDR report. |
Delete a Wireless Detail Record (WDR) ReportDeleteWdrReport_delete_wireless_detail_records_reports_id | DELETE | Deletes one specific WDR report. |
Get a Wireless Detail Record (WDR) ReportGetWdrReport | GET | Returns one specific WDR report |
Get a Wireless Detail Record (WDR) ReportGetWdrReport_get_wireless_detail_records_reports_id | GET | Returns one specific WDR report |
Get all Wireless Detail Records (WDRs) ReportsGetWdrReports | GET | Returns the WDR Reports that match the given parameters. |
Get all Wireless Detail Records (WDRs) ReportsGetWdrReports_get_wireless_detail_records_reports | GET | Returns the WDR Reports that match the given parameters. |
Reputation17
Change the reputation refresh frequencyupdateReputationFrequency | PATCH | Update how often Telnyx refreshes the reputation data for this enterprise's registered numbers. |
Disable phone-number reputation for an enterprisedisableReputationSettings | DELETE | Disable Phone Number Reputation. |
Enable phone-number reputation for an enterpriseenableReputationSettings | POST | Activate Phone Number Reputation for the given enterprise. |
Force a reputation refreshrefreshReputationNumbers | POST | Immediately refresh the stored reputation data for the listed numbers. |
Get a reputation remediation requestgetReputationRemediation | GET | Retrieve the full detail of a remediation request, including current status, per-number results (once available), and submission metadata. |
Get a reputation-monitored number (no enterprise_id required)getPhoneNumberReputationSimplified | GET | Convenience alias for GET /v2/enterprises/{enterprise id}/reputation/numbers/{phone number}. |
Get a single reputation-monitored phone numbergetPhoneNumberReputation | GET | Retrieve one registered number with its latest reputation snapshot. |
Get phone-number reputation settings for an enterprisegetReputationSettings | GET | Phone Number Reputation tracks how your outbound caller-IDs are perceived (spam risk, engagement, etc.) across the call-screening ecosystem. |
List reputation remediation requests for an enterpriselistReputationRemediations | GET | Paginated list of remediation requests for this enterprise. |
List reputation-monitored phone numbers across all enterpriseslistReputationNumbersSimplified | GET | Convenience alias for GET /v2/enterprises/{enterprise id}/reputation/numbers that returns numbers across every enterprise you own. |
List reputation-monitored phone numbers for an enterpriselistReputationNumbers | GET | Paginated list of phone numbers registered for reputation monitoring under this enterprise. |
Register phone numbers for reputation monitoringassociateReputationNumbers | POST | Add up to 100 phone numbers to reputation monitoring on this enterprise. |
Remove a phone number from reputation monitoringdisassociateReputationNumber | DELETE | Stop tracking the reputation of this phone number. |
Remove a phone number from reputation monitoring (nodisassociateReputationNumberSimplified | DELETE | Convenience alias for DELETE /v2/enterprises/{enterprise id}/reputation/numbers/{phone number}. |
Render a phone-number reputation Letter of AuthorizationgenerateReputationLoa | POST | Render the LOA for this enterprise as a PDF. |
Replace the reputation Letter of Authorization documentreplaceReputationLoa | PATCH | Point the enterprise's reputation settings at a new signed LOA document. |
Submit phone numbers for reputation remediationsubmitReputationRemediation | POST | Submit a batch of phone numbers belonging to this enterprise for reputation remediation. |
Requirement4
Cancel a pending requirement versionCancelPendingRequirementVersion | DELETE | Cancel a pending requirement version. |
List all requirementsListRequirements | GET | List all requirements with filtering, sorting, and pagination |
Retrieve a document requirementRetrieveDocumentRequirements | GET | Retrieve a document requirement record |
Schedule a future requirement versionCreateRequirementVersion | POST | Create a new pending version of a requirement with a future effective start date. |
Requirement Group8
Create a new requirement groupCreateRequirementGroup | POST | |
Delete a requirement group by IDDeleteRequirementGroup | DELETE | |
Get a single requirement group by IDGetRequirementGroup | GET | |
List requirement groupsGetRequirementGroups | GET | |
Submit a Requirement Group for ApprovalSubmitRequirementGroup | POST | |
Update requirement group for a phone number orderupdateNumberOrderPhoneNumberRequirementGroup | POST | |
Update requirement group for a sub number orderupdateSubNumberOrderRequirementGroup | POST | |
Update requirement values in requirement groupUpdateRequirementGroup | PATCH |
Requirement Type2
List all requirement typesListRequirementTypes | GET | List all requirement types ordered by created at descending |
Retrieve a requirement typesRetrieveRequirementType | GET | Retrieve a requirement type by id |
Room6
Create a room.CreateRoom | POST | Synchronously create a Room. |
Delete a room.DeleteRoom | DELETE | Synchronously delete a Room. |
Update a room.UpdateRoom | PATCH | Synchronously update a Room. |
View a list of room sessions.RetrieveListRoomSessions | GET | |
View a list of rooms.ListRooms | GET | |
View a room.ViewRoom | GET |
Room Composition4
Create a room composition.CreateRoomComposition | POST | Asynchronously create a room composition. |
Delete a room composition.DeleteRoomComposition | DELETE | Synchronously delete a room composition. |
View a list of room compositions.ListRoomCompositions | GET | |
View a room composition.ViewRoomComposition | GET |
Room Participant2
View a list of room participants.ListRoomParticipants | GET | |
View a room participant.ViewRoomParticipant | GET |
Room Recording4
Delete a room recording.DeleteRoomRecording | DELETE | Synchronously delete a Room Recording. |
Delete several room recordings in a bulk.DeleteRoomRecordings | DELETE | |
View a list of room recordings.ListRoomRecordings | GET | |
View a room recording.ViewRoomRecording | GET |
Room Session7
End a room session.EndSession | POST | Note: this will also kick all participants currently present in the room |
Kick participants from a room session.KickParticipantInSession | POST | |
Mute participants in room session.MuteParticipantInSession | POST | |
Unmute participants in room session.UnmuteParticipantInSession | POST | |
View a list of room participants.RetrieveListRoomParticipants | GET | |
View a list of room sessions.ListRoomSessions | GET | |
View a room session.ViewRoomSession | GET |
Rooms Client Token2
Create Client Token to join a room.CreateRoomClientToken | POST | Synchronously create an Client Token to join a Room. |
Refresh Client Token to join a room.RefreshRoomClientToken | POST | Synchronously refresh an Client Token to join a Room. |
Session Analysis3
Get metadata overviewGetSessionAnalysisMetadata | GET | Returns all available record types and supported query parameters for session analysis. |
Get record type metadataGetSessionAnalysisRecordTypeMetadata | GET | Returns detailed metadata for a specific record type, including relationships and examples. |
Get session analysisGetSessionAnalysis | GET | Retrieves a full session analysis tree for a given event, including costs, child events, and product linkages. |
SETI Observability1
Retrieve Black Box Test ResultsGetBlackBoxTestResults | GET | Returns the results of the various black box tests |
Shared Campaign5
Get Sharing StatusGetPartnerCampaignSharingStatus | GET | |
Get Single Shared CampaignGetSharedCampaign | GET | Retrieve campaign details by campaignId. |
List Shared CampaignsGetSharedCampaigns | GET | Retrieve all partner campaigns you have shared to Telnyx in a paginated fashion. |
List shared partner campaignsGetPartnerCampaignsSharedByUser | GET | Get all partner campaigns you have shared to Telnyx in a paginated fashion |
Update Single Shared CampaignUpdateSharedCampaign | PATCH | Update campaign details by campaignId. |
Short Code3
List short codesListShortCodes | GET | |
Retrieve a short codeRetrieveShortCode | GET | |
Update short codeUpdateShortCode | PATCH | Update the settings for a specific short code. |
SIM Card24
Create a new SIM card data usage notificationPostSimCardDataUsageNotification | POST | Creates a new SIM card data usage notification. |
Delete SIM card data usage notificationsDeleteSimCardDataUsageNotifications | DELETE | Delete the SIM Card Data Usage Notification. |
Deletes a SIM cardDeleteSimCard | DELETE | The SIM card will be decommissioned, removed from your account and you will stop being charged. |
Get a single SIM card data usage notificationGetSimCardDataUsageNotification | GET | Get a single SIM Card Data Usage Notification. |
Get activation code for an eSIMGetSimCardActivationCode | GET | It returns the activation code for an eSIM. |
Get all SIM cardsGetSimCards | GET | Get all SIM cards belonging to the user that match the given filters. |
Get SIM cardGetSimCard | GET | Returns the details regarding a specific SIM card. |
Get SIM card device detailsGetSimCardDeviceDetails | GET | It returns the device details where a SIM card is currently being used. |
Get SIM card public IP definitionGetSimCardPublicIp | GET | It returns the public IP requested for a SIM card. |
List SIM card data usage notificationsListDataUsageNotifications | GET | Lists a paginated collection of SIM card data usage notifications. |
List wireless connectivity logsGetWirelessConnectivityLogs | GET | This API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes. |
Purchase eSIMsPurchaseESim | POST | Purchases and registers the specified amount of eSIMs to the current user's account. |
Register SIM cardsRegisterSimCards | POST | Register the SIM cards associated with the provided registration codes to the current user's account. |
Request a SIM card disableDisableSimCard | POST | This API disables a SIM card, disconnecting it from the network and making it impossible to consume data. |
Request a SIM card enableEnableSimCard | POST | This API enables a SIM card, connecting it to the network and making it possible to consume data. |
Request bulk disabling voice on SIM cards.DisableVoiceBulk | POST | This API triggers an asynchronous operation to disable voice on SIM cards belonging to a specified SIM Card Group. |
Request bulk enabling voice on SIM cards.EnableVoiceBulk | POST | This API triggers an asynchronous operation to enable voice on SIM cards belonging to a specified SIM Card Group. |
Request bulk setting SIM card public IPs.SetPublicIPsBulk | POST | This API triggers an asynchronous operation to set a public IP for each of the specified SIM cards. |
Request removing a SIM card public IPRemoveSimCardPublicIp | POST | This API removes an existing public IP from a SIM card. |
Request setting a SIM card public IPSetSimCardPublicIp | POST | This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card. |
Request setting a SIM card to standbySetSimCardStandby | POST | The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data. |
Update a SIM cardUpdateSimCard | PATCH | Updates SIM card data |
Updates information for a SIM Card Data Usage NotificationPatchSimCardDataUsageNotification | PATCH | Updates information for a SIM Card Data Usage Notification. |
Validate SIM cards registration codesValidateRegistrationCodes | POST | It validates whether SIM card registration codes are valid or not. |
SIM Card Action4
Get bulk SIM card action detailsGetBulkSimCardAction | GET | This API fetches information about a bulk SIM card action. |
Get SIM card action detailsGetSimCardAction | GET | This API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation. |
List bulk SIM card actionsListBulkSimCardActions | GET | This API lists a paginated collection of bulk SIM card actions. |
List SIM card actionsListSimCardActions | GET | This API lists a paginated collection of SIM card actions. |
SIM Card Group9
Create a SIM card groupCreateSimCardGroup | POST | Creates a new SIM card group object |
Delete a SIM card groupDeleteSimCardGroup | DELETE | Permanently deletes a SIM card group |
Get all SIM card groupsGetAllSimCardGroups | GET | Get all SIM card groups belonging to the user that match the given filters. |
Get SIM card groupGetSimCardGroup | GET | Returns the details regarding a specific SIM card group |
Request Private Wireless Gateway assignment for SIM card groupSetPrivateWirelessGatewayForSimCardGroup | POST | This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. |
Request Private Wireless Gateway removal from SIM card groupRemoveSimCardGroupPrivateWirelessGateway | POST | This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. |
Request Wireless Blocklist assignment for SIM card groupSetWirelessBlocklistForSimCardGroup | POST | This action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group. |
Request Wireless Blocklist removal from SIM card groupRemoveWirelessBlocklistForSimCardGroup | POST | This action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group. |
Update a SIM card groupUpdateSimCardGroup | PATCH | Updates a SIM card group |
SIM Card Group Action2
Get SIM card group action detailsGetSimCardGroupAction | GET | This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation. |
List SIM card group actionsGetSimCardGroupActions | GET | This API allows listing a paginated collection a SIM card group actions. |
SIM Card Order4
Create a SIM card orderCreateSimCardOrder | POST | Creates a new order for SIM cards. |
Get a single SIM card orderGetSimCardOrder | GET | Get a single SIM card order by its ID. |
Get all SIM card ordersGetSimCardOrders | GET | Get all SIM card orders according to filters. |
Preview SIM card ordersPreviewSimCardOrders | POST | Preview SIM card order purchases. |
SIPREC Connector4
Create a SIPREC connectorcreateSiprecConnector | POST | Creates a new SIPREC connector configuration. |
Delete a SIPREC connectordeleteSiprecConnector | DELETE | Deletes a stored SIPREC connector. |
Retrieve a SIPREC connectorgetSiprecConnector | GET | Returns details of a stored SIPREC connector. |
Update a SIPREC connectorupdateSiprecConnector | PUT | Updates a stored SIPREC connector configuration. |
Speech To Text Batch Report8
Create a new Speech to Text batch report requestsubmitSttRequest | POST | Creates a new Speech to Text batch report request with the specified filters |
Create a new Speech to Text batch report requestsubmitSttRequest_post_legacy_reporting_batch_detail_records_speech_to_text | POST | Creates a new Speech to Text batch report request with the specified filters |
Delete a Speech to Text batch report requestdeleteSttRequest | DELETE | Deletes a specific Speech to Text batch report request by ID |
Delete a Speech to Text batch report requestdeleteSttRequest_delete_legacy_reporting_batch_detail_records_speech_to_text_id | DELETE | Deletes a specific Speech to Text batch report request by ID |
Get a specific Speech to Text batch report requestgetSttRequest | GET | Retrieves a specific Speech to Text batch report request by ID |
Get a specific Speech to Text batch report requestgetSttRequest_get_legacy_reporting_batch_detail_records_speech_to_text_id | GET | Retrieves a specific Speech to Text batch report request by ID |
Get all Speech to Text batch report requestsgetSttRequests | GET | Retrieves all Speech to Text batch report requests for the authenticated user |
Get all Speech to Text batch report requestsgetSttRequests_get_legacy_reporting_batch_detail_records_speech_to_text | GET | Retrieves all Speech to Text batch report requests for the authenticated user |
Speech To Text Capability1
List supported STT providerslistSttProviders | GET | Retrieve the canonical list of supported speech-to-text providers, models, accepted language codes, and the service types each model supports. |
Speech To Text Usage Report2
Get speech to text usage reportgetSttUsageReportSync | GET | Generate and fetch speech to text usage report synchronously. |
Get speech to text usage reportgetSttUsageReportSync_get_legacy_reporting_usage_reports_speech_to_text | GET | Generate and fetch speech to text usage report synchronously. |
Stored Payment Transaction1
Create a stored payment transactioncreateStoredPaymentTransaction | POST |
Telco Data Usage Report8
Delete telco data usage reportdeleteTelcoDataUsageReport | DELETE | Delete a specific telco data usage report by its ID |
Delete telco data usage reportdeleteTelcoDataUsageReport_delete_legacy_reporting_usage_reports_number_lookup_id | DELETE | Delete a specific telco data usage report by its ID |
Get telco data usage report by IDgetTelcoDataUsageReport | GET | Retrieve a specific telco data usage report by its ID |
Get telco data usage report by IDgetTelcoDataUsageReport_get_legacy_reporting_usage_reports_number_lookup_id | GET | Retrieve a specific telco data usage report by its ID |
List telco data usage reportsgetTelcoDataUsageReports | GET | Retrieve a paginated list of telco data usage reports |
List telco data usage reportsgetTelcoDataUsageReports_get_legacy_reporting_usage_reports_number_lookup | GET | Retrieve a paginated list of telco data usage reports |
Submit telco data usage reportsubmitTelcoDataUsageReport | POST | Submit a new telco data usage report |
Submit telco data usage reportsubmitTelcoDataUsageReport_post_legacy_reporting_usage_reports_number_lookup | POST | Submit a new telco data usage report |
Terms Of Service6
Agree to the Branded Calling Terms of ServiceagreeToBrandedCallingTos | POST | Records the authenticated user's agreement to the current Branded Calling ToS. |
Agree to the Phone Number Reputation Terms of ServiceagreeNumberReputationTermsOfService | POST | Records the authenticated user's agreement to the current Phone Number Reputation ToS. |
Get a Terms of Service agreement by idgetTermsOfServiceAgreement | GET | Retrieve a single ToS agreement record. |
Get Terms of Service informationgetTermsOfServiceInfo | GET | Returns the available Terms of Service agreements (product, current version, terms URL, effective date). |
Get the calling user's Terms of Service statusgetTermsOfServiceStatus | GET | Returns whether the authenticated user has agreed to the current Terms of Service for the product given by product type. |
List the calling user's Terms of Service agreementslistTermsOfServiceAgreements | GET | Returns the Terms of Service agreements the authenticated user has on file. |
TeXML Application5
Creates a TeXML ApplicationCreateTexmlApplication | POST | Creates a TeXML Application. |
Deletes a TeXML ApplicationDeleteTexmlApplication | DELETE | Deletes a TeXML Application. |
List all TeXML ApplicationsFindTexmlApplications | GET | Returns a list of your TeXML Applications. |
Retrieve a TeXML ApplicationGetTexmlApplication | GET | Retrieves the details of an existing TeXML Application. |
Update a TeXML ApplicationUpdateTexmlApplication | PATCH | Updates settings of an existing TeXML Application. |
TeXML REST Command34
Create a new queueCreateTexmlQueue | POST | Creates a new queue resource. |
Create a TeXML secretCreateTexmlSecret | POST | Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. |
Delete a conference participantDeleteTexmlConferenceParticipant | DELETE | Deletes a conference participant |
Delete a queue resourceDeleteTexmlQueue | DELETE | Delete a queue resource. |
Delete a recording transcriptionDeleteTeXMLRecordingTranscription | DELETE | Permanently deletes a recording transcription. |
Delete recording resourceDeleteTeXMLCallRecording | DELETE | Deletes recording resource identified by recording id. |
Dial a new conference participantDialTexmlConferenceParticipant | POST | Dials a new conference participant |
Fetch a callGetTexmlCall | GET | Returns an individual call identified by its CallSid. |
Fetch a conference resourceGetTexmlConference | GET | Returns a conference resource. |
Fetch a queue resourceGetTexmlQueue | GET | Returns a queue resource. |
Fetch a recording transcription resourceGetTeXMLRecordingTranscription | GET | Returns the recording transcription resource identified by its ID. |
Fetch multiple call resourcesGetTexmlCalls | GET | Returns multiple call resouces for an account. |
Fetch multiple recording resourcesGetTeXMLCallRecordings | GET | Returns multiple recording resources for an account. |
Fetch recording resourceGetTeXMLCallRecording | GET | Returns recording resource identified by recording id. |
Fetch recordings for a callFetchTeXMLCallRecordings | GET | Returns recordings for a call identified by call sid. |
Fetch recordings for a conferenceFetchTeXMLConferenceRecordings | GET | Returns recordings for a conference identified by conference sid. |
Get conference participant resourceGetTexmlConferenceParticipant | GET | Gets conference participant resource |
Initiate an outbound AI callInitiateTexmlAICall | POST | Initiate an outbound AI call with warm-up support. |
Initiate an outbound callInitiateTexmlCall | POST | Initiate an outbound TeXML call. |
List conference participantsGetTexmlConferenceParticipants | GET | Lists conference participants |
List conference recordingsGetTexmlConferenceRecordings | GET | Lists conference recordings |
List conference resourcesGetTexmlConferences | GET | Lists conference resources. |
List queue resourcesGetTexmlQueues | GET | Lists queue resources. |
List recording transcriptionsGetTeXMLRecordingTranscriptions | GET | Returns multiple recording transcription resources for an account. |
Request recording for a callStartTeXMLCallRecording | POST | Starts recording with specified parameters for call idientified by call sid. |
Request siprec session for a callStartTeXMLSiprecSession | POST | Starts siprec session with specified parameters for call idientified by call sid. |
Start streaming media from a call.StartTeXMLCallStreaming | POST | Starts streaming media from a call to a specific WebSocket address. |
Update a conference participantUpdateTexmlConferenceParticipant | POST | Updates a conference participant |
Update a conference resourceUpdateTexmlConference | POST | Updates a conference resource. |
Update a queue resourceUpdateTexmlQueue | POST | Updates a queue resource. |
Update callUpdateTexmlCall | POST | Update TeXML call. |
Update recording on a callUpdateTeXMLCallRecording | POST | Updates recording resource for particular call. |
Update streaming on a callUpdateTeXMLCallStreaming | POST | Updates streaming resource for particular call. |
Updates siprec session for a callUpdateTeXMLSiprecSession | POST | Updates siprec session identified by siprec sid. |
Text To Speech Command3
Generate speech from textgenerateSpeech | POST | Generate synthesized speech audio from text input. |
List available voiceslistVoices | GET | Retrieve a list of available voices from one or all TTS providers. |
Stream text to speech over WebSocketTextToSpeechOverWs | GET | Open a WebSocket connection to stream text and receive synthesized audio in real time. |
Traffic Policy Profile12
Create a traffic policy profileCreateTrafficPolicyProfile | POST | Create a new traffic policy profile. |
Create a traffic policy profileCreateTrafficPolicyProfile_post_traffic_policy_profiles | POST | Create a new traffic policy profile. |
Delete a traffic policy profileDeleteTrafficPolicyProfile | DELETE | Deletes the traffic policy profile. |
Delete a traffic policy profileDeleteTrafficPolicyProfile_delete_traffic_policy_profiles_id | DELETE | Deletes the traffic policy profile. |
Get a traffic policy profileGetTrafficPolicyProfile | GET | Returns the details regarding a specific traffic policy profile. |
Get a traffic policy profileGetTrafficPolicyProfile_get_traffic_policy_profiles_id | GET | Returns the details regarding a specific traffic policy profile. |
Get all available traffic policy profile servicesGetTrafficPolicyProfileServices | GET | Get all available PCEF services that can be used in traffic policy profiles. |
Get all available traffic policy profile servicesGetTrafficPolicyProfileServices_get_traffic_policy_profiles_services | GET | Get all available PCEF services that can be used in traffic policy profiles. |
Get all traffic policy profilesGetTrafficPolicyProfiles | GET | Get all traffic policy profiles belonging to the user that match the given filters. |
Get all traffic policy profilesGetTrafficPolicyProfiles_get_traffic_policy_profiles | GET | Get all traffic policy profiles belonging to the user that match the given filters. |
Update a traffic policy profileUpdateTrafficPolicyProfile | PATCH | Updates a traffic policy profile. |
Update a traffic policy profileUpdateTrafficPolicyProfile_patch_traffic_policy_profiles_id | PATCH | Updates a traffic policy profile. |
UAC Connection7
Check a UAC Connection Registration StatusCheckUacConnectionRegistrationStatus | POST | Checks the registration status for a UAC connection (registration status) as well as the timestamp for the last SIP registration event (registration status updated at). |
Create a UAC connectionCreateUacConnection | POST | Creates a UAC connection. |
Delete a UAC connectionDeleteUacConnection | DELETE | Deletes an existing UAC connection. |
List UAC connectionsListUacConnections | GET | Returns a list of your UAC connections. |
Retrieve a UAC connectionRetrieveUacConnection | GET | Retrieves the details of an existing UAC connection. |
SIP Registration StatusGetSipRegistrationStatus | GET | Returns the live SIP registration state of a UAC connection: whether it is currently registered, when it last registered, and the last response Telnyx received from the registrar. |
Update a UAC connectionUpdateUacConnection | PATCH | Updates settings of an existing UAC connection. |
Usage Reports (BETA)2
Get Telnyx product usage data (BETA)GetUsageReports | GET | Get Telnyx usage data by product, broken out by the specified dimensions |
Get Usage Reports query options (BETA)ListUsageReportsOptions | GET | Get the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions |
User Bundle6
Create User BundlesCreateUserBundlesBulk | POST | Creates multiple user bundles for the user. |
Deactivate User BundleDeactivateUserBundle | DELETE | Deactivates a user bundle by its ID. |
Get Unused User BundlesGetUnusedUserBundles | GET | Returns all user bundles that aren't in use. |
Get User Bundle by IdGetUserBundleById | GET | Retrieves a user bundle by its ID. |
Get User Bundle ResourcesGetUserBundleResources | GET | Retrieves the resources of a user bundle by its ID. |
Get User BundlesGetUserBundles | GET | Get a paginated list of user bundles. |
User Tag1
List User TagsGetUserTags | GET | List all user tags. |
UserAddress6
Creates a user addressCreateUserAddress | POST | Creates a user address. |
Creates a user addressCreateUserAddress_post_user_addresses | POST | Creates a user address. |
List all user addressesFindUserAddress | GET | Returns a list of your user addresses. |
List all user addressesFindUserAddress_get_user_addresses | GET | Returns a list of your user addresses. |
Retrieve a user addressGetUserAddress | GET | Retrieves the details of an existing user address. |
Retrieve a user addressGetUserAddress_get_user_addresses_id | GET | Retrieves the details of an existing user address. |
Verification Request7
Delete Verification RequestDeleteVerificationRequest | DELETE | Delete a verification request |
Get Verification RequestGetVerificationRequest | GET | Get a single verification request by its ID. |
Get Verification Request Status HistoryGetVerificationStatusHistory | GET | Get the history of status changes for a verification request. |
Get Verification Request Status HistoryGetVerificationStatusHistory_get_messaging_tollfree_verification_requests_id_status_history | GET | Get the history of status changes for a verification request. |
List Verification RequestsListVerificationRequests | GET | Get a list of previously-submitted tollfree verification requests |
Submit Verification RequestSubmitVerificationRequest | POST | Submit a new tollfree verification request |
Update Verification RequestUpdateVerificationRequest | PATCH | Update an existing tollfree verification request. |
Verified Number5
Delete a verified numberDeleteVerifiedNumber | DELETE | |
List all Verified NumbersListVerifiedNumbers | GET | Gets a paginated list of Verified Numbers. |
Request phone number verificationCreateVerifiedNumber | POST | Initiates phone number verification procedure. |
Retrieve a verified numberGetVerifiedNumber | GET | |
Submit verification codeVerifyVerificationCode | POST |
Verify16
Create a Verify profileCreateVerifyProfile | POST | Creates a new Verify profile to associate verifications with. |
Create message templateCreateMessageTemplate | POST | Create a new Verify profile message template. |
Delete Verify profileDeleteProfile | DELETE | |
List all Verify profilesListProfiles | GET | Gets a paginated list of Verify profiles. |
List verifications by phone numberListVerifications | GET | |
Retrieve verificationRetrieveVerification | GET | |
Retrieve Verify profileGetVerifyProfile | GET | Gets a single Verify profile. |
Retrieve Verify profile message templatesListProfileMessageTemplates | GET | List all Verify profile message templates. |
Trigger Call verificationCreateVerificationCall | POST | |
Trigger Flash call verificationCreateFlashcallVerification | POST | |
Trigger SMS verificationCreateVerificationSms | POST | |
Trigger WhatsApp verificationCreateWhatsappVerification | POST | |
Update message templateUpdateMessageTemplate | PATCH | Update an existing Verify profile message template. |
Update Verify profileUpdateVerifyProfile | PATCH | |
Verify verification code by IDVerifyVerificationCodeById | POST | |
Verify verification code by phone numberVerifyVerificationCodeByPhoneNumber | POST |
Virtual Cross Connect7
Create a Virtual Cross ConnectCreateVirtualCrossConnect | POST | Create a new Virtual Cross Connect. |
Delete a Virtual Cross ConnectDeleteVirtualCrossConnect | DELETE | Delete a Virtual Cross Connect. |
List all Virtual Cross ConnectsListVirtualCrossConnects | GET | List all Virtual Cross Connects. |
List Virtual Cross Connect Cloud CoverageListVirtualCrossConnectCoverage | GET | List Virtual Cross Connects Cloud Coverage. |
List Virtual Cross Connect Cloud CoverageListVirtualCrossConnectCoverage_get_virtual_cross_connects_coverage | GET | List Virtual Cross Connects Cloud Coverage. |
Retrieve a Virtual Cross ConnectGetVirtualCrossConnect | GET | Retrieve a Virtual Cross Connect. |
Update the Virtual Cross ConnectUpdateVirtualCrossConnect | PATCH | Update the Virtual Cross Connect. |
Voice Channel6
List All Numbers using Channel BillingGetAllNumbersChannelZones | GET | Retrieve a list of all phone numbers using Channel Billing, grouped by Zone. |
List Numbers using Channel Billing for a specific ZoneGetNumbersChannelZones | GET | Retrieve a list of phone numbers using Channel Billing for a specific Zone. |
List your voice channels for non-US zonesGetChannelZones | GET | Returns the non-US voice channels for your account. |
List your voice channels for US ZoneListInboundChannels | GET | Returns the US Zone voice channels for your account. |
Update voice channels for non-US ZonesPatchChannelZone | PUT | Update the number of Voice Channels for the Non-US Zones. |
Update voice channels for US ZoneUpdateOutboundChannels | PATCH | Update the number of Voice Channels for the US Zone. |
Voice Clone6
Create a voice clone from a voice designcreateVoiceClone | POST | Creates a new voice clone by capturing the voice identity of an existing voice design. |
Create a voice clone from an audio file uploadcreateVoiceCloneFromUpload | POST | Creates a new voice clone by uploading an audio file directly. |
Delete a voice clonedeleteVoiceClone | DELETE | Permanently deletes a voice clone. |
Download voice clone audio samplegetVoiceCloneSample | GET | Downloads the WAV audio sample that was used to create the voice clone. |
List voice cloneslistVoiceClones | GET | Returns a paginated list of voice clones belonging to the authenticated account. |
Update a voice cloneupdateVoiceClone | PATCH | Updates the name, language, or gender of a voice clone. |
Voice Design7
Create or add a version to a voice designcreateVoiceDesign | POST | Creates a new voice design (version 1) when voice design id is omitted. |
Delete a specific version of a voice designdeleteVoiceDesignVersion | DELETE | Permanently deletes a specific version of a voice design. |
Delete a voice designdeleteVoiceDesign | DELETE | Permanently deletes a voice design and all of its versions. |
Download voice design audio samplegetVoiceDesignSample | GET | Downloads the WAV audio sample for the voice design. |
Get a voice designgetVoiceDesign | GET | Returns the latest version of a voice design, or a specific version when ?version=N is provided. |
List voice designslistVoiceDesigns | GET | Returns a paginated list of voice designs belonging to the authenticated account. |
Rename a voice designupdateVoiceDesign | PATCH | Updates the name of a voice design. |
Voice SDK Stat2
List Voice SDK call reportsListVoiceSdkCallReports | GET | Returns paginated raw call report stats JSON payloads stored for the authenticated user. |
Retrieve Voice SDK call reports by call IDGetVoiceSdkCallReport | GET | Returns raw call report stats JSON payloads stored for the authenticated user and call id. |
Voicemail3
Create voicemailCreateVoicemail | POST | Create voicemail settings for a phone number |
Get voicemailGetVoicemail | GET | Returns the voicemail settings for a phone number |
Update voicemailUpdateVoicemail | PATCH | Update voicemail settings for a phone number |
WDR Detail Report1
Fetches all Wdr recordsGetPaginatedWdrs | GET | Fetch all Wdr records |
Webhook2
Find webhook_delivery details by IDGetWebhookDelivery | GET | Provides webhook delivery debug data, such as timestamps, delivery status and attempts. |
List webhook deliveriesGetWebhookDeliveries | GET | Lists webhook deliveries for the authenticated user |
Whatsapp Business Account8
Delete a Whatsapp Business AccountdeleteWaba | DELETE | |
Fetch Whatsapp user dataGetWhatsappUserData | GET | |
Get a single Whatsapp Business AccountGetSingleWaba | GET | |
Get WABA settingsGetWabaSettings | GET | |
List phone numbers for a WABAListWabaPhones | GET | |
List Whatsapp Business AccountsListWabas | GET | |
Update WABA settingsPatchWabaSettings | PATCH | |
Update Whatsapp user dataPatchWhatsappUserData | PATCH |
Whatsapp Message Template8
Create a Whatsapp message templatePostWhatsappTemplate | POST | |
Delete a Whatsapp message templateDeleteWhatsappTemplate | DELETE | |
Delete a Whatsapp message templateDeleteWhatsappTemplate_delete_whatsapp_message_templates_id | DELETE | |
Get a Whatsapp message template by IDGetWhatsappTemplate | GET | |
Get a Whatsapp message template by IDGetWhatsappTemplate_get_whatsapp_message_templates_id | GET | |
List Whatsapp message templatesListWhatsappTemplates | GET | |
Update a Whatsapp message templatePatchWhatsappTemplate | PATCH | |
Update a Whatsapp message templatePatchWhatsappTemplate_patch_whatsapp_message_templates_id | PATCH |
Whatsapp Messaging1
Send a Whatsapp messageSendWhatsappMessage | POST |
Whatsapp Phone Number15
Delete a Whatsapp phone numberDeleteWhatsappPhoneNumber | DELETE | |
Delete Whatsapp profile photoDeleteWhatsappProfilePhoto | DELETE | |
Enable or disable Whatsapp calling for a phone numberPatchWhatsappCallingSettings | PATCH | |
Get calling settings for a phone numberGetWhatsappCallingSettings | GET | |
Get conversation window status for a phone numberGetWhatsappConversationWindow | GET | Returns whether the 24-hour conversation window is currently open for a given source/destination pair. |
Get phone number business profileGetWhatsappProfile | GET | |
Get phone number conversational componentsGetWhatsappConversationalComponents | GET | |
Get Whatsapp profile photoGetWhatsappProfilePhoto | GET | |
Initialize Whatsapp phone number verificationInitializeWhatsappVerification | POST | |
List Whatsapp phone numbersListPhoneNumbers_ | GET | |
Resend verification codeResendWhatsappVerification | POST | |
Submit verification code for a phone numberVerifyWhatsappPhoneNumber | POST | |
Update phone number business profilePatchWhatsappProfile | PATCH | |
Update phone number conversational componentsPatchWhatsappConversationalComponents | PATCH | |
Upload Whatsapp profile photoPostWhatsappProfilePhoto | POST |
WireGuard Interface10
Create a WireGuard InterfaceCreateWireguardInterface | POST | Create a new WireGuard Interface. |
Create a WireGuard PeerCreateWireguardPeer | POST | Create a new WireGuard Peer. |
Delete a WireGuard InterfaceDeleteWireguardInterface | DELETE | Delete a WireGuard Interface. |
Delete the WireGuard PeerDeleteWireguardPeer | DELETE | Delete the WireGuard peer. |
List all WireGuard InterfacesListWireguardInterfaces | GET | List all WireGuard Interfaces. |
List all WireGuard PeersListWireguardPeers | GET | List all WireGuard peers. |
Retrieve a WireGuard InterfacesGetWireguardInterface | GET | Retrieve a WireGuard Interfaces. |
Retrieve the WireGuard PeerGetWireguardPeer | GET | Retrieve the WireGuard peer. |
Retrieve Wireguard config template for PeerGetWireguardPeerConfig | GET | Retrieve Wireguard config template for Peer |
Update the WireGuard PeerUpdateWireguardPeer | PATCH | Update the WireGuard peer. |
Wireless Blocklist6
Create a Wireless BlocklistCreateWirelessBlocklist | POST | Create a Wireless Blocklist to prevent SIMs from connecting to certain networks. |
Delete a Wireless BlocklistDeleteWirelessBlocklist | DELETE | Deletes the Wireless Blocklist. |
Get a Wireless BlocklistGetWirelessBlocklist | GET | Retrieve information about a Wireless Blocklist. |
Get all possible wireless blocklist valuesWirelessBlocklistsGetAll | GET | Retrieve all wireless blocklist values for a given blocklist type. |
Get all Wireless BlocklistsGetWirelessBlocklistsGateways | GET | Get all Wireless Blocklists belonging to the user. |
Update a Wireless BlocklistUpdateWirelessBlocklist | PATCH | Update a Wireless Blocklist. |
Wireless Region1
Get all wireless regionsWirelessRegionsGetAll | GET | Retrieve all wireless regions for the given product. |
X402 Payment Transaction2
Create a payment quotecreateX402Quote | POST | Creates a payment quote for the specified USD amount. |
Settle a paymentsettleX402Payment | POST | Settles an x402 payment using the quote ID and a signed payment authorization. |