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

  1. In Neblex open Connect › Connections and click New Connection.
  2. Search for Telnyx and give the connection a clear name.
  3. Fill in the fields. Secret values are encrypted and never shown again.
  4. Click Test, then Create Connection.
FieldWhat to enter
Access tokenRequiredSecret

Use it in a flow

  1. Open a flow, open the node library and search for Telnyx.
  2. Drag it onto the canvas and choose an Operation and your connection.
  3. Map the operation's fields from earlier steps, or click Map with Matt.
  4. 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.CreateTelephonyCredentialTokenPOSTCreate an Access Token (JWT) for the credential.
Address6
Accepts this address suggestion as a new emergency address foracceptAddressSuggestionsPOST
Creates an addressCreateAddressPOSTCreates an address.
Deletes an addressDeleteAddressDELETEDeletes an existing address.
List all addressesFindAddressesGETReturns a list of your addresses.
Retrieve an addressGetAddressGETRetrieves the details of an existing address.
Validate an addressValidateAddressPOSTValidates an address for emergency services.
Advanced Number Order4
Create Advanced Ordercreate_advanced_order_v2POST
Get Advanced Orderget_advanced_order_v2GET
List Advanced Orderslist_advanced_orders_v2GET
Update Advanced Orderupdate_advanced_order_v2PATCH
Anthropic Message1
Create a message (Anthropic-compatible)create_anthropic_messagePOSTSend a message to a language model using the Anthropic Messages API format.
Assistant46
Add Assistant Tagadd_assistant_tagPOST
Add Assistant Tooladd_assistant_toolPUT
Assistant Chat (BETA)assistant_chat_public_assistants_assistant_id_chat_postPOSTThis endpoint allows a client to send a chat message to a specific AI Assistant.
Assistant Sms Chatassistant_sms_chat_assistants_assistant_id_chat_sms_postPOSTSend an SMS message for an assistant.
Clone Assistantclone_assistant_public_assistants_assistant_id_clone_postPOSTClone an existing assistant, excluding telephony and messaging settings.
Create a new assistant testcreate_assistant_test_public_assistants_tests_postPOSTCreates a comprehensive test configuration for evaluating AI assistant performance
Create a scheduled eventcreate_scheduled_eventPOSTCreate a scheduled event for an assistant
Create an assistantcreate_new_assistant_public_assistants_postPOSTCreate a new AI Assistant.
Create Canary Deploycreate_canary_deploy_assistants_assistant_id_canary_deploys_postPOSTEndpoint to create a canary deploy configuration for an assistant.
Create Toolcreate_tool_postPOST
Delete a scheduled eventdelete_scheduled_eventDELETEIf the event is pending, this will cancel the event.
Delete a specific assistant versiondelete_assistant_version_public_assistants_assistant_id_versions_version_id_deleteDELETEPermanently removes a specific version of an assistant.
Delete an assistantdelete_assistant_public_assistants_assistant_id_deleteDELETEDelete an AI Assistant by assistant id.
Delete an assistant testdelete_assistant_test_public_assistants_tests_test_id_deleteDELETEPermanently removes an assistant test and all associated data
Delete Canary Deploydelete_canary_deploy_assistants_assistant_id_canary_deploys_deleteDELETEEndpoint to delete a canary deploy configuration for an assistant.
Delete Tooldelete_tool_tool_idDELETE
Enhance Assistant Instructionsenhance_assistant_instructions_public_assistants_assistant_id_instructions_enhance_postPOSTEnhance an assistant's instructions using an LLM.
Get a scheduled eventget_scheduled_eventGETRetrieve a scheduled event by event ID
Get a specific assistant versionget_assistant_version_public_assistants_assistant_id_versions_version_id_getGETRetrieves a specific version of an assistant by assistant id and version id
Get All Tagsget_all_assistant_tagsGET
Get all test suite namesfetch_test_suites_public_assistants_tests_test_suites_getGETRetrieves 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_getGETRetrieves all versions of a specific assistant with complete configuration and metadata
Get an assistantget_assistant_public_assistants_assistant_id_getGETRetrieve an AI Assistant configuration by assistant id.
Get assistant test by IDget_assistant_test_public_assistants_tests_test_id_getGETRetrieves detailed information about a specific assistant test
Get assistant texmlget_assistant_texml_public_assistants_assistant_id_texml_getGETGet an assistant texml by assistant id.
Get Canary Deployget_canary_deploy_assistants_assistant_id_canary_deploys_getGETEndpoint to get a canary deploy configuration for an assistant.
Get specific test run detailsget_test_run_public_assistants_tests_test_id_runs_run_id_getGETRetrieves 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_getGETRetrieves 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_getGETRetrieves paginated history of test runs for a specific test suite with filtering options
Get Toolget_tool_tool_idGET
Import assistants from external providerimport_assistants_public_assistants_import_postPOSTImport assistants from external providers.
List assistant tests with paginationget_assistant_tests_public_assistants_tests_getGETRetrieves a paginated list of assistant tests with optional filtering capabilities
List assistantsget_assistants_public_assistants_getGETRetrieve a list of all AI Assistants configured by the user.
List scheduled eventsget_scheduled_eventsGETGet scheduled events for an assistant with pagination and filtering
List Toolslist_toolsGET
Promote an assistant version to mainpromote_assistant_version_public_assistants_assistant_id_versions_version_id_promote_postPOSTPromotes a specific version to be the main/current version of the assistant.
Remove Assistant Tagremove_assistant_tagDELETE
Remove Assistant Toolremove_assistant_toolDELETE
Test Assistant Tooltest_assistant_tool_public_assistants_assistant_id_tools_tool_id_test_postPOSTTest a webhook tool for an assistant
Trigger a manual test runtrigger_test_run_public_assistants_tests_test_id_runs_postPOSTInitiates immediate execution of a specific assistant test
Trigger test suite executiontrigger_test_suite_runs_public_assistants_tests_test_suites_suite_name_runs_postPOSTExecutes 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_postPOSTUpdates the configuration of a specific assistant version.
Update an assistantupdate_assistant_public_assistants_assistant_id_postPOSTUpdate an AI Assistant's attributes.
Update an assistant testupdate_assistant_test_public_assistants_tests_test_id_putPUTUpdates an existing assistant test configuration with new settings
Update Canary Deployupdate_canary_deploy_assistants_assistant_id_canary_deploys_putPUTEndpoint to update a canary deploy configuration for an assistant.
Update Toolupdate_tool_tool_idPATCH
Audio1
Transcribe speech to textaudio_public_audio_transcriptions_postPOSTTranscribe speech to text.
Audit Log1
List Audit LogsListAuditLogsGETRetrieve a list of audit log entries.
Authentication Provider5
Creates an authentication providerCreateAuthenticationProviderPOSTCreates an authentication provider.
Deletes an authentication providerDeleteAuthenticationProviderDELETEDeletes an existing authentication provider.
List all SSO authentication providersFindAuthenticationProvidersGETReturns a list of your SSO authentication providers.
Retrieve an authentication providerGetAuthenticationProviderGETRetrieves the details of an existing authentication provider.
Update an authentication providerUpdateAuthenticationProviderPATCHUpdates settings of an existing authentication provider.
AutoRechargePreference2
List auto recharge preferencesGetAutoRechargePrefsGETReturns the payment auto recharge preferences.
Update auto recharge preferencesUpdateAutoRechargePrefsPATCHUpdate payment auto recharge preferences.
Billing1
Get user balance detailsGetUserBalanceGET
Billing Group5
Create a billing groupCreateBillingGroupPOST
Delete a billing groupDeleteBillingGroupDELETE
Get a billing groupGetBillingGroupGET
List all billing groupsListBillingGroupsGET
Update a billing groupUpdateBillingGroupPATCH
Brand16
Create BrandCreateBrandPostPOSTThis endpoint is used to create a new brand.
Delete BrandDeleteBrandDELETEDelete Brand.
Get BrandGetBrandGETRetrieve a brand by brandId.
Get Brand Feedback By IdGetBrandFeedbackByIdGETGet feedback about a brand by ID.
Get Brand Feedback By IdGetBrandFeedbackById_get_10dlc_brand_feedback_brandIdGETGet feedback about a brand by ID.
Get Brand SMS OTP StatusGetBrandSmsOtpStatusGETQuery the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification.
Get Brand SMS OTP Status by Brand IDGetBrandSmsOtpStatusByBrandIdGETQuery the status of an SMS OTP (One-Time Password) for Sole Proprietor brand verification using the Brand ID.
Import External Vetting RecordPutExternalVettingRecordPUTThis operation can be used to import an external vetting record from a TCR-approved vetting provider.
List BrandsGetBrandsGETThis endpoint is used to list all brands associated with your organization.
List External VettingsListExternalVettingsGETGet list of valid external vetting record for a given brand
Order Brand External VettingPostOrderExternalVettingPOSTOrder new external vetting for a brand.
Resend brand 2FA emailResendBrand2faEmailPOST
Revet BrandRevetBrandPUTThis operation allows you to revet the brand.
Trigger Brand SMS OTPTriggerBrandSmsOtpPOSTTrigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification.
Update BrandUpdateBrandPUTUpdate a brand's attributes by brandId.
Verify Brand SMS OTPVerifyBrandSmsOtpPUTVerify the SMS OTP (One-Time Password) for Sole Proprietor brand verification.
Bucket SSL Certificate3
Add SSL CertificateAddStorageSSLCertificatePUTUploads an SSL certificate and its matching secret so that you can use Telnyx's storage as your CDN.
Get Bucket SSL CertificateGetStorageSSLCertificatesGETReturns the stored certificate detail of a bucket, if applicable.
Remove SSL CertificateRemoveStorageSSLCertificateDELETEDeletes an SSL certificate and its matching secret.
Bucket Usage2
Get API UsageGetStorageAPIUsageGETReturns the detail on API usage on a bucket of a particular time period, group by method category.
Get Bucket UsageGetBucketUsageGETReturns the amount of storage space and number of files a bucket takes up.
Bulk Phone Number Campaign3
Assign Messaging Profile To CampaignPostAssignMessagingProfileToCampaignPOSTThis endpoint allows you to link all phone numbers associated with a Messaging Profile to a campaign.
Get Assignment Task StatusGetAssignmentTaskStatusGETCheck the status of the task associated with assigning all phone numbers on a messaging profile to a campaign by taskId.
Get Phone Number StatusGetPhoneNumberStatusGETCheck the status of the individual phone number/campaign assignments associated with the supplied taskId.
Bulk Phone Number Operation5
Delete a batch of numbersCreateDeletePhoneNumbersJobPOSTCreates a new background job to delete a batch of numbers.
Lists the phone numbers jobsListPhoneNumbersJobsGET
Retrieve a phone numbers jobRetrievePhoneNumbersJobGET
Update a batch of numbersCreateUpdatePhoneNumbersJobPOSTCreates a new background job to update a batch of numbers.
Update the emergency settings from a batch of numbersCreatePhoneNumbersJobUpdateEmergencySettingsPOSTCreates a background job to update the emergency settings of a collection of phone numbers.
Bundle2
Get Bundle By IdGetBillingBundleByIdGETGet a single bundle by ID.
Retrieve BundlesGetUserBillingBundlesGETGet all allowed bundles.
Call Command42
Add messages to AI AssistantCallAddMessagesToAIAssistantPOSTAdd messages to the conversation started by an AI assistant on the call.
Answer callAnswerCallPOSTAnswer an incoming call.
Bridge callsBridgeCallPOSTBridge two call control calls.
Collect payment detailsPayCallPOSTCollect payment details from the caller using DTMF and either charge or tokenize the payment method through a configured Pay connector.
DialDialCallPOSTDial a number or SIP URI from a given connection.
Enqueue callEnqueueCallPOSTPut the call in a queue.
Forking startStartCallForkPOSTCall forking allows you to stream the media from a call to a specific target in realtime.
Forking stopStopCallForkPOSTStop forking a call.
GatherGatherCallPOSTGather DTMF signals to build interactive menus.
Gather stopStopCallGatherPOSTStop current gather.
Gather using AIcallGatherUsingAIPOSTGather parameters defined in the request payload using a voice assistant.
Gather using audioGatherUsingAudioPOSTPlay an audio file on the call until the required DTMF signals are gathered to build interactive menus.
Gather using speakGatherUsingSpeakPOSTConvert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus.
Hangup callHangupCallPOSTHang up the call.
Join AI Assistant ConversationCallJoinAIAssistantPOSTAdd a participant to an existing AI assistant conversation.
Noise Suppression Start (BETA)noiseSuppressionStartPOST
Noise Suppression Stop (BETA)noiseSuppressionStopPOST
Play audio URLStartCallPlaybackPOSTPlay an audio file on the call.
Record pausePauseCallRecordingPOSTPause recording the call.
Record resumeResumeCallRecordingPOSTResume recording the call.
Recording startStartCallRecordPOSTStart recording the call.
Recording stopStopCallRecordingPOSTStop recording the call.
Reject a callRejectCallPOSTReject an incoming call.
Remove call from a queueLeaveQueuePOSTRemoves the call from a queue.
Send DTMFSendDTMFPOSTSends DTMF tones from this leg.
Send SIP infoSendSIPInfoPOSTSends SIP info from this leg.
SIP Refer a callReferCallPOSTInitiate a SIP Refer on a Call Control call.
SIPREC startStartSiprecSessionPOSTStart siprec session to configured in SIPREC connector SRS.
SIPREC stopStopSiprecSessionPOSTStop SIPREC session.
Speak textSpeakCallPOSTConvert text to speech and play it back on the call.
Start AI AssistantCallStartAIAssistantPOSTStart an AI assistant on the call.
Start Conversation RelayCallStartConversationRelayPOSTStart a Conversation Relay session on an active call.
Stop AI AssistantCallStopAIAssistantPOSTStop an AI assistant on the call.
Stop audio playbackStopCallPlaybackPOSTStop audio being played on the call.
Stop Conversation RelayCallStopConversationRelayPOSTStop the active Conversation Relay session on a call.
Streaming startStartCallStreamingPOSTStart streaming the media from a call to a specific WebSocket address or Dialogflow connection in near-realtime.
Streaming stopStopCallStreamingPOSTStop streaming a call to a WebSocket.
Switch supervisor roleSwitchSupervisorRolePOSTSwitch the supervisor role for a bridged call.
Transcription startStartCallTranscriptionPOSTStart real-time transcription.
Transcription stopStopCallTranscriptionPOSTStop real-time transcription.
Transfer callTransferCallPOSTTransfer a call to a new destination.
Update client stateUpdateClientStatePUTUpdates client state
Call Control Application5
Create a call control applicationCreateCallControlApplicationPOSTCreate a call control application.
Delete a call control applicationDeleteCallControlApplicationDELETEDeletes a call control application.
List call control applicationsListCallControlApplicationsGETReturn a list of call control applications.
Retrieve a call control applicationRetrieveCallControlApplicationGETRetrieves the details of an existing call control application.
Update a call control applicationUpdateCallControlApplicationPATCHUpdates settings of an existing call control application.
Call Information2
List all active calls for given connectionListConnectionActiveCallsGETLists all active calls for given connection.
Retrieve a call statusRetrieveCallStatusGETReturns the status of a call (data is available 10 minutes after call ended).
Call Recording11
Create a custom storage credentialCreateCustomStorageCredentialsPOSTCreates a custom storage credentials configuration.
Delete a call recordingDeleteRecordingDELETEPermanently deletes a call recording.
Delete a list of call recordingsDeleteRecordingsPOSTPermanently deletes a list of call recordings.
Delete a recording transcriptiondeleteRecordingTranscriptionDELETEPermanently deletes a recording transcription.
Delete a stored credentialDeleteCustomStorageCredentialsDELETEDeletes a stored custom credentials configuration.
List all call recordingsGetRecordingsGETReturns a list of your call recordings.
List all recording transcriptionsgetRecordingTranscriptionsGETReturns a list of your recording transcriptions.
Retrieve a call recordingGetRecordingGETRetrieves the details of an existing call recording.
Retrieve a recording transcriptiongetRecordingTranscriptionGETRetrieves the details of an existing recording transcription.
Retrieve a stored credentialGetCustomStorageCredentialsGETReturns the information about custom storage credentials.
Update a stored credentialUpdateCustomStorageCredentialsPUTUpdates a stored custom credentials configuration.
Campaign15
Accept Shared CampaignAcceptCampaignPOSTManually accept a campaign shared with Telnyx
Deactivate campaignDeactivateCampaignDELETETerminate a campaign.
Get campaignGetCampaignGETRetrieve campaign details by campaignId.
Get Campaign CostGetCampaignCostGET
Get Campaign CostGetCampaignCost_get_10dlc_campaign_usecase_costGET
Get Campaign Mno MetadataGetCampaignMnoMetadataGETGet the campaign metadata for each MNO it was submitted to.
Get campaign operation statusGetCampaignOperationStatusGETRetrieve campaign's operation status at MNO level.
Get OSR campaign attributesGetCampaignOsrAttributesGET
Get OSR campaign attributesGetCampaignOsrAttributes_get_10dlc_campaign_campaignId_osr_attributesGET
Get Sharing StatusGetCampaignSharingStatusGET
List CampaignsGetCampaignsGETRetrieve a list of campaigns associated with a supplied brandId.
Qualify By UsecaseGetUsecaseQualificationGETThis endpoint allows you to see whether or not the supplied brand is suitable for your desired campaign use case.
Submit CampaignPostCampaignPOSTBefore 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 reviewAppealCampaignPOSTSubmits an appeal for rejected native campaigns in TELNYX FAILED or MNO REJECTED status.
Update campaignUpdateCampaignPUTUpdate a campaign's properties by campaignId.
CDR Report10
Create a new CDR report requestsubmitCdrRequestPOSTCreates a new CDR report request with the specified filters
Create a new CDR report requestsubmitCdrRequest_post_legacy_reporting_batch_detail_records_voicePOSTCreates a new CDR report request with the specified filters
Delete a CDR report requestdeleteCdrRequestDELETEDeletes a specific CDR report request by ID
Delete a CDR report requestdeleteCdrRequest_delete_legacy_reporting_batch_detail_records_voice_idDELETEDeletes a specific CDR report request by ID
Get a specific CDR report requestgetCdrRequestGETRetrieves a specific CDR report request by ID
Get a specific CDR report requestgetCdrRequest_get_legacy_reporting_batch_detail_records_voice_idGETRetrieves a specific CDR report request by ID
Get all CDR report requestsgetCdrRequestsGETRetrieves all CDR report requests for the authenticated user
Get all CDR report requestsgetCdrRequests_get_legacy_reporting_batch_detail_records_voiceGETRetrieves all CDR report requests for the authenticated user
Get available CDR report fieldsgetCdrsAvailableFieldsGETRetrieves all available fields that can be used in CDR reports
Get available CDR report fieldsgetCdrsAvailableFields_get_legacy_reporting_batch_detail_records_voice_fieldsGETRetrieves all available fields that can be used in CDR reports
CDR Usage Report9
Create a new legacy usage V2 CDR report requestsubmitCdrUsageReportPOSTCreates 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_voicePOSTCreates a new legacy usage V2 CDR report request with the specified filters
Delete a V2 legacy usage CDR report requestdeleteCdrUsageReportDELETEDeletes a specific V2 legacy usage CDR report request by ID
Delete a V2 legacy usage CDR report requestdeleteCdrUsageReport_delete_legacy_reporting_usage_reports_voice_idDELETEDeletes a specific V2 legacy usage CDR report request by ID
Generates and fetches CDR Usage ReportsGetCDRUsageReportSyncGETGenerate and fetch voice usage report synchronously.
Get a CDR usage reportgetCdrUsageReportGETFetch single cdr usage report by id.
Get a CDR usage reportgetCdrUsageReport_get_legacy_reporting_usage_reports_voice_idGETFetch single cdr usage report by id.
List CDR usage reportsgetCdrUsageReportsGETFetch all previous requests for cdr usage reports.
List CDR usage reportsgetCdrUsageReports_get_legacy_reporting_usage_reports_voiceGETFetch all previous requests for cdr usage reports.
Charges Breakdown1
Charges Breakdown charges breakdownGetMonthlyChargesBreakdownGETRetrieve a detailed breakdown of monthly charges for phone numbers in a specified date range.
Charges Summary1
Charges Summary charges summaryGetMonthlyChargesSummaryGETRetrieve a summary of monthly charges for a specified date range.
Chat4
Create a chat completionchat_public_chat_completions_postPOSTDeprecated : Use POST /v2/ai/openai/chat/completions instead.
Create a responsechat_public_responses_completions_postPOSTDeprecated : Use POST /v2/ai/openai/responses instead.
Get available modelsget_models_public_models_getGETDeprecated : Use GET /v2/ai/openai/models instead.
Summarize file contentPostSummaryPOSTGenerate a summary of a file's contents.
Cloudfs Filesystem6
Create a CloudFS filesystemCreateCloudfsFilesystemPOSTCreates a CloudFS filesystem.
Delete a CloudFS filesystemDeleteCloudfsFilesystemDELETEPermanently deletes a CloudFS filesystem, removing its S3 bucket and its metadata database.
Get a CloudFS filesystemGetCloudfsFilesystemGETRetrieves a CloudFS filesystem by its ID.
List CloudFS filesystemsListCloudfsFilesystemsGETLists the CloudFS filesystems for the authenticated user's organization.
Rotate the metadata tokenRotateCloudfsMetaTokenPOSTIssues 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 filesystemUpdateCloudfsFilesystemPATCHUpdates a CloudFS filesystem.
Cluster5
Compute new clusterscompute_new_cluster_public_text_clusters_postPOSTStarts 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_deleteDELETE
Fetch a clusterfetch_cluster_by_task_id_public_text_clusters_task_id_getGET
Fetch a cluster visualizationfetch_cluster_image_by_task_id_public_text_clusters_task_id_image_getGET
List all clusterslist_all_requested_clusters_public_text_clusters_getGET
Comment2
List comments on a DIRlistCommentsSimpleGETList the comments on a DIR.
Post a comment on a DIRcreateCommentSimplePOSTPost a customer comment on a DIR (for example, to respond to reviewer notes).
Conference Command23
Conference recording pausePauseConferenceRecordingPOSTPause conference recording.
Conference recording resumeResumeConferenceRecordingPOSTResume conference recording.
Conference recording startStartConferenceRecordingPOSTStart recording the conference.
Conference recording stopStopConferenceRecordingPOSTStop recording the conference.
Create conferenceCreateConferencePOSTCreate a conference from an existing call leg using a call control id and a conference name.
End a conferenceEndConferencePOSTEnd a conference and terminate all active participants.
Gather DTMF using audio prompt in a conferenceConferenceGatherUsingAudioPOSTPlay an audio file to a specific conference participant and gather DTMF input.
Hold conference participantsHoldConferenceParticipantsPOSTHold a list of participants in a conference call
Join a conferenceJoinConferencePOSTJoin an existing call leg to a conference.
Leave a conferenceLeaveConferencePOSTRemoves a call leg from a conference and moves it back to parked state.
List conference participantsListConferenceParticipantsGETLists conference participants
List conferencesListConferencesGETLists conferences.
Mute conference participantsMuteConferenceParticipantsPOSTMute a list of participants in a conference call
Play audio to conference participantsPlayConferenceAudioPOSTPlay audio to all or some participants on a conference call.
Retrieve a conferenceRetrieveConferenceGETRetrieve an existing conference
Retrieve a conference participantRetrieveConferenceParticipantGETRetrieve details of a specific conference participant by their ID or label.
Send DTMF to conference participantsConferenceSendDTMFPOSTSend DTMF tones to one or more conference participants.
Speak text to conference participantsSpeakTextToConferencePOSTConvert text to speech and play it to all or some participants.
Stop audio being played on the conferenceStopConferenceAudioPOSTStop audio being played to all or some participants on a conference call.
Unhold conference participantsUnholdConferenceParticipantsPOSTUnhold a list of participants in a conference call
Unmute conference participantsUnmuteConferenceParticipantsPOSTUnmute a list of participants in a conference call
Update a conference participantUpdateConferenceParticipantPATCHUpdate properties of a conference participant.
Update conference participantUpdateConferencePOSTUpdate conference participant supervisor role
Connection2
List connectionsListConnectionsGETReturns a list of your connections irrespective of type.
Retrieve a connectionRetrieveConnectionGETRetrieves the high-level details of an existing connection.
Conversation21
Aggregate Conversation Insightsaggregate_conversation_insightsGETAggregate conversation insights by specified fields
Assign Insight Template To Groupassign_insight_to_groupPOSTAssign an insight to a group
Create a conversationcreate_new_conversation_public_conversations_postPOSTCreate a new AI Conversation.
Create Insight Templatecreate_insightPOSTCreate a new insight
Create Insight Template Groupcreate_insight_groupPOSTCreate a new insight group
Create Messageadd_new_messagePOSTAdd a new message to the conversation.
Delete a conversationdelete_conversation_by_id_public_conversations_deleteDELETEDelete a specific conversation by its ID.
Delete Insight Templatedelete_insight_by_idDELETEDelete insight by ID
Delete Insight Template Groupdelete_insight_group_by_idDELETEDelete insight group by ID
Get a conversationget_conversation_by_id_public_conversations_getGETRetrieve a specific AI conversation by its ID.
Get conversation messagesget_conversations_public_conversation_id_messages_getGETRetrieve messages for a specific conversation, including tool calls made by the assistant.
Get Insight Templateget_insight_by_idGETGet insight by ID
Get Insight Template Groupget_insight_group_by_idGETGet insight group by ID
Get Insight Template Groupsget_all_insight_groupsGETGet all insight groups
Get Insight Templatesget_all_insightsGETGet all insights
Get insights for a conversationget_conversations_public_conversation_id_insights_getGETRetrieve insights for a specific conversation
List conversationsget_conversations_public_conversations_getGETRetrieve a list of all AI conversations configured by the user.
Unassign Insight Template From Groupunassign_insight_from_groupDELETERemove an insight from a group
Update conversation metadataupdate_conversation_by_id_public_conversations_putPUTUpdate metadata for a specific conversation.
Update Insight Templateupdate_insight_by_idPUTUpdate an insight template
Update Insight Template Groupupdate_insight_group_by_idPUTUpdate an insight template group
Conversation History1
Search conversation historiesSearchConversationHistoriesGETPerforms semantic vector search across conversation history records.
Country Coverage2
Get country coverageretreiveCountryCoverageGETGet country coverage
Get coverage for a specific countryretreiveSpecificCountryCoverageGETGet coverage for a specific country
Coverage1
List network coverage locationsListNetworkCoverageGETList all locations and the interfaces that region supports
Credential5
Create a credentialCreateTelephonyCredentialPOSTCreate a credential.
Delete a credentialDeleteTelephonyCredentialDELETEDelete an existing credential.
Get a credentialGetTelephonyCredentialGETGet the details of an existing On-demand Credential.
List all credentialsFindTelephonyCredentialsGETList all On-demand Credentials.
Update a credentialUpdateTelephonyCredentialPATCHUpdate an existing credential.
Credential Connection6
Check a Credential Connection Registration StatusCheckRegistrationStatusPOSTChecks 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 connectionCreateCredentialConnectionPOSTCreates a credential connection.
Delete a credential connectionDeleteCredentialConnectionDELETEDeletes an existing credential connection.
List credential connectionsListCredentialConnectionsGETReturns a list of your credential connections.
Retrieve a credential connectionRetrieveCredentialConnectionGETRetrieves the details of an existing credential connection.
Update a credential connectionUpdateCredentialConnectionPATCHUpdates settings of an existing credential connection.
CSV Download3
Create a CSV downloadCreateCsvDownloadPOST
List CSV downloadsListCsvDownloadsGET
Retrieve a CSV downloadGetCsvDownloadGET
Customer Service Record4
Create a customer service recordCreateCustomerServiceRecordPOSTCreate a new customer service record for the provided phone number.
Get a customer service recordGetCustomerServiceRecordGETGet a specific customer service record.
List customer service recordsListCustomerServiceRecordsGETList customer service records.
Verify CSR phone number coverageVerifyPhoneNumberCoveragePOSTVerify the coverage for a list of phone numbers.
Data Migration9
Create a MigrationCreateMigrationPOSTInitiate a migration of data from an external provider into Telnyx Cloud Storage.
Create a Migration SourceCreateMigrationSourcePOSTCreate a source from which data can be migrated from.
Delete a Migration SourceDeleteMigrationSourceDELETE
Get a MigrationGetMigrationGET
Get a Migration SourceGetMigrationSourceGET
List all Migration SourcesListMigrationSourcesGET
List all MigrationsListMigrationsGET
List Migration Source coverageListMigrationSourceCoverageGET
Stop a MigrationStopMigrationPOST
Debugging1
List call eventsListCallEventsGETFilters call events by given filter parameters.
Detail Record1
Search detail recordsSearchDetailRecordsGETSearch for any detail record across the Telnyx Platform
Dialogflow Integration4
Create a Dialogflow ConnectionCreateDialogflowConnectionPOSTSave Dialogflow Credentiails to Telnyx, so it can be used with other Telnyx services.
Delete stored Dialogflow ConnectionDeleteDialogflowConnectionDELETEDeletes a stored Dialogflow Connection.
Retrieve stored Dialogflow ConnectionGetDialogflowConnectionGETReturn details of the Dialogflow connection associated with the given CallControl connection.
Update stored Dialogflow ConnectionUpdateDialogflowConnectionPUTUpdates a stored Dialogflow Connection.
DIR Reference3
List a DIR's referenceslistDirReferencesGETList the business and financial references submitted for a DIR.
Submit a DIR's referencessubmitDirReferencesPOSTSubmit the two business references and one financial reference for a DIR.
Update a DIR referenceupdateDirReferencePATCHPartially 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)createDirPOSTCreate a new DIR under the given enterprise.
Delete a DIRdeleteDirSimpleDELETEDelete a DIR.
Get a DIR by idgetDirByIdSimpleGETReturns a single DIR by id.
List all DIRs across your enterpriseslistAllDirsGETReturns every DIR (Display Identity Record) you own, across all of your enterprises, as a single list.
List DIRs in an enterpriselistDirsForEnterpriseGETReturn the DIRs (Display Identity Records) belonging to a single enterprise.
Render the Branded Calling LOA for a DIRrenderDirLoaPOSTGenerate a pre-filled Letter of Authorization (LOA) PDF for a DIR.
Submit a DIR for vettingsubmitDirSimplePOSTSubmit a DIR for vetting.
Update a DIRupdateDirSimplePATCHEdit a DIR.
Document8
Delete a documentDeleteDocumentDELETEDelete a document.
Download a documentDownloadDocumentGETDownload a document.
Generate a temporary download link for a documentgetDocumentDownloadLinkGETGenerates a temporary pre-signed URL that can be used to download the document directly from the storage backend without authentication.
List all document linksListDocumentLinksGETList all documents links ordered by created at descending.
List all documentsListDocumentsGETList all documents ordered by created at descending.
Retrieve a documentRetrieveDocumentGETRetrieve a document.
Update a documentUpdateDocumentPATCHUpdate a document.
Upload a documentCreateDocumentPOSTUpload a document.
Dynamic Emergency Address4
Create a dynamic emergency address.CreateDynamicEmergencyAddressPOSTCreates a dynamic emergency address.
Delete a dynamic emergency addressDeleteDynamicEmergencyAddressDELETEDeletes the dynamic emergency address based on the ID provided
Get a dynamic emergency addressGetDynamicEmergencyAddressGETReturns the dynamic emergency address based on the ID provided
List dynamic emergency addressesListDynamicEmergencyAddressesGETReturns the dynamic emergency addresses according to filters
Dynamic Emergency Endpoint4
Create a dynamic emergency endpoint.CreateDynamicEmergencyEndpointPOSTCreates a dynamic emergency endpoints.
Delete a dynamic emergency endpointDeleteDynamicEmergencyEndpointDELETEDeletes the dynamic emergency endpoint based on the ID provided
Get a dynamic emergency endpointGetDynamicEmergencyEndpointGETReturns the dynamic emergency endpoint based on the ID provided
List dynamic emergency endpointsListDynamicEmergencyEndpointsGETReturns the dynamic emergency endpoints according to filters
Email Domain6
Create an email domaincreateEmailDomainPOST
Delete an email domaindeleteEmailDomainDELETE
Get domain health summarygetEmailDomainHealthGETReturns a summary of domain health including verification status and usability.
List email domainslistEmailDomainsGETShared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains.
Retrieve an email domaingetEmailDomainGETShared (type: shared) Telnyx-managed domains are included/readable for every account, in addition to the account's own custom domains.
Update an email domainupdateEmailDomainPATCH
Email Domain DNS Record2
List DNS records for an email domainlistEmailDomainDnsRecordsGET
Verify DNS records for an email domainverifyEmailDomainDnsRecordsPOST
Email Draft8
Create a draftCreateEmailDraftPOSTCreates an unsent draft in the inbox.
Create a reply draftCreateEmailReplyDraftPOSTCreates an unsent reply draft for an inbound message.
Delete a draftDeleteEmailDraftDELETEPermanently deletes an unsent draft.
List drafts in an inboxListEmailDraftsGETLists drafts newest first using stable cursor pagination.
Retrieve a draftGetEmailDraftGETReturns a single draft.
Send a draftSendEmailDraftPOSTSends 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 draftUpdateEmailDraftPUTUpdates the supplied fields on a draft.
Update a draft (alias)PatchEmailDraftPATCHIdentical to PUT; both apply a partial update to the supplied fields.
Email Event2
Get email event statisticsGetEmailEventStatsGETReturns counts and rates for email events over a time range.
List account email eventsListEmailEventsGETLists account-level email events sorted oldest first by occurred at asc, id asc.
Email Inbox19
Add labels to an inbox messageAddEmailInboxMessageLabelsPOSTAdds one or more mutable labels to a message.
Add labels to an inbox threadAddEmailInboxThreadLabelsPOSTAdds 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 inboxAddEmailInboxFilterEntriesPOSTAdds entries to either the allowlist or blocklist.
Create an email inboxCreateEmailInboxPOSTCreates an inbox on an inbound-enabled domain.
Delete an email inboxDeleteEmailInboxDELETESoft-deletes an account-scoped inbox.
Forward an inbox messageForwardEmailInboxMessagePOSTSends 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 messagesGetEmailInboxThreadGETReturns a bounded page of inbound and outbound thread messages interleaved in chronological order using stable cursor pagination.
Get an email inboxGetEmailInboxGETReturns an account-scoped, non-deleted inbox.
List and search messages in an inboxListEmailInboxMessagesGETLists inbound messages newest first.
List email inboxesListEmailInboxesGETLists the account's non-deleted inboxes newest first using stable cursor pagination.
List sender filters for an inboxListEmailInboxFiltersGETReturns the inbox's sender allowlist and blocklist.
List threads in an inboxListEmailInboxThreadsGETLists thread summaries newest first using stable cursor pagination.
Remove labels from an inbox messageRemoveEmailInboxMessageLabelsDELETERemoves one or more labels from a message.
Remove labels from an inbox threadRemoveEmailInboxThreadLabelsDELETERemoves one or more labels from a thread.
Remove sender filter entries from an inboxRemoveEmailInboxFilterEntriesDELETERemoves entries from either the allowlist or blocklist.
Replace sender filters for an inboxReplaceEmailInboxFiltersPUTReplaces both sender filter lists atomically.
Reply all to an inbox messageReplyAllToEmailInboxMessagePOSTSends from the inbox address through the standard email send pipeline.
Reply to an inbox messageReplyToEmailInboxMessagePOSTSends from the inbox address through the standard email send pipeline.
Update an inbox messageUpdateEmailInboxMessagePATCHUpdates the explicit read state of an account-scoped inbound message.
Email Message10
Cancel a scheduled email messageCancelScheduledEmailMessageDELETECancels a scheduled email and returns it with status cancelled.
Create a batch of email messagesCreateEmailMessageBatchPOSTCreates up to 50 email messages in a single request.
Create or send an email messageCreateEmailMessagePOSTQueues, schedules, or sandbox-sends an email message.
Delete an email messageDeleteEmailMessageDELETEPermanently deletes an account-scoped email message, its events, its durable recipients, and unshared attachment objects.
Delete email messages by addressDeleteEmailMessagesByAddressDELETEPermanently 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 stateGetEmailMessageRecipientGETReturns the current delivery state of a single recipient, including status, billable flag, SMTP detail, and lifecycle timestamps.
Get an email messageGetEmailMessageGETThe legacy /v2/emails/{id} GET route is a backward-compatible alias for this operation.
List email messagesListEmailMessagesGETLists messages sorted newest first by inserted at desc, id desc.
List events for an email messageListEmailMessageEventsGETLists events for a single message sorted oldest first by occurred at asc, id asc.
List recipients for an email messageListEmailMessageRecipientsGETLists per-recipient delivery states for a single message with cursor pagination.
Email Suppression6
Create a manual suppressioncreateEmailBlockPOSTCreates a suppression with reason: manual block and source: manual.
Export suppressions as CSVexportEmailBlocksGETStreams the account's suppressions as a chunked CSV (server-side cursor; never materialized).
List audit events for a suppressionlistEmailBlockEventsGETOffset pagination only (page[number] default 1, page[size] default 50 , max 100).
List suppressionslistEmailBlocksGETAccount-scoped list.
Retrieve a suppressionshowEmailBlockGET
Soft-delete a suppressiondeleteEmailBlockDELETESoft-deletes (status → removed; tombstone retained).
Email Suppression Import2
Create an async CSV import jobcreateEmailBlockImportPOSTAccepts multipart/form-data with a file field (the CSV) and an optional block ttl days (integer 0, default 30).
Poll an import jobshowEmailBlockImportGETAccount-scoped fetch (cross-account → 404; malformed UUID → 404).
Email Template7
Create an email templateCreateEmailTemplatePOSTCreates a Liquid email template.
Delete an email templateDeleteEmailTemplateDELETE
Get an email templateGetEmailTemplateGET
List email templatesListEmailTemplatesGETLists templates sorted newest first by inserted at desc, id desc.
Render an email templateRenderEmailTemplatePOSTRenders a template using the provided Liquid variables.
Replace an email templateReplaceEmailTemplatePUTReplaces template fields.
Update an email templateUpdateEmailTemplatePATCHUpdates one or more template fields.
Email Thread2
Get an account-wide thread and a page of its messagesGetEmailThreadGETReturns a thread and a bounded page of its inbound and outbound messages, interleaved in chronological order.
List threads across every inbox in the accountListEmailThreadsGETLists thread summaries for the whole account, newest first, using stable cursor pagination.
Email Unsubscribe Group8
Add a group suppressionaddGroupSuppressionPOSTCreates a suppression with reason: unsubscribe, source: manual, group id: .
Create an unsubscribe groupcreateUnsubscribeGroupPOST
Delete an unsubscribe groupdeleteUnsubscribeGroupDELETEIf the group has 0 active suppressions, hard-deletes the row.
List suppressions in a grouplistGroupSuppressionsGETAccount + group scoped.
List unsubscribe groupslistUnsubscribeGroupsGETOffset pagination only (page[number] default 1, page[size] default 25, max 100).
Remove a group suppressionremoveGroupSuppressionDELETESoft-deletes all active blocks for (account, group, normalized email) - one removed audit event per block (actor: manual).
Retrieve an unsubscribe groupshowUnsubscribeGroupGET
Update an unsubscribe groupupdateUnsubscribeGroupPATCHPartial update (only name / description).
Email Validation3
Create a batch email validation jobCreateEmailValidationBatchPOSTCreates an asynchronous batch validation job for up to 1,000 email addresses.
Get a batch email validation jobGetEmailValidationBatchGETRetrieves the current status and, once completed, validation results for a batch job.
Validate a single email addressCreateEmailValidationPOSTValidates a single email address and returns deliverability checks.
Email Verification3
Confirm an email-ownership verification codeconfirmDirEmailVerificationPOSTSubmit the 6-digit code that was emailed to the DIR's authorizer email.
Get email-ownership verification statusgetDirEmailVerificationStatusGETWhether the DIR's current authorizer email has been verified.
Send an email-ownership verification coderequestDirEmailVerificationPOSTEmail a 6-digit code to the DIR's authorizer email to confirm ownership of that address.
Email Webhook5
Create a webhook for an email domaincreateEmailDomainWebhookPOSTCreates a webhook endpoint subscribed to a specific allowlist of event types.
Delete a webhookdeleteEmailDomainWebhookDELETE
List webhooks for an email domainlistEmailDomainWebhooksGET
Retrieve a webhookgetEmailDomainWebhookGET
Update a webhookupdateEmailDomainWebhookPATCHUpdate a webhook's URL and/or event subscription.
Embedding8
Disable AI for an Embedded Bucketembedding_bucket_files_public_embedding_buckets_bucket_name_deleteDELETEDeletes an entire bucket's embeddings and disables the bucket for AI-use, returning it to normal storage pricing.
Embed documentsPostEmbeddingPOSTPerform embedding on a Telnyx Storage Bucket using the a embedding model.
Embed URL contentPostEmbeddingUrlPOSTEmbed website content from a specified URL, including child pages up to 5 levels deep within the same domain.
Get an embedding task's statusGetEmbeddingTaskGETCheck the status of a current embedding task.
Get file-level embedding statuses for a bucketGetBucketNameGETGet all embedded files for a given user bucket, including their processing status.
Get Tasks by StatusGetTasksByStatusGETRetrieve tasks for the user that are either queued, processing, failed, success or partial success based on the query string.
List embedded bucketsGetEmbeddingBucketsGETGet all embedding buckets for a user.
Search for documentsPostEmbeddingSimilaritySearchPOSTPerform 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 enterpriseactivateBrandedCallingPOSTBranded Calling is a paid product that must be activated on each enterprise.
Create an enterprisecreateEnterprisePOSTCreate the legal entity (enterprise) that represents your business on the Telnyx platform.
Delete an enterprisedeleteEnterpriseDELETESoft-delete an enterprise.
Get an enterprisegetEnterpriseGETRetrieve a single enterprise by id.
List enterpriseslistEnterprisesGETReturn the enterprises you own, paginated.
Replace an enterpriseupdateEnterprisePUTReplace the enterprise's mutable fields.
Enum1
Get EnumGetEnumEndpointGET
External Connection23
Creates an External ConnectionCreateExternalConnectionPOSTCreates a new External Connection based on the parameters sent in the request.
Creates an Upload requestCreateExternalConnectionUploadPOSTCreates a new Upload request to Microsoft teams with the included phone numbers.
Deletes an External ConnectionDeleteExternalConnectionDELETEPermanently deletes an External Connection.
Dismiss a log messageDeleteExternalConnectionLogMessageDELETEDismiss a log message for an external connection associated with your account.
Get the count of pending upload requestsGetExternalConnectionUploadsStatusGETReturns the count of all pending upload requests for the given external connection.
List all civic addresses and locationsListCivicAddressesGETReturns the civic addresses and locations from Microsoft Teams.
List all External ConnectionsListExternalConnectionsGETThis endpoint returns a list of your External Connections inside the 'data' attribute of the response.
List all log messagesListExternalConnectionLogMessagesGETRetrieve a list of log messages for all external connections associated with your account.
List all phone numbersListExternalConnectionPhoneNumbersGETReturns a list of all active phone numbers associated with the given external connection.
List all ReleasesListExternalConnectionReleasesGETReturns a list of your Releases for the given external connection.
List all Upload requestsListExternalConnectionUploadsGETReturns a list of your Upload requests for the given external connection.
Refresh Operator Connect integrationOperatorConnectRefreshPOSTThis 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 requestsRefreshExternalConnectionUploadsPOSTForces a recheck of the status of all pending Upload requests for the given external connection in the background.
Retrieve a Civic AddressGetExternalConnectionCivicAddressGETReturn the details of an existing Civic Address with its Locations inside the 'data' attribute of the response.
Retrieve a log messageGetExternalConnectionLogMessageGETRetrieve a log message for an external connection associated with your account.
Retrieve a phone numberGetExternalConnectionPhoneNumberGETReturn the details of a phone number associated with the given external connection.
Retrieve a Release requestGetExternalConnectionReleaseGETReturn the details of a Release request and its phone numbers.
Retrieve an External ConnectionGetExternalConnectionGETReturn the details of an existing External Connection inside the 'data' attribute of the response.
Retrieve an Upload requestGetExternalConnectionUploadGETReturn the details of an Upload request and its phone numbers.
Retry an Upload requestRetryUploadPOSTIf there were any errors during the upload process, this endpoint will retry the upload request.
Update a location's static emergency addressupdateLocationPATCH
Update a phone numberUpdateExternalConnectionPhoneNumberPATCHAsynchronously update settings of the phone number associated with the given external connection.
Update an External ConnectionUpdateExternalConnectionPATCHUpdates settings of an existing External Connection based on the parameters of the request.
Fine Tuning4
Cancel a fine tuning jobcancel_new_finetuningjob_public_finetuning_postPOSTCancel a fine tuning job.
Create a fine tuning jobcreate_new_finetuningjob_public_finetuning_postPOSTCreate a new fine tuning job.
Get a fine tuning jobget_finetuningjob_public_finetuning_job_id_getGETRetrieve a fine tuning job by job id.
List fine tuning jobsget_finetuningjob_public_finetuning_getGETRetrieve a list of all fine tuning jobs created by the user.
FQDN5
Create an FQDNCreateFqdnPOSTCreate a new FQDN object.
Delete an FQDNDeleteFqdnDELETEDelete an FQDN.
List FQDNsListFqdnsGETGet all FQDNs belonging to the user that match the given filters.
Retrieve an FQDNRetrieveFqdnGETReturn the details regarding a specific FQDN.
Update an FQDNUpdateFqdnPATCHUpdate the details of a specific FQDN.
FQDN Connection5
Create an FQDN connectionCreateFqdnConnectionPOSTCreates a FQDN connection.
Delete an FQDN connectionDeleteFqdnConnectionDELETEDeletes an FQDN connection.
List FQDN connectionsListFqdnConnectionsGETReturns a list of your FQDN connections.
Retrieve an FQDN connectionRetrieveFqdnConnectionGETRetrieves the details of an existing FQDN connection.
Update an FQDN connectionUpdateFqdnConnectionPATCHUpdates settings of an existing FQDN connection.
Global IP21
Create a Global IPCreateGlobalIpPOSTCreate a Global IP.
Create a Global IP assignmentCreateGlobalIpAssignmentPOSTCreate a Global IP assignment.
Create a Global IP health checkCreateGlobalIpHealthCheckPOSTCreate a Global IP health check.
Delete a Global IPDeleteGlobalIpDELETEDelete a Global IP.
Delete a Global IP assignmentDeleteGlobalIpAssignmentDELETEDelete a Global IP assignment.
Delete a Global IP health checkDeleteGlobalIpHealthCheckDELETEDelete a Global IP health check.
Global IP Assignment Health Check MetricsGetGlobalIpAssignmentHealthGET
Global IP Assignment Usage MetricsGetGlobalIpAssignmentUsageGET
Global IP Assignment Usage MetricsGetGlobalIpAssignmentUsage_get_global_ip_assignments_usageGET
Global IP Latency MetricsGetGlobalIpLatencyGET
Global IP Usage MetricsGetGlobalIpUsageGET
List all Global IP Allowed PortsListGlobalIpAllowedPortsGETList all Global IP Allowed Ports
List all Global IP assignmentsListGlobalIpAssignmentsGETList all Global IP assignments.
List all Global IP Health check typesListGlobalIpHealthCheckTypesGETList all Global IP Health check types.
List all Global IP health checksListGlobalIpHealthChecksGETList all Global IP health checks.
List all Global IP ProtocolsListGlobalIpProtocolsGETList all Global IP Protocols
List all Global IPsListGlobalIpsGETList all Global IPs.
Retrieve a Global IPGetGlobalIpGETRetrieve a Global IP.
Retrieve a Global IPGetGlobalIpAssignmentGETRetrieve a Global IP assignment.
Retrieve a Global IP health checkGetGlobalIpHealthCheckGETRetrieve a Global IP health check.
Update a Global IP assignmentUpdateGlobalIpAssignmentPATCHUpdate a Global IP assignment.
Hosted Number9
Check hosted messaging eligibilityCheckEligibilityNumbersPOST
Create a messaging hosted number orderCreateMessagingHostedNumberOrderPOST
Create hosted number verification codesCreateVerificationCodesForMessagingHostedNumberOrderPOSTCreate verification codes to validate numbers of the hosted order.
Delete a messaging hosted numberDeleteMessagingHostedNumberDELETE
Delete a messaging hosted number orderDeleteMessagingHostedNumberOrderDELETEDelete a messaging hosted number order and all associated phone numbers.
List messaging hosted number ordersListMessagingHostedNumberOrdersGET
Retrieve a messaging hosted number orderGetMessagingHostedNumberOrderGET
Upload hosted number documentUploadMessagingHostedNumberOrderFilePOST
Validate hosted number codesValidateVerificationCodesForMessagingHostedNumberOrderPOSTValidate the verification codes sent to the numbers of the hosted order.
Inexplicit Number Order3
Create an inexplicit number orderCreateInexplicitNumberOrderPOSTCreate an inexplicit number order to programmatically purchase phone numbers without specifying exact numbers.
List inexplicit number ordersListInexplicitNumberOrdersGETGet a paginated list of inexplicit number orders.
Retrieve an inexplicit number orderRetrieveInexplicitNumberOrderGETGet an existing inexplicit number order by ID.
Infringement Claim4
Contest an infringement claimcontestInfringementClaimPOSTSubmit a written response and supporting documents disputing the claim.
Get an infringement claimgetInfringementClaimGETRetrieve a single claim by id.
List infringement claims for a DIRlistInfringementClaimsForDirGETReturn the trademark or copyright claims filed against this DIR.
Update a DIR to resolve an infringement concernupdateDirInfringementPUTPush a fix for a DIR that is suspended with an open infringement claim back into vetting.
Integration5
Delete Integration Connectiondelete_integration_connectionDELETEDelete a specific integration connection.
Get User Integration connection By Idget_user_integration_by_id_public_integrations_connections_user_connection_id_getGETGet user setup integrations
List Integration By Idlist_integration_by_id_public_integrations_integration_id_getGETRetrieve integration details
List Integrationslist_integrations_public_integrations_getGETList all available integrations.
List User Integrationslist_user_integrations_public_integrations_connections_getGETList user setup integrations
Integration Secret3
Create a secretcreate_integration_secretPOSTCreate a new secret with an associated identifier that can be used to securely integrate with other services.
Delete an integration secretdelete_integration_secretDELETEDelete an integration secret given its ID.
List integration secretslist_integration_secretsGETRetrieve a list of all integration secrets configured by the user.
Inventory Level1
Create an inventory coverage requestCreateInventoryCoverageGETCreates an inventory coverage request.
Invoice2
Get invoiceGetInvoiceByIdGETRetrieve a single invoice by its unique identifier.
List invoicesListInvoicesGETRetrieve a paginated list of invoices.
IP5
Create an IpCreateIpPOSTCreate a new IP object.
Delete an IpDeleteIpDELETEDelete an IP.
List IpsListIpsGETGet all IPs belonging to the user that match the given filters.
Retrieve an IpRetrieveIpGETReturn the details regarding a specific IP.
Update an IpUpdateIpPATCHUpdate the details of a specific IP.
IP Address4
Create new Access IP AddressCreateAccessIpAddressPOST
Delete access IP addressDeleteAccessIpAddressDELETE
List all Access IP AddressesListAccessIpAddressesGET
Retrieve an access IP addressGetAccessIpAddressGET
IP Connection5
Create an Ip connectionCreateIpConnectionPOSTCreates an IP connection.
Delete an Ip connectionDeleteIpConnectionDELETEDeletes an existing IP connection.
List Ip connectionsListIpConnectionsGETReturns a list of your IP connections.
Retrieve an Ip connectionRetrieveIpConnectionGETRetrieves the details of an existing ip connection.
Update an Ip connectionUpdateIpConnectionPATCHUpdates settings of an existing IP connection.
IP Range3
Create new Access IP RangeCreateAccessIPRangePOST
Delete access IP rangesDeleteAccessIpRangeDELETE
List all Access IP RangesListAccessIpRangesGET
Kv Key4
Delete a keyDeleteKvKeyDELETEDeletes a key.
Get a key's valueGetKvKeyGETReturns the raw stored value for a key.
List keysListKvKeysGETLists the keys in a namespace.
Set a key's valuePutKvKeyPUTCreates or replaces the value for a key.
Kv Namespace4
Create a KV namespaceCreateKvNamespacePOSTCreates a new KV namespace.
Delete a KV namespaceDeleteKvNamespaceDELETEDeletes a KV namespace and all of the keys it contains.
Get a KV namespaceGetKvNamespaceGETRetrieves a KV namespace by its ID, including its provisioning status.
List KV namespacesListKvNamespacesGETLists the KV namespaces for the authenticated user's organization.
Managed Account8
Create a new managed account.CreateManagedAccountPOSTCreate a new managed account owned by the authenticated user.
Disables a managed accountDisableManagedAccountPOSTDisables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages.
Display information about allocatable global outbound channelsListAllocatableGlobalOutboundChannelsGETDisplay information about allocatable global outbound channels for the current user.
Enables a managed accountEnableManagedAccountPOSTEnables a managed account and its sub-users to use Telnyx services.
Lists accounts managed by the current user.ListManagedAccountsGETLists the accounts managed by the current user.
Retrieve a managed accountRetrieveManagedAccountGETRetrieves the details of a single managed account.
Update a managed accountUpdateManagedAccountPATCHUpdate a single managed account.
Update the amount of allocatable global outbound channelsUpdateManagedAccountGlobalChannelLimitPATCHUpdate the amount of allocatable global outbound channels allocated to a specific managed account.
MCP Server5
Create MCP Servercreate_mcp_serverPOSTCreate a new MCP server.
Delete MCP Serverdelete_mcp_serverDELETEDelete a specific MCP server.
Get MCP Serverget_mcp_serverGETRetrieve details for a specific MCP server.
List MCP Serverslist_mcp_serversGETRetrieve a list of MCP servers.
Update MCP Serverupdate_mcp_serverPUTUpdate an existing MCP server.
MDR Detail Report1
Fetch all Mdr recordsGetPaginatedMdrsGETFetch all Mdr records
MDR Detailed Report8
Create a new MDR detailed report requestsubmitMdrRequestPOSTCreates a new MDR detailed report request with the specified filters
Create a new MDR detailed report requestsubmitMdrRequest_post_legacy_reporting_batch_detail_records_messagingPOSTCreates a new MDR detailed report request with the specified filters
Delete a MDR detailed report requestdeleteMdrRequestDELETEDeletes a specific MDR detailed report request by ID
Delete a MDR detailed report requestdeleteMdrRequest_delete_legacy_reporting_batch_detail_records_messaging_idDELETEDeletes a specific MDR detailed report request by ID
Get a specific MDR detailed report requestgetMdrRequestGETRetrieves a specific MDR detailed report request by ID
Get a specific MDR detailed report requestgetMdrRequest_get_legacy_reporting_batch_detail_records_messaging_idGETRetrieves a specific MDR detailed report request by ID
Get all MDR detailed report requestsgetMdrRequestsGETRetrieves all MDR detailed report requests for the authenticated user
Get all MDR detailed report requestsgetMdrRequests_get_legacy_reporting_batch_detail_records_messagingGETRetrieves all MDR detailed report requests for the authenticated user
MDR Usage Report13
Create a new legacy usage V2 MDR report requestsubmitMdrUsageReportPOSTCreates 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_messagingPOSTCreates a new legacy usage V2 MDR report request with the specified filters
Create MDR Usage ReportSubmitUsageReportPOSTSubmit request for new new messaging usage report.
Delete a V2 legacy usage MDR report requestdeleteMdrUsageReportDELETEDeletes a specific V2 legacy usage MDR report request by ID
Delete a V2 legacy usage MDR report requestdeleteMdrUsageReport_delete_legacy_reporting_usage_reports_messaging_idDELETEDeletes a specific V2 legacy usage MDR report request by ID
Delete MDR Usage ReportDeleteUsageReportDELETEDelete messaging usage report by id
Fetch all Messaging usage reportsGetMdrUsageReportsGETFetch all messaging usage reports.
Generate and fetch MDR Usage ReportGetMDRUsageReportSyncGETGenerate and fetch messaging usage report synchronously.
Get an MDR usage reportgetMdrUsageReportGETFetch single MDR usage report by id.
Get an MDR usage reportgetMdrUsageReport_get_legacy_reporting_usage_reports_messaging_idGETFetch single MDR usage report by id.
List MDR usage reportsgetMdrUsageReportsGETFetch all previous requests for MDR usage reports.
List MDR usage reportsgetMdrUsageReports_get_legacy_reporting_usage_reports_messagingGETFetch all previous requests for MDR usage reports.
Retrieve messaging reportGetUsageReportGETFetch a single messaging usage report by id
Media Storage API6
Deletes stored mediaDeleteMediaStorageDELETEDeletes a stored media file.
Download stored mediaDownloadMediaGETDownloads a stored media file.
List uploaded mediaListMediaStorageGETReturns a list of stored media files.
Retrieve stored mediaGetMediaStorageGETReturns the information about a stored media file.
Update stored mediaUpdateMediaStoragePUTUpdates a stored media file.
Upload mediaCreateMediaStoragePOSTUpload media file to Telnyx so it can be used with other Telnyx services
Message11
Cancel a scheduled messageCancelMessageDELETECancel a scheduled message that has not yet been sent.
Retrieve a messageGetMessageGETNote: This API endpoint can only retrieve messages that are no older than 10 days since their creation.
Retrieve group MMS messagesGetGroupMmsMessagesGETRetrieve all messages in a group MMS conversation by the group message ID.
Schedule a messageScheduleMessagePOSTSchedule a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.
Send a group MMS messageCreateGroupMmsMessagePOST
Send a long code messageCreateLongCodeMessagePOST
Send a messageSendMessagePOSTSend a message with a Phone Number, Alphanumeric Sender ID, Short Code or Number Pool.
Send a message using an alphanumeric sender IDSendAlphanumericSenderIdMessagePOSTSend an SMS message using an alphanumeric sender ID.
Send a message using an alphanumeric sender IDSendAlphanumericSenderIdMessage_post_messages_alphanumeric_sender_idPOSTSend an SMS message using an alphanumeric sender ID.
Send a message using number poolCreateNumberPoolMessagePOST
Send a short code messageCreateShortCodeMessagePOST
Messaging15
Create an alphanumeric sender IDCreateAlphanumericSenderIdPOSTCreate a new alphanumeric sender ID associated with a messaging profile.
Delete an alphanumeric sender IDDeleteAlphanumericSenderIdDELETEDelete an alphanumeric sender ID and disassociate it from its messaging profile.
Get detailed messaging profile metricsGetDetailedProfileMetricsGETGet detailed metrics for a specific messaging profile, broken down by time interval.
Get detailed messaging profile metricsGetDetailedProfileMetrics_get_messaging_profiles_id_metricsGETGet detailed metrics for a specific messaging profile, broken down by time interval.
List alphanumeric sender IDsListAlphanumericSenderIdsGETList all alphanumeric sender IDs for the authenticated user.
List alphanumeric sender IDs for a messaging profileListProfileAlphanumericSenderIdsGETList all alphanumeric sender IDs associated with a specific messaging profile.
List alphanumeric sender IDs for a messaging profileListProfileAlphanumericSenderIds_get_messaging_profiles_id_alphanumeric_sender_idsGETList all alphanumeric sender IDs associated with a specific messaging profile.
List high-level messaging profile metricsGetProfileMetricsGETList high-level metrics for all messaging profiles belonging to the authenticated user.
List messaging hosted numbersListMessagingHostedNumbersGETList all hosted numbers associated with the authenticated user.
List messaging hosted numbersListMessagingHostedNumbers_get_messaging_hosted_numbersGETList all hosted numbers associated with the authenticated user.
Regenerate messaging profile secretRegenerateMessagingProfileSecretPOSTRegenerate the v1 secret for a messaging profile.
Regenerate messaging profile secretRegenerateMessagingProfileSecret_post_messaging_profiles_id_actions_regenerate_secretPOSTRegenerate the v1 secret for a messaging profile.
Retrieve a messaging hosted numberGetMessagingHostedNumberGETRetrieve a specific messaging hosted number by its ID or phone number.
Retrieve an alphanumeric sender IDGetAlphanumericSenderIdGETRetrieve a specific alphanumeric sender ID.
Update a messaging hosted numberUpdateMessagingHostedNumberPATCHUpdate the messaging settings for a hosted number.
Messaging URL Domain1
List messaging URL domainsListMessagingUrlDomainsGET
Mission41
Add step(s) to planpost_public_missions_missions_mission_id_runs_run_id_plan_stepsPOSTAdd one or more steps to an existing plan
Cancel runpost_public_missions_missions_mission_id_runs_run_id_cancelPOSTCancel a running or paused run
Clone missionpost_public_missions_missions_mission_id_clonePOSTClone an existing mission
Create initial planpost_public_missions_missions_mission_id_runs_run_id_planPOSTCreate the initial plan for a run
Create knowledge basepost_public_missions_missions_mission_id_knowledge_basesPOSTCreate a new knowledge base for a mission
Create MCP serverpost_public_missions_missions_mission_id_mcp_serversPOSTCreate a new MCP server for a mission
Create missionpost_public_missions_missionsPOSTCreate a new mission definition
Create toolpost_public_missions_missions_mission_id_toolsPOSTCreate a new tool for a mission
Delete knowledge basedelete_public_missions_missions_mission_id_knowledge_bases_knowledge_base_idDELETEDelete a knowledge base from a mission
Delete MCP serverdelete_public_missions_missions_mission_id_mcp_servers_mcp_server_idDELETEDelete an MCP server from a mission
Delete missiondelete_public_missions_missions_mission_idDELETEDelete a mission
Delete tooldelete_public_missions_missions_mission_id_tools_tool_idDELETEDelete a tool from a mission
Get event detailsget_public_missions_missions_mission_id_runs_run_id_events_event_idGETGet details of a specific event
Get knowledge baseget_public_missions_missions_mission_id_knowledge_bases_knowledge_base_idGETGet a specific knowledge base by ID
Get MCP serverget_public_missions_missions_mission_id_mcp_servers_mcp_server_idGETGet a specific MCP server by ID
Get missionget_public_missions_missions_mission_idGETGet a mission by ID (includes tools, knowledge bases, mcp servers)
Get planget_public_missions_missions_mission_id_runs_run_id_planGETGet the plan (all steps) for a run
Get run detailsget_public_missions_missions_mission_id_runs_run_idGETGet details of a specific run
Get step detailsget_public_missions_missions_mission_id_runs_run_id_plan_steps_step_idGETGet details of a specific plan step
Get toolget_public_missions_missions_mission_id_tools_tool_idGETGet a specific tool by ID
Link Telnyx agent to runpost_public_missions_missions_mission_id_runs_run_id_telnyx_agentsPOSTLink a Telnyx AI agent (voice/messaging) to a run
List eventsget_public_missions_missions_mission_id_runs_run_id_eventsGETList events for a run (paginated)
List knowledge basesget_public_missions_missions_mission_id_knowledge_basesGETList all knowledge bases for a mission
List linked Telnyx agentsget_public_missions_missions_mission_id_runs_run_id_telnyx_agentsGETList all Telnyx agents linked to a run
List MCP serversget_public_missions_missions_mission_id_mcp_serversGETList all MCP servers for a mission
List missionsget_public_missions_missionsGETList all missions for the organization
List recent eventsget_public_missions_missions_eventsGETList recent events across all missions
List recent runsget_public_missions_missions_runsGETList recent runs across all missions
List runs for missionget_public_missions_missions_mission_id_runsGETList all runs for a specific mission
List toolsget_public_missions_missions_mission_id_toolsGETList all tools for a mission
Log eventpost_public_missions_missions_mission_id_runs_run_id_eventsPOSTLog an event for a run
Pause runpost_public_missions_missions_mission_id_runs_run_id_pausePOSTPause a running run
Resume runpost_public_missions_missions_mission_id_runs_run_id_resumePOSTResume a paused run
Start a runpost_public_missions_missions_mission_id_runsPOSTStart a new run for a mission
Unlink Telnyx agentdelete_public_missions_missions_mission_id_runs_run_id_telnyx_agents_telnyx_agent_idDELETEUnlink a Telnyx agent from a run
Update knowledge baseput_public_missions_missions_mission_id_knowledge_bases_knowledge_base_idPUTUpdate a knowledge base definition
Update MCP serverput_public_missions_missions_mission_id_mcp_servers_mcp_server_idPUTUpdate an MCP server definition
Update missionput_public_missions_missions_mission_idPUTUpdate a mission definition
Update runpatch_public_missions_missions_mission_id_runs_run_idPATCHUpdate run status and/or result
Update step statuspatch_public_missions_missions_mission_id_runs_run_id_plan_steps_step_idPATCHUpdate the status of a plan step
Update toolput_public_missions_missions_mission_id_tools_tool_idPUTUpdate a tool definition
Mobile Network Operator1
List mobile network operatorsGetMobileNetworkOperatorsGETTelnyx 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 settingsListMobilePhoneNumbersWithMessagingSettingsGET
Retrieve a mobile phone number with messaging settingsGetMobilePhoneNumberMessagingSettingsGET
Mobile Phone Number3
List Mobile Phone NumberslistMobilePhoneNumbersGET
Retrieve a Mobile Phone NumberretrieveMobilePhoneNumberGET
Update a Mobile Phone NumberupdateMobilePhoneNumberPATCH
Mobile Voice Connection5
Create a Mobile Voice ConnectioncreateMobileVoiceConnectionPOST
Delete a Mobile Voice ConnectiondeleteMobileVoiceConnectionDELETE
List Mobile Voice ConnectionslistMobileVoiceConnectionsGET
Retrieve a Mobile Voice ConnectionretrieveMobileVoiceConnectionGET
Update a Mobile Voice ConnectionupdateMobileVoiceConnectionPATCH
Network9
Create a NetworkCreateNetworkPOSTCreate a new Network.
Create Default Gateway.CreateDefaultGatewayPOSTCreate Default Gateway.
Delete a NetworkDeleteNetworkDELETEDelete a Network.
Delete Default Gateway.DeleteDefaultGatewayDELETEDelete Default Gateway.
Get Default Gateway status.GetDefaultGatewayGETGet Default Gateway status.
List all Interfaces for a Network.ListNetworkInterfacesGETList all Interfaces for a Network.
List all NetworksListNetworksGETList all Networks.
Retrieve a NetworkGetNetworkGETRetrieve a Network.
Update a NetworkUpdateNetworkPATCHUpdate a Network.
Notification16
Add a Notification SettingCreateNotificationSettingPOSTAdd a notification setting.
Create a notification channelCreateNotificationChannelsPOSTCreate a notification channel.
Create a notification profileCreateNotificationProfilePOSTCreate a notification profile.
Delete a notification channelDeleteNotificationChannelDELETEDelete a notification channel.
Delete a notification profileDeleteNotificationProfileDELETEDelete a notification profile.
Delete a notification settingDeleteNotificationSettingDELETEDelete a notification setting.
Get a notification channelGetNotificationChannelGETGet a notification channel.
Get a notification profileGetNotificationProfileGETGet a notification profile.
Get a notification settingGetNotificationSettingGETGet a notification setting.
List all Notifications EventsFindNotificationsEventsGETReturns a list of your notifications events.
List all Notifications Events ConditionsFindNotificationsEventsConditionsGETReturns a list of your notifications events conditions.
List all Notifications ProfilesFindNotificationsProfilesGETReturns a list of your notifications profiles.
List notification channelsListNotificationChannelsGETList notification channels.
List notification settingsListNotificationSettingsGETList notification settings.
Update a notification channelUpdateNotificationChannelPATCHUpdate a notification channel.
Update a notification profileUpdateNotificationProfilePATCHUpdate a notification profile.
Number Lookup1
Lookup phone number dataLookupNumberGETReturns information about the provided phone number.
Number Portout14
Create a comment on a portout requestPostPortRequestCommentPOSTCreates a comment on a portout request.
Create a list of supporting documents on a portout requestPostPortRequestSupportingDocumentsPOSTCreates a list of supporting documents on a portout request.
Create a port-out related reportCreatePortoutReportPOSTGenerate reports about port-out operations.
Get a portout requestFindPortoutRequestGETReturns the portout request based on the ID provided
List all comments for a portout requestFindPortoutCommentsGETReturns a list of comments for a portout request.
List all port-out eventslistPortoutEventsGETReturns a list of all port-out events.
List eligible port-out rejection codes for a specific orderListPortoutRejectionsGETGiven a port-out ID, list rejection codes that are eligible for that port-out
List port-out related reportsListPortoutReportsGETList the reports generated about port-out operations.
List portout requestsListPortoutRequestGETReturns the portout requests according to filters
List supporting documents on a portout requestGetPortRequestSupportingDocumentsGETList every supporting documents for a portout request.
Republish a port-out eventrepublishPortoutEventPOSTRepublish a specific port-out event.
Retrieve a reportGetPortoutReportGETRetrieve a specific report generated.
Show a port-out eventshowPortoutEventGETShow a specific port-out event.
Update StatusUpdatePortoutStatusPATCHAuthorize or reject portout request
Number Setting7
Bulk update phone number profilesBulkUpdateMessagingSettingsOnPhoneNumbersPOST
Bulk update phone number profilesBulkUpdateMessagingSettingsOnPhoneNumbers_post_messaging_numbers_bulk_updatesPOST
List phone numbers with messaging settingsListPhoneNumbersWithMessagingSettingsGET
Retrieve a phone number with messaging settingsGetPhoneNumberMessagingSettingsGET
Retrieve bulk update statusGetBulkUpdateMessagingSettingsOnPhoneNumbersStatusGET
Retrieve bulk update statusGetBulkUpdateMessagingSettingsOnPhoneNumbersStatus_get_messaging_numbers_bulk_updates_order_idGET
Update the messaging profile and/or messaging product of aUpdatePhoneNumberMessagingSettingsPATCH
Numbers Feature1
Retrieve the features for a list of numbersPostNumbersFeaturesPOSTRetrieve the features for a list of numbers
OAuth Client10
Create OAuth clientCreateOAuthClientPOSTCreate a new OAuth client
Create OAuth clientCreateOAuthClient_post_oauth_clientsPOSTCreate a new OAuth client
Delete OAuth clientDeleteOAuthClientDELETEDelete an OAuth client
Delete OAuth clientDeleteOAuthClient_delete_oauth_clients_idDELETEDelete an OAuth client
Get OAuth clientGetOAuthClientGETRetrieve a single OAuth client by ID
Get OAuth clientGetOAuthClient_get_oauth_clients_idGETRetrieve a single OAuth client by ID
List OAuth clientsListOAuthClientsGETRetrieve a paginated list of OAuth clients for the authenticated user
List OAuth clientsListOAuthClients_get_oauth_clientsGETRetrieve a paginated list of OAuth clients for the authenticated user
Update OAuth clientUpdateOAuthClientPUTUpdate an existing OAuth client
Update OAuth clientUpdateOAuthClient_put_oauth_clients_idPUTUpdate an existing OAuth client
OAuth Discovery2
Authorization server metadataGetOAuthAuthorizationServerMetadataGETOAuth 2.0 Authorization Server Metadata (RFC 8414)
Protected resource metadataGetOAuthProtectedResourceMetadataGETOAuth 2.0 Protected Resource Metadata for resource discovery
OAuth Grant6
Get OAuth grantGetOAuthGrantGETRetrieve a single OAuth grant by ID
Get OAuth grantGetOAuthGrant_get_oauth_grants_idGETRetrieve a single OAuth grant by ID
List OAuth grantsListOAuthGrantsGETRetrieve a paginated list of OAuth grants for the authenticated user
List OAuth grantsListOAuthGrants_get_oauth_grantsGETRetrieve a paginated list of OAuth grants for the authenticated user
Revoke OAuth grantRevokeOAuthGrantDELETERevoke an OAuth grant
Revoke OAuth grantRevokeOAuthGrant_delete_oauth_grants_idDELETERevoke an OAuth grant
OAuth Protocol7
Create OAuth grantCreateOAuthGrantPOSTCreate an OAuth authorization grant
Dynamic client registrationRegisterOAuthClientPOSTRegister a new OAuth client dynamically (RFC 7591)
Get OAuth consent tokenGetOAuthConsentTokenGETRetrieve details about an OAuth consent token
JSON Web Key SetGetOAuthJWKSGETRetrieve the JSON Web Key Set for token verification
OAuth authorization endpointAuthorizeOAuthGETOAuth 2.0 authorization endpoint for the authorization code flow
OAuth token endpointExchangeOAuthTokenPOSTExchange authorization code, client credentials, or refresh token for access token
Token introspectionIntrospectOAuthTokenPOSTIntrospect an OAuth access token to check its validity and metadata
OpenAI Chat3
Create a chat completion (OpenAI-compatible)create_openai_chat_completionPOSTChat with a language model.
Create an OpenAI-compatible responsechat_public_openai_responses_completions_postPOSTCreate a response using Telnyx's OpenAI-compatible Responses API.
Get available models (OpenAI-compatible)list_openai_modelsGETLists 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_embeddingsPOSTCreates an embedding vector representing the input text.
List embedding modelslist_openai_embedding_modelsGETReturns a list of available embedding models.
Opt Out Management6
Create auto-response settingCreateAutorespConfigPOST
Delete Auto-Response SettingDeleteAutorespConfigDELETE
Get Auto-Response SettingGetAutorespConfigGET
List Auto-Response SettingsGetAutorespConfigsGET
List opt-outsListOptOutsGETRetrieve a list of opt-out blocks.
Update Auto-Response SettingUpdateAutoRespConfigPUT
Organization User4
Delete organization userDeleteOrganizationUserPOSTDeletes a user in your organization.
Get organization userGetOrganizationUserGETReturns a user in your organization.
Get organization users groups reportGetOrganizationUsersGroupsReportGETReturns a report of all users in your organization with their group memberships.
List organization usersListOrganizationUsersGETReturns a list of the users in your organization.
OTA Update2
Get OTA updateGetOtaUpdateGETThis API returns the details of an Over the Air (OTA) update.
List OTA updatesListOtaUpdatesGET
Outbound Voice Profile5
Create an outbound voice profileCreateVoiceProfilePOSTCreate an outbound voice profile.
Delete an outbound voice profileDeleteOutboundVoiceProfileDELETEDeletes an existing outbound voice profile.
Get all outbound voice profilesListOutboundVoiceProfilesGETGet all outbound voice profiles belonging to the user that match the given filters.
Retrieve an outbound voice profileGetOutboundVoiceProfileGETRetrieves the details of an existing outbound voice profile.
Updates an existing outbound voice profile.UpdateOutboundVoiceProfilePATCHUpdates an existing outbound voice profile.
Phone Number3
Add phone numbers to a DIRaddDirPhoneNumbersSimplifiedPOSTRegister phone numbers under a DIR.
List phone numbers attached to a DIRlistDirPhoneNumbersSimplifiedGETList the phone numbers registered under a DIR.
Remove phone numbers from a DIRdeleteDirPhoneNumbersSimplifiedDELETEDeregister phone numbers from a DIR.
Phone Number Batch2
Get a phone-number batchgetDirPhoneNumberBatchSimplifiedGETGet a single phone-number batch by id.
List phone-number batches for a DIRlistDirPhoneNumberBatchesSimplifiedGETList the phone-number batches submitted under a DIR.
Phone Number Block Order3
Create a number block orderCreateNumberBlockOrderPOSTCreates a phone number block order.
List number block ordersListNumberBlockOrdersGETGet a paginated list of number block orders.
Retrieve a number block orderRetrieveNumberBlockOrderGETGet an existing phone number block order.
Phone Number Blocks Background Job3
Deletes all numbers associated with a phone number blockCreatePhoneNumberBlockDeletionJobPOSTCreates a new background job to delete all the phone numbers associated with the given block.
Lists the phone number blocks jobsListPhoneNumberBlocksJobsGET
Retrieves a phone number blocks jobGetPhoneNumberBlocksJobGET
Phone Number Campaign5
Create New Phone Number CampaignCreatePhoneNumberCampaignPOST
Create New Phone Number CampaignPutPhoneNumberCampaignPUT
Delete Phone Number CampaignDeletePhoneNumberCampaignDELETEThis endpoint allows you to remove a campaign assignment from the supplied phoneNumber.
Get Single Phone Number CampaignGetSinglePhoneNumberCampaignGETRetrieve an individual phone number/campaign assignment by phoneNumber.
List phone number campaignsGetAllPhoneNumberCampaignsGET
Phone Number Configuration11
Change the bundle status for a phone number (set to being in aPhoneNumberBundleStatusChangePATCH
Delete a phone numberDeletePhoneNumberDELETE
Enable emergency for a phone numberEnablePhoneNumberEmergencyPOST
List phone numbersListPhoneNumbersGET
List phone numbers with voice settingsListPhoneNumbersWithVoiceSettingsGET
Retrieve a phone numberRetrievePhoneNumberGET
Retrieve a phone number with voice settingsGetPhoneNumberVoiceSettingsGET
Slim List phone numbersSlimListPhoneNumbersGETList phone numbers, This endpoint is a lighter version of the /phone numbers endpoint having higher performance and rate limit.
Update a phone numberUpdatePhoneNumberPATCH
Update a phone number with voice settingsUpdatePhoneNumberVoiceSettingsPATCH
Verify ownership of phone numbersVerifyPhoneNumberOwnershipPOSTVerifies 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 orderCancelSubNumberOrderPATCHAllows you to cancel a sub number order in 'pending' status.
Create a commentCreateCommentPOST
Create a number orderCreateNumberOrderPOSTCreates a phone number order.
Create a sub number orders reportCreateSubNumberOrdersReportPOSTCreate a CSV report for sub number orders.
Create a sub number orders reportCreateSubNumberOrdersReport_post_sub_number_orders_reportPOSTCreate a CSV report for sub number orders.
Download a sub number orders reportDownloadSubNumberOrdersReportGETDownload the CSV file for a completed sub number orders report.
Download a sub number orders reportDownloadSubNumberOrdersReport_get_sub_number_orders_report_report_id_downloadGETDownload the CSV file for a completed sub number orders report.
List number ordersListNumberOrdersGETGet a paginated list of number orders.
List sub number ordersListSubNumberOrdersGETGet a paginated list of sub number orders.
Mark a comment as readMarkCommentReadPATCH
Retrieve a commentRetrieveCommentGET
Retrieve a list of phone numbers associated to ordersRetrieveOrderPhoneNumbersGETGet a list of phone numbers associated to orders.
Retrieve a number orderRetrieveNumberOrderGETGet an existing phone number order.
Retrieve a single phone number within a number order.GetNumberOrderPhoneNumberGETGet an existing phone number in number order.
Retrieve a sub number orderGetSubNumberOrderGETGet an existing sub number order.
Retrieve a sub number orders reportGetSubNumberOrdersReportGETGet the status and details of a sub number orders report.
Retrieve a sub number orders reportGetSubNumberOrdersReport_get_sub_number_orders_report_report_idGETGet the status and details of a sub number orders report.
Retrieve all commentsListCommentsGET
Update a number orderUpdateNumberOrderPATCHUpdates a phone number order.
Update a sub number order's requirementsUpdateSubNumberOrderPATCHUpdates a sub number order.
Update requirements for a single phone number within a numberUpdateNumberOrderPhoneNumberPATCHUpdates requirements for a single phone number within a number order.
Phone Number Porting1
Run a portability checkPostPortabilityCheckPOSTRuns a portability check, returning the results immediately.
Phone Number Reservation4
Create a number reservationCreateNumberReservationPOSTCreates a Phone Number Reservation for multiple numbers.
Extend a number reservationExtendNumberReservationExpiryTimePOSTExtends reservation expiry time on all phone numbers.
List number reservationsListNumberReservationsGETGets a paginated list of phone number reservations.
Retrieve a number reservationRetrieveNumberReservationGETGets a single phone number reservation.
Phone Number Search2
List available phone number blocksListAvailablePhoneNumberBlocksGET
List available phone numbersListAvailablePhoneNumbersGET
Porting Order53
Activate every number in a porting order asynchronously.ActivatePortingOrderPOSTActivate each number in a porting order asynchronously.
Cancel a porting orderCancelPortingOrderPOSTCancel a porting order
Create a comment for a porting orderCreatePortingOrderCommentPOSTCreates a new comment for a porting order.
Create a list of additional documentsCreateAdditionalDocumentsPOSTCreates a list of additional documents for a porting order.
Create a list of phone number configurationsCreatePhoneNumberConfigurationsPOSTCreates a list of phone number configurations.
Create a LOA configurationCreateLoaConfigurationPOSTCreate a LOA configuration.
Create a phone number blockcreatePortingPhoneNumberBlockPOSTCreates a new phone number block.
Create a phone number extensioncreatePortingPhoneNumberExtensionPOSTCreates a new phone number extension.
Create a porting orderCreatePortingOrderPOSTCreates a new porting order object.
Create a porting related reportCreatePortingReportPOSTGenerate reports about porting operations.
Create an associated phone numbercreatePortingAssociatedPhoneNumberPOSTCreates a new associated phone number for a porting order.
Delete a LOA configurationDeleteLoaConfigurationDELETEDelete a specific LOA configuration.
Delete a phone number blockdeletePortingPhoneNumberBlockDELETEDeletes a phone number block.
Delete a phone number extensiondeletePortingPhoneNumberExtensionDELETEDeletes a phone number extension.
Delete a porting orderDeletePortingOrderDELETEDeletes an existing porting order.
Delete an additional documentDeleteAdditionalDocumentDELETEDeletes an additional document for a porting order.
Delete an associated phone numberdeletePortingAssociatedPhoneNumberDELETEDeletes an associated phone number from a porting order.
Download a porting order loa templateGetPortingOrderLoaTemplateGETDownload a porting order loa template
Edit a porting orderUpdatePortingOrderPATCHEdits the details of an existing porting order.
Initiate an action requirementinitiatePortingActionRequirementPOSTInitiates a specific action requirement for a porting order.
List action requirements for a porting orderlistPortingActionRequirementsGETReturns a list of action requirements for a specific porting order.
List additional documentsListAdditionalDocumentsGETReturns a list of additional documents for a porting order.
List all associated phone numberslistPortingAssociatedPhoneNumbersGETReturns a list of all associated phone numbers for a porting order.
List all comments of a porting orderListPortingOrderCommentsGETReturns a list of all comments of a porting order.
List all exception typesListExceptionTypesGETReturns a list of all possible exception types for a porting order.
List all phone number blockslistPortingPhoneNumberBlocksGETReturns a list of all phone number blocks of a porting order.
List all phone number configurationsListPhoneNumberConfigurationsGETReturns a list of phone number configurations paginated.
List all phone number extensionslistPortingPhoneNumberExtensionsGETReturns a list of all phone number extensions of a porting order.
List all porting activation jobsListPortingOrderActivationJobsGETReturns a list of your porting activation jobs.
List all porting eventslistPortingEventsGETReturns a list of all porting events.
List all porting ordersListPortingOrdersGETReturns a list of your porting order.
List all porting phone numbersListPortingPhoneNumbersGETReturns a list of your porting phone numbers.
List allowed FOC datesListAllowedFocWindowsGETReturns a list of allowed FOC dates for a porting order.
List available carriers in the UKlistPortingUKCarriersGETList available carriers in the UK.
List LOA configurationsListLoaConfigurationsGETList the LOA configurations.
List porting order requirementsListPortingOrderRequirementsGETReturns a list of all requirements based on country/number type for this porting order.
List porting related reportsListPortingReportsGETList the reports generated about porting operations.
List verification codesListVerificationCodesGETReturns a list of verification codes for a porting order.
Preview a LOA configurationPreviewLoaConfigurationGETPreview a specific LOA configuration.
Preview the LOA configuration parametersPreviewLoaConfigurationParamsPOSTPreview the LOA template that would be generated without need to create LOA configuration.
Republish a porting eventrepublishPortingEventPOSTRepublish a specific porting event.
Retrieve a LOA configurationGetLoaConfigurationGETRetrieve a specific LOA configuration.
Retrieve a porting activation jobGetPortingOrdersActivationJobGETReturns a porting activation job.
Retrieve a porting orderGetPortingOrderGETRetrieves the details of an existing porting order.
Retrieve a reportGetPortingReportGETRetrieve a specific report generated.
Retrieve the associated V1 sub_request_id and port_request_idGetPortingOrderSubRequestGETRetrieve the associated V1 sub request id and port request id
Send the verification codesSendPortingVerificationCodesPOSTSend the verification code for all porting phone numbers.
Share a porting orderSharePortingOrderPOSTCreates a sharing token for a porting order.
Show a porting eventshowPortingEventGETShow a specific porting event.
Submit a porting order.ConfirmPortingOrderPOSTConfirm and submit your porting order.
Update a LOA configurationUpdateLoaConfigurationPATCHUpdate a specific LOA configuration.
Update a porting activation jobUpdatePortingOrdersActivationJobPATCHUpdates the activation time of a porting activation job.
Verify the verification code for a list of phone numbersVerifyPortingVerificationCodesPOSTVerifies the verification code for a list of phone numbers.
Presigned Object URL1
Create Presigned Object URLCreatePresignedObjectUrlPOSTReturns a timed and authenticated URL to download (GET) or upload (PUT) an object.
Pricing2
Get product pricinggetProductPricingGETReturns pricing entries for a single product.
List productslistPricingProductsGETReturns the full product catalog with pagination.
Private Wireless Gateway4
Create a Private Wireless GatewayCreatePrivateWirelessGatewayPOSTAsynchronously create a Private Wireless Gateway for SIM cards for a previously created network.
Delete a Private Wireless GatewayDeleteWirelessGatewayDELETEDeletes the Private Wireless Gateway.
Get a Private Wireless GatewayGetPrivateWirelessGatewayGETRetrieve information about a Private Wireless Gateway.
Get all Private Wireless GatewaysGetPrivateWirelessGatewaysGETGet all Private Wireless Gateways belonging to the user.
Profile7
Create a messaging profileCreateMessagingProfilePOST
Delete a messaging profileDeleteMessagingProfileDELETE
List messaging profilesListMessagingProfilesGET
List phone numbers associated with a messaging profileListProfilePhoneNumbersGET
List short codes associated with a messaging profileListProfileShortCodesGET
Retrieve a messaging profileRetrieveMessagingProfileGET
Update a messaging profileUpdateMessagingProfilePATCH
Programmable Fax Application5
Creates a Fax ApplicationCreateFaxApplicationPOSTCreates a new Fax Application based on the parameters sent in the request.
Deletes a Fax ApplicationDeleteFaxApplicationDELETEPermanently deletes a Fax Application.
List all Fax ApplicationsListFaxApplicationsGETThis endpoint returns a list of your Fax Applications inside the 'data' attribute of the response.
Retrieve a Fax ApplicationGetFaxApplicationGETReturn the details of an existing Fax Application inside the 'data' attribute of the response.
Update a Fax ApplicationUpdateFaxApplicationPATCHUpdates settings of an existing Fax Application based on the parameters of the request.
Programmable Fax Command6
Cancel a faxCancelFaxPOSTCancel the outbound fax that is in one of the following states: queued, media.processed, originated or sending
Delete a faxDeleteFaxDELETE
Refresh a faxRefreshFaxPOSTRefreshes the inbound fax's media url when it has expired
Send a faxSendFaxPOSTSend a fax.
View a faxViewFaxGET
View a list of faxesListFaxesGET
Pronunciation Dictionary5
Create a pronunciation dictionaryCreatePronunciationDictPOSTCreate a new pronunciation dictionary for the authenticated organization.
Delete a pronunciation dictionaryDeletePronunciationDictDELETEPermanently delete a pronunciation dictionary.
Get a pronunciation dictionaryGetPronunciationDictGETRetrieve a single pronunciation dictionary by ID.
List pronunciation dictionariesListPronunciationDictsGETList all pronunciation dictionaries for the authenticated organization.
Update a pronunciation dictionaryUpdatePronunciationDictPATCHUpdate the name and/or items of an existing pronunciation dictionary.
Public Internet Gateway4
Create a Public Internet GatewayCreatePublicInternetGatewayPOSTCreate a new Public Internet Gateway.
Delete a Public Internet GatewayDeletePublicInternetGatewayDELETEDelete a Public Internet Gateway.
List all Public Internet GatewaysListPublicInternetGatewaysGETList all Public Internet Gateways.
Retrieve a Public Internet GatewayGetPublicInternetGatewayGETRetrieve a Public Internet Gateway.
Push Credential4
Creates a new mobile push credentialCreatePushCredentialPOSTCreates a new mobile push credential
Deletes a mobile push credentialDeletePushCredentialByIdDELETEDeletes a mobile push credential based on the given push credential id
List mobile push credentialsListPushCredentialsGETList mobile push credentials
Retrieves a mobile push credentialGetPushCredentialByIdGETRetrieves mobile push credential based on the given push credential id
Queue Command9
Create a queueCreateQueuePOSTCreate a new call queue.
Delete a queueDeleteQueueDELETEDelete an existing call queue.
Force remove a call from a queueRemoveQueueCallDELETERemoves an inactive call from a queue.
List queuesListQueuesGETList all queues for the authenticated user.
Retrieve a call from a queueRetrieveCallFromQueueGETRetrieve an existing call from an existing queue
Retrieve a call queueRetrieveCallQueueGETRetrieve an existing call queue
Retrieve calls from a queueListQueueCallsGETRetrieve the list of calls in an existing queue
Update a queueUpdateQueuePOSTUpdate properties of an existing call queue.
Update queued callUpdateCallInQueuePATCHUpdate queued call's keep after hangup flag
RCS9
Add RCS test numberInviteATestNumberToRCSPUTAdds a test phone number to an RCS agent for testing purposes.
Check RCS capabilitiesListRCSCapabilitiesOfAPhoneNumberGET
Check RCS capabilities (batch)ListRCSCapabilitiesOfAPhoneNumbersBatchPOST
Generate RCS deeplinkGenerateRCSDeeplinkGETGenerate a deeplink URL that can be used to start an RCS conversation with a specific agent.
Generate RCS deeplinkGenerateRCSDeeplink_get_messages_rcs_deeplinks_agent_idGETGenerate a deeplink URL that can be used to start an RCS conversation with a specific agent.
List all RCS agentsListRCSAgentsGET
Modify an RCS agentUpdateRCSAgentByIdPATCH
Retrieve an RCS agentGetRCSAgentByIdGET
Send an RCS messageSendRCSMessagePOST
Reference Data3
List standard call reasonslistCallReasonsGETTelnyx 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 typeslistDocumentTypesGETReference list of document type values accepted by DirCreateRequest.documents[].document type and the infringement-contest endpoint.
Validate a list of call reasonsvalidateCallReasonsPOSTCheck up to 10 candidate call reasons strings against Telnyx's vetting heuristics before sending them on a DIR create or update.
Region1
List all RegionsListRegionsGETList all regions and the interfaces that region supports
Regulatory Requirement3
Retrieve regulatory requirementsListRegulatoryRequirementsGET
Retrieve regulatory requirements for a list of phone numbersListRegulatoryRequirementsPhoneNumbersGET
Retrieve regulatory requirements for a list of phone numbersListRegulatoryRequirementsPhoneNumbers_get_phone_numbers_regulatory_requirementsGET
Report2
Create a ledger billing group reportCreateBillingGroupReportPOST
Get a ledger billing group reportGetBillingGroupReportGET
Reporting8
Create a Wireless Detail Records (WDRs) ReportCreateWdrReportPOSTAsynchronously 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_reportsPOSTAsynchronously 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) ReportDeleteWdrReportDELETEDeletes one specific WDR report.
Delete a Wireless Detail Record (WDR) ReportDeleteWdrReport_delete_wireless_detail_records_reports_idDELETEDeletes one specific WDR report.
Get a Wireless Detail Record (WDR) ReportGetWdrReportGETReturns one specific WDR report
Get a Wireless Detail Record (WDR) ReportGetWdrReport_get_wireless_detail_records_reports_idGETReturns one specific WDR report
Get all Wireless Detail Records (WDRs) ReportsGetWdrReportsGETReturns the WDR Reports that match the given parameters.
Get all Wireless Detail Records (WDRs) ReportsGetWdrReports_get_wireless_detail_records_reportsGETReturns the WDR Reports that match the given parameters.
Reputation17
Change the reputation refresh frequencyupdateReputationFrequencyPATCHUpdate how often Telnyx refreshes the reputation data for this enterprise's registered numbers.
Disable phone-number reputation for an enterprisedisableReputationSettingsDELETEDisable Phone Number Reputation.
Enable phone-number reputation for an enterpriseenableReputationSettingsPOSTActivate Phone Number Reputation for the given enterprise.
Force a reputation refreshrefreshReputationNumbersPOSTImmediately refresh the stored reputation data for the listed numbers.
Get a reputation remediation requestgetReputationRemediationGETRetrieve 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)getPhoneNumberReputationSimplifiedGETConvenience alias for GET /v2/enterprises/{enterprise id}/reputation/numbers/{phone number}.
Get a single reputation-monitored phone numbergetPhoneNumberReputationGETRetrieve one registered number with its latest reputation snapshot.
Get phone-number reputation settings for an enterprisegetReputationSettingsGETPhone 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 enterpriselistReputationRemediationsGETPaginated list of remediation requests for this enterprise.
List reputation-monitored phone numbers across all enterpriseslistReputationNumbersSimplifiedGETConvenience alias for GET /v2/enterprises/{enterprise id}/reputation/numbers that returns numbers across every enterprise you own.
List reputation-monitored phone numbers for an enterpriselistReputationNumbersGETPaginated list of phone numbers registered for reputation monitoring under this enterprise.
Register phone numbers for reputation monitoringassociateReputationNumbersPOSTAdd up to 100 phone numbers to reputation monitoring on this enterprise.
Remove a phone number from reputation monitoringdisassociateReputationNumberDELETEStop tracking the reputation of this phone number.
Remove a phone number from reputation monitoring (nodisassociateReputationNumberSimplifiedDELETEConvenience alias for DELETE /v2/enterprises/{enterprise id}/reputation/numbers/{phone number}.
Render a phone-number reputation Letter of AuthorizationgenerateReputationLoaPOSTRender the LOA for this enterprise as a PDF.
Replace the reputation Letter of Authorization documentreplaceReputationLoaPATCHPoint the enterprise's reputation settings at a new signed LOA document.
Submit phone numbers for reputation remediationsubmitReputationRemediationPOSTSubmit a batch of phone numbers belonging to this enterprise for reputation remediation.
Requirement4
Cancel a pending requirement versionCancelPendingRequirementVersionDELETECancel a pending requirement version.
List all requirementsListRequirementsGETList all requirements with filtering, sorting, and pagination
Retrieve a document requirementRetrieveDocumentRequirementsGETRetrieve a document requirement record
Schedule a future requirement versionCreateRequirementVersionPOSTCreate a new pending version of a requirement with a future effective start date.
Requirement Group8
Create a new requirement groupCreateRequirementGroupPOST
Delete a requirement group by IDDeleteRequirementGroupDELETE
Get a single requirement group by IDGetRequirementGroupGET
List requirement groupsGetRequirementGroupsGET
Submit a Requirement Group for ApprovalSubmitRequirementGroupPOST
Update requirement group for a phone number orderupdateNumberOrderPhoneNumberRequirementGroupPOST
Update requirement group for a sub number orderupdateSubNumberOrderRequirementGroupPOST
Update requirement values in requirement groupUpdateRequirementGroupPATCH
Requirement Type2
List all requirement typesListRequirementTypesGETList all requirement types ordered by created at descending
Retrieve a requirement typesRetrieveRequirementTypeGETRetrieve a requirement type by id
Room6
Create a room.CreateRoomPOSTSynchronously create a Room.
Delete a room.DeleteRoomDELETESynchronously delete a Room.
Update a room.UpdateRoomPATCHSynchronously update a Room.
View a list of room sessions.RetrieveListRoomSessionsGET
View a list of rooms.ListRoomsGET
View a room.ViewRoomGET
Room Composition4
Create a room composition.CreateRoomCompositionPOSTAsynchronously create a room composition.
Delete a room composition.DeleteRoomCompositionDELETESynchronously delete a room composition.
View a list of room compositions.ListRoomCompositionsGET
View a room composition.ViewRoomCompositionGET
Room Participant2
View a list of room participants.ListRoomParticipantsGET
View a room participant.ViewRoomParticipantGET
Room Recording4
Delete a room recording.DeleteRoomRecordingDELETESynchronously delete a Room Recording.
Delete several room recordings in a bulk.DeleteRoomRecordingsDELETE
View a list of room recordings.ListRoomRecordingsGET
View a room recording.ViewRoomRecordingGET
Room Session7
End a room session.EndSessionPOSTNote: this will also kick all participants currently present in the room
Kick participants from a room session.KickParticipantInSessionPOST
Mute participants in room session.MuteParticipantInSessionPOST
Unmute participants in room session.UnmuteParticipantInSessionPOST
View a list of room participants.RetrieveListRoomParticipantsGET
View a list of room sessions.ListRoomSessionsGET
View a room session.ViewRoomSessionGET
Rooms Client Token2
Create Client Token to join a room.CreateRoomClientTokenPOSTSynchronously create an Client Token to join a Room.
Refresh Client Token to join a room.RefreshRoomClientTokenPOSTSynchronously refresh an Client Token to join a Room.
Session Analysis3
Get metadata overviewGetSessionAnalysisMetadataGETReturns all available record types and supported query parameters for session analysis.
Get record type metadataGetSessionAnalysisRecordTypeMetadataGETReturns detailed metadata for a specific record type, including relationships and examples.
Get session analysisGetSessionAnalysisGETRetrieves a full session analysis tree for a given event, including costs, child events, and product linkages.
SETI Observability1
Retrieve Black Box Test ResultsGetBlackBoxTestResultsGETReturns the results of the various black box tests
Shared Campaign5
Get Sharing StatusGetPartnerCampaignSharingStatusGET
Get Single Shared CampaignGetSharedCampaignGETRetrieve campaign details by campaignId.
List Shared CampaignsGetSharedCampaignsGETRetrieve all partner campaigns you have shared to Telnyx in a paginated fashion.
List shared partner campaignsGetPartnerCampaignsSharedByUserGETGet all partner campaigns you have shared to Telnyx in a paginated fashion
Update Single Shared CampaignUpdateSharedCampaignPATCHUpdate campaign details by campaignId.
Short Code3
List short codesListShortCodesGET
Retrieve a short codeRetrieveShortCodeGET
Update short codeUpdateShortCodePATCHUpdate the settings for a specific short code.
SIM Card24
Create a new SIM card data usage notificationPostSimCardDataUsageNotificationPOSTCreates a new SIM card data usage notification.
Delete SIM card data usage notificationsDeleteSimCardDataUsageNotificationsDELETEDelete the SIM Card Data Usage Notification.
Deletes a SIM cardDeleteSimCardDELETEThe SIM card will be decommissioned, removed from your account and you will stop being charged.
Get a single SIM card data usage notificationGetSimCardDataUsageNotificationGETGet a single SIM Card Data Usage Notification.
Get activation code for an eSIMGetSimCardActivationCodeGETIt returns the activation code for an eSIM.
Get all SIM cardsGetSimCardsGETGet all SIM cards belonging to the user that match the given filters.
Get SIM cardGetSimCardGETReturns the details regarding a specific SIM card.
Get SIM card device detailsGetSimCardDeviceDetailsGETIt returns the device details where a SIM card is currently being used.
Get SIM card public IP definitionGetSimCardPublicIpGETIt returns the public IP requested for a SIM card.
List SIM card data usage notificationsListDataUsageNotificationsGETLists a paginated collection of SIM card data usage notifications.
List wireless connectivity logsGetWirelessConnectivityLogsGETThis API allows listing a paginated collection of Wireless Connectivity Logs associated with a SIM Card, for troubleshooting purposes.
Purchase eSIMsPurchaseESimPOSTPurchases and registers the specified amount of eSIMs to the current user's account.
Register SIM cardsRegisterSimCardsPOSTRegister the SIM cards associated with the provided registration codes to the current user's account.
Request a SIM card disableDisableSimCardPOSTThis API disables a SIM card, disconnecting it from the network and making it impossible to consume data.
Request a SIM card enableEnableSimCardPOSTThis API enables a SIM card, connecting it to the network and making it possible to consume data.
Request bulk disabling voice on SIM cards.DisableVoiceBulkPOSTThis 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.EnableVoiceBulkPOSTThis 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.SetPublicIPsBulkPOSTThis API triggers an asynchronous operation to set a public IP for each of the specified SIM cards.
Request removing a SIM card public IPRemoveSimCardPublicIpPOSTThis API removes an existing public IP from a SIM card.
Request setting a SIM card public IPSetSimCardPublicIpPOSTThis 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 standbySetSimCardStandbyPOSTThe 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 cardUpdateSimCardPATCHUpdates SIM card data
Updates information for a SIM Card Data Usage NotificationPatchSimCardDataUsageNotificationPATCHUpdates information for a SIM Card Data Usage Notification.
Validate SIM cards registration codesValidateRegistrationCodesPOSTIt validates whether SIM card registration codes are valid or not.
SIM Card Action4
Get bulk SIM card action detailsGetBulkSimCardActionGETThis API fetches information about a bulk SIM card action.
Get SIM card action detailsGetSimCardActionGETThis API fetches detailed information about a SIM card action to follow-up on an existing asynchronous operation.
List bulk SIM card actionsListBulkSimCardActionsGETThis API lists a paginated collection of bulk SIM card actions.
List SIM card actionsListSimCardActionsGETThis API lists a paginated collection of SIM card actions.
SIM Card Group9
Create a SIM card groupCreateSimCardGroupPOSTCreates a new SIM card group object
Delete a SIM card groupDeleteSimCardGroupDELETEPermanently deletes a SIM card group
Get all SIM card groupsGetAllSimCardGroupsGETGet all SIM card groups belonging to the user that match the given filters.
Get SIM card groupGetSimCardGroupGETReturns the details regarding a specific SIM card group
Request Private Wireless Gateway assignment for SIM card groupSetPrivateWirelessGatewayForSimCardGroupPOSTThis action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group.
Request Private Wireless Gateway removal from SIM card groupRemoveSimCardGroupPrivateWirelessGatewayPOSTThis action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group.
Request Wireless Blocklist assignment for SIM card groupSetWirelessBlocklistForSimCardGroupPOSTThis action will asynchronously assign a Wireless Blocklist to all the SIMs in the SIM card group.
Request Wireless Blocklist removal from SIM card groupRemoveWirelessBlocklistForSimCardGroupPOSTThis action will asynchronously remove an existing Wireless Blocklist to all the SIMs in the SIM card group.
Update a SIM card groupUpdateSimCardGroupPATCHUpdates a SIM card group
SIM Card Group Action2
Get SIM card group action detailsGetSimCardGroupActionGETThis 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 actionsGetSimCardGroupActionsGETThis API allows listing a paginated collection a SIM card group actions.
SIM Card Order4
Create a SIM card orderCreateSimCardOrderPOSTCreates a new order for SIM cards.
Get a single SIM card orderGetSimCardOrderGETGet a single SIM card order by its ID.
Get all SIM card ordersGetSimCardOrdersGETGet all SIM card orders according to filters.
Preview SIM card ordersPreviewSimCardOrdersPOSTPreview SIM card order purchases.
SIPREC Connector4
Create a SIPREC connectorcreateSiprecConnectorPOSTCreates a new SIPREC connector configuration.
Delete a SIPREC connectordeleteSiprecConnectorDELETEDeletes a stored SIPREC connector.
Retrieve a SIPREC connectorgetSiprecConnectorGETReturns details of a stored SIPREC connector.
Update a SIPREC connectorupdateSiprecConnectorPUTUpdates a stored SIPREC connector configuration.
Speech To Text Batch Report8
Create a new Speech to Text batch report requestsubmitSttRequestPOSTCreates 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_textPOSTCreates a new Speech to Text batch report request with the specified filters
Delete a Speech to Text batch report requestdeleteSttRequestDELETEDeletes 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_idDELETEDeletes a specific Speech to Text batch report request by ID
Get a specific Speech to Text batch report requestgetSttRequestGETRetrieves 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_idGETRetrieves a specific Speech to Text batch report request by ID
Get all Speech to Text batch report requestsgetSttRequestsGETRetrieves 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_textGETRetrieves all Speech to Text batch report requests for the authenticated user
Speech To Text Capability1
List supported STT providerslistSttProvidersGETRetrieve 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 reportgetSttUsageReportSyncGETGenerate and fetch speech to text usage report synchronously.
Get speech to text usage reportgetSttUsageReportSync_get_legacy_reporting_usage_reports_speech_to_textGETGenerate and fetch speech to text usage report synchronously.
Stored Payment Transaction1
Create a stored payment transactioncreateStoredPaymentTransactionPOST
Telco Data Usage Report8
Delete telco data usage reportdeleteTelcoDataUsageReportDELETEDelete a specific telco data usage report by its ID
Delete telco data usage reportdeleteTelcoDataUsageReport_delete_legacy_reporting_usage_reports_number_lookup_idDELETEDelete a specific telco data usage report by its ID
Get telco data usage report by IDgetTelcoDataUsageReportGETRetrieve a specific telco data usage report by its ID
Get telco data usage report by IDgetTelcoDataUsageReport_get_legacy_reporting_usage_reports_number_lookup_idGETRetrieve a specific telco data usage report by its ID
List telco data usage reportsgetTelcoDataUsageReportsGETRetrieve a paginated list of telco data usage reports
List telco data usage reportsgetTelcoDataUsageReports_get_legacy_reporting_usage_reports_number_lookupGETRetrieve a paginated list of telco data usage reports
Submit telco data usage reportsubmitTelcoDataUsageReportPOSTSubmit a new telco data usage report
Submit telco data usage reportsubmitTelcoDataUsageReport_post_legacy_reporting_usage_reports_number_lookupPOSTSubmit a new telco data usage report
Terms Of Service6
Agree to the Branded Calling Terms of ServiceagreeToBrandedCallingTosPOSTRecords the authenticated user's agreement to the current Branded Calling ToS.
Agree to the Phone Number Reputation Terms of ServiceagreeNumberReputationTermsOfServicePOSTRecords the authenticated user's agreement to the current Phone Number Reputation ToS.
Get a Terms of Service agreement by idgetTermsOfServiceAgreementGETRetrieve a single ToS agreement record.
Get Terms of Service informationgetTermsOfServiceInfoGETReturns the available Terms of Service agreements (product, current version, terms URL, effective date).
Get the calling user's Terms of Service statusgetTermsOfServiceStatusGETReturns 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 agreementslistTermsOfServiceAgreementsGETReturns the Terms of Service agreements the authenticated user has on file.
TeXML Application5
Creates a TeXML ApplicationCreateTexmlApplicationPOSTCreates a TeXML Application.
Deletes a TeXML ApplicationDeleteTexmlApplicationDELETEDeletes a TeXML Application.
List all TeXML ApplicationsFindTexmlApplicationsGETReturns a list of your TeXML Applications.
Retrieve a TeXML ApplicationGetTexmlApplicationGETRetrieves the details of an existing TeXML Application.
Update a TeXML ApplicationUpdateTexmlApplicationPATCHUpdates settings of an existing TeXML Application.
TeXML REST Command34
Create a new queueCreateTexmlQueuePOSTCreates a new queue resource.
Create a TeXML secretCreateTexmlSecretPOSTCreate a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML.
Delete a conference participantDeleteTexmlConferenceParticipantDELETEDeletes a conference participant
Delete a queue resourceDeleteTexmlQueueDELETEDelete a queue resource.
Delete a recording transcriptionDeleteTeXMLRecordingTranscriptionDELETEPermanently deletes a recording transcription.
Delete recording resourceDeleteTeXMLCallRecordingDELETEDeletes recording resource identified by recording id.
Dial a new conference participantDialTexmlConferenceParticipantPOSTDials a new conference participant
Fetch a callGetTexmlCallGETReturns an individual call identified by its CallSid.
Fetch a conference resourceGetTexmlConferenceGETReturns a conference resource.
Fetch a queue resourceGetTexmlQueueGETReturns a queue resource.
Fetch a recording transcription resourceGetTeXMLRecordingTranscriptionGETReturns the recording transcription resource identified by its ID.
Fetch multiple call resourcesGetTexmlCallsGETReturns multiple call resouces for an account.
Fetch multiple recording resourcesGetTeXMLCallRecordingsGETReturns multiple recording resources for an account.
Fetch recording resourceGetTeXMLCallRecordingGETReturns recording resource identified by recording id.
Fetch recordings for a callFetchTeXMLCallRecordingsGETReturns recordings for a call identified by call sid.
Fetch recordings for a conferenceFetchTeXMLConferenceRecordingsGETReturns recordings for a conference identified by conference sid.
Get conference participant resourceGetTexmlConferenceParticipantGETGets conference participant resource
Initiate an outbound AI callInitiateTexmlAICallPOSTInitiate an outbound AI call with warm-up support.
Initiate an outbound callInitiateTexmlCallPOSTInitiate an outbound TeXML call.
List conference participantsGetTexmlConferenceParticipantsGETLists conference participants
List conference recordingsGetTexmlConferenceRecordingsGETLists conference recordings
List conference resourcesGetTexmlConferencesGETLists conference resources.
List queue resourcesGetTexmlQueuesGETLists queue resources.
List recording transcriptionsGetTeXMLRecordingTranscriptionsGETReturns multiple recording transcription resources for an account.
Request recording for a callStartTeXMLCallRecordingPOSTStarts recording with specified parameters for call idientified by call sid.
Request siprec session for a callStartTeXMLSiprecSessionPOSTStarts siprec session with specified parameters for call idientified by call sid.
Start streaming media from a call.StartTeXMLCallStreamingPOSTStarts streaming media from a call to a specific WebSocket address.
Update a conference participantUpdateTexmlConferenceParticipantPOSTUpdates a conference participant
Update a conference resourceUpdateTexmlConferencePOSTUpdates a conference resource.
Update a queue resourceUpdateTexmlQueuePOSTUpdates a queue resource.
Update callUpdateTexmlCallPOSTUpdate TeXML call.
Update recording on a callUpdateTeXMLCallRecordingPOSTUpdates recording resource for particular call.
Update streaming on a callUpdateTeXMLCallStreamingPOSTUpdates streaming resource for particular call.
Updates siprec session for a callUpdateTeXMLSiprecSessionPOSTUpdates siprec session identified by siprec sid.
Text To Speech Command3
Generate speech from textgenerateSpeechPOSTGenerate synthesized speech audio from text input.
List available voiceslistVoicesGETRetrieve a list of available voices from one or all TTS providers.
Stream text to speech over WebSocketTextToSpeechOverWsGETOpen a WebSocket connection to stream text and receive synthesized audio in real time.
Traffic Policy Profile12
Create a traffic policy profileCreateTrafficPolicyProfilePOSTCreate a new traffic policy profile.
Create a traffic policy profileCreateTrafficPolicyProfile_post_traffic_policy_profilesPOSTCreate a new traffic policy profile.
Delete a traffic policy profileDeleteTrafficPolicyProfileDELETEDeletes the traffic policy profile.
Delete a traffic policy profileDeleteTrafficPolicyProfile_delete_traffic_policy_profiles_idDELETEDeletes the traffic policy profile.
Get a traffic policy profileGetTrafficPolicyProfileGETReturns the details regarding a specific traffic policy profile.
Get a traffic policy profileGetTrafficPolicyProfile_get_traffic_policy_profiles_idGETReturns the details regarding a specific traffic policy profile.
Get all available traffic policy profile servicesGetTrafficPolicyProfileServicesGETGet all available PCEF services that can be used in traffic policy profiles.
Get all available traffic policy profile servicesGetTrafficPolicyProfileServices_get_traffic_policy_profiles_servicesGETGet all available PCEF services that can be used in traffic policy profiles.
Get all traffic policy profilesGetTrafficPolicyProfilesGETGet all traffic policy profiles belonging to the user that match the given filters.
Get all traffic policy profilesGetTrafficPolicyProfiles_get_traffic_policy_profilesGETGet all traffic policy profiles belonging to the user that match the given filters.
Update a traffic policy profileUpdateTrafficPolicyProfilePATCHUpdates a traffic policy profile.
Update a traffic policy profileUpdateTrafficPolicyProfile_patch_traffic_policy_profiles_idPATCHUpdates a traffic policy profile.
UAC Connection7
Check a UAC Connection Registration StatusCheckUacConnectionRegistrationStatusPOSTChecks 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 connectionCreateUacConnectionPOSTCreates a UAC connection.
Delete a UAC connectionDeleteUacConnectionDELETEDeletes an existing UAC connection.
List UAC connectionsListUacConnectionsGETReturns a list of your UAC connections.
Retrieve a UAC connectionRetrieveUacConnectionGETRetrieves the details of an existing UAC connection.
SIP Registration StatusGetSipRegistrationStatusGETReturns 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 connectionUpdateUacConnectionPATCHUpdates settings of an existing UAC connection.
Usage Reports (BETA)2
Get Telnyx product usage data (BETA)GetUsageReportsGETGet Telnyx usage data by product, broken out by the specified dimensions
Get Usage Reports query options (BETA)ListUsageReportsOptionsGETGet the Usage Reports options for querying usage, including the products available and their respective metrics and dimensions
User Bundle6
Create User BundlesCreateUserBundlesBulkPOSTCreates multiple user bundles for the user.
Deactivate User BundleDeactivateUserBundleDELETEDeactivates a user bundle by its ID.
Get Unused User BundlesGetUnusedUserBundlesGETReturns all user bundles that aren't in use.
Get User Bundle by IdGetUserBundleByIdGETRetrieves a user bundle by its ID.
Get User Bundle ResourcesGetUserBundleResourcesGETRetrieves the resources of a user bundle by its ID.
Get User BundlesGetUserBundlesGETGet a paginated list of user bundles.
User Tag1
List User TagsGetUserTagsGETList all user tags.
UserAddress6
Creates a user addressCreateUserAddressPOSTCreates a user address.
Creates a user addressCreateUserAddress_post_user_addressesPOSTCreates a user address.
List all user addressesFindUserAddressGETReturns a list of your user addresses.
List all user addressesFindUserAddress_get_user_addressesGETReturns a list of your user addresses.
Retrieve a user addressGetUserAddressGETRetrieves the details of an existing user address.
Retrieve a user addressGetUserAddress_get_user_addresses_idGETRetrieves the details of an existing user address.
Verification Request7
Delete Verification RequestDeleteVerificationRequestDELETEDelete a verification request
Get Verification RequestGetVerificationRequestGETGet a single verification request by its ID.
Get Verification Request Status HistoryGetVerificationStatusHistoryGETGet the history of status changes for a verification request.
Get Verification Request Status HistoryGetVerificationStatusHistory_get_messaging_tollfree_verification_requests_id_status_historyGETGet the history of status changes for a verification request.
List Verification RequestsListVerificationRequestsGETGet a list of previously-submitted tollfree verification requests
Submit Verification RequestSubmitVerificationRequestPOSTSubmit a new tollfree verification request
Update Verification RequestUpdateVerificationRequestPATCHUpdate an existing tollfree verification request.
Verified Number5
Delete a verified numberDeleteVerifiedNumberDELETE
List all Verified NumbersListVerifiedNumbersGETGets a paginated list of Verified Numbers.
Request phone number verificationCreateVerifiedNumberPOSTInitiates phone number verification procedure.
Retrieve a verified numberGetVerifiedNumberGET
Submit verification codeVerifyVerificationCodePOST
Verify16
Create a Verify profileCreateVerifyProfilePOSTCreates a new Verify profile to associate verifications with.
Create message templateCreateMessageTemplatePOSTCreate a new Verify profile message template.
Delete Verify profileDeleteProfileDELETE
List all Verify profilesListProfilesGETGets a paginated list of Verify profiles.
List verifications by phone numberListVerificationsGET
Retrieve verificationRetrieveVerificationGET
Retrieve Verify profileGetVerifyProfileGETGets a single Verify profile.
Retrieve Verify profile message templatesListProfileMessageTemplatesGETList all Verify profile message templates.
Trigger Call verificationCreateVerificationCallPOST
Trigger Flash call verificationCreateFlashcallVerificationPOST
Trigger SMS verificationCreateVerificationSmsPOST
Trigger WhatsApp verificationCreateWhatsappVerificationPOST
Update message templateUpdateMessageTemplatePATCHUpdate an existing Verify profile message template.
Update Verify profileUpdateVerifyProfilePATCH
Verify verification code by IDVerifyVerificationCodeByIdPOST
Verify verification code by phone numberVerifyVerificationCodeByPhoneNumberPOST
Virtual Cross Connect7
Create a Virtual Cross ConnectCreateVirtualCrossConnectPOSTCreate a new Virtual Cross Connect.
Delete a Virtual Cross ConnectDeleteVirtualCrossConnectDELETEDelete a Virtual Cross Connect.
List all Virtual Cross ConnectsListVirtualCrossConnectsGETList all Virtual Cross Connects.
List Virtual Cross Connect Cloud CoverageListVirtualCrossConnectCoverageGETList Virtual Cross Connects Cloud Coverage.
List Virtual Cross Connect Cloud CoverageListVirtualCrossConnectCoverage_get_virtual_cross_connects_coverageGETList Virtual Cross Connects Cloud Coverage.
Retrieve a Virtual Cross ConnectGetVirtualCrossConnectGETRetrieve a Virtual Cross Connect.
Update the Virtual Cross ConnectUpdateVirtualCrossConnectPATCHUpdate the Virtual Cross Connect.
Voice Channel6
List All Numbers using Channel BillingGetAllNumbersChannelZonesGETRetrieve a list of all phone numbers using Channel Billing, grouped by Zone.
List Numbers using Channel Billing for a specific ZoneGetNumbersChannelZonesGETRetrieve a list of phone numbers using Channel Billing for a specific Zone.
List your voice channels for non-US zonesGetChannelZonesGETReturns the non-US voice channels for your account.
List your voice channels for US ZoneListInboundChannelsGETReturns the US Zone voice channels for your account.
Update voice channels for non-US ZonesPatchChannelZonePUTUpdate the number of Voice Channels for the Non-US Zones.
Update voice channels for US ZoneUpdateOutboundChannelsPATCHUpdate the number of Voice Channels for the US Zone.
Voice Clone6
Create a voice clone from a voice designcreateVoiceClonePOSTCreates a new voice clone by capturing the voice identity of an existing voice design.
Create a voice clone from an audio file uploadcreateVoiceCloneFromUploadPOSTCreates a new voice clone by uploading an audio file directly.
Delete a voice clonedeleteVoiceCloneDELETEPermanently deletes a voice clone.
Download voice clone audio samplegetVoiceCloneSampleGETDownloads the WAV audio sample that was used to create the voice clone.
List voice cloneslistVoiceClonesGETReturns a paginated list of voice clones belonging to the authenticated account.
Update a voice cloneupdateVoiceClonePATCHUpdates the name, language, or gender of a voice clone.
Voice Design7
Create or add a version to a voice designcreateVoiceDesignPOSTCreates a new voice design (version 1) when voice design id is omitted.
Delete a specific version of a voice designdeleteVoiceDesignVersionDELETEPermanently deletes a specific version of a voice design.
Delete a voice designdeleteVoiceDesignDELETEPermanently deletes a voice design and all of its versions.
Download voice design audio samplegetVoiceDesignSampleGETDownloads the WAV audio sample for the voice design.
Get a voice designgetVoiceDesignGETReturns the latest version of a voice design, or a specific version when ?version=N is provided.
List voice designslistVoiceDesignsGETReturns a paginated list of voice designs belonging to the authenticated account.
Rename a voice designupdateVoiceDesignPATCHUpdates the name of a voice design.
Voice SDK Stat2
List Voice SDK call reportsListVoiceSdkCallReportsGETReturns paginated raw call report stats JSON payloads stored for the authenticated user.
Retrieve Voice SDK call reports by call IDGetVoiceSdkCallReportGETReturns raw call report stats JSON payloads stored for the authenticated user and call id.
Voicemail3
Create voicemailCreateVoicemailPOSTCreate voicemail settings for a phone number
Get voicemailGetVoicemailGETReturns the voicemail settings for a phone number
Update voicemailUpdateVoicemailPATCHUpdate voicemail settings for a phone number
WDR Detail Report1
Fetches all Wdr recordsGetPaginatedWdrsGETFetch all Wdr records
Webhook2
Find webhook_delivery details by IDGetWebhookDeliveryGETProvides webhook delivery debug data, such as timestamps, delivery status and attempts.
List webhook deliveriesGetWebhookDeliveriesGETLists webhook deliveries for the authenticated user
Whatsapp Business Account8
Delete a Whatsapp Business AccountdeleteWabaDELETE
Fetch Whatsapp user dataGetWhatsappUserDataGET
Get a single Whatsapp Business AccountGetSingleWabaGET
Get WABA settingsGetWabaSettingsGET
List phone numbers for a WABAListWabaPhonesGET
List Whatsapp Business AccountsListWabasGET
Update WABA settingsPatchWabaSettingsPATCH
Update Whatsapp user dataPatchWhatsappUserDataPATCH
Whatsapp Message Template8
Create a Whatsapp message templatePostWhatsappTemplatePOST
Delete a Whatsapp message templateDeleteWhatsappTemplateDELETE
Delete a Whatsapp message templateDeleteWhatsappTemplate_delete_whatsapp_message_templates_idDELETE
Get a Whatsapp message template by IDGetWhatsappTemplateGET
Get a Whatsapp message template by IDGetWhatsappTemplate_get_whatsapp_message_templates_idGET
List Whatsapp message templatesListWhatsappTemplatesGET
Update a Whatsapp message templatePatchWhatsappTemplatePATCH
Update a Whatsapp message templatePatchWhatsappTemplate_patch_whatsapp_message_templates_idPATCH
Whatsapp Messaging1
Send a Whatsapp messageSendWhatsappMessagePOST
Whatsapp Phone Number15
Delete a Whatsapp phone numberDeleteWhatsappPhoneNumberDELETE
Delete Whatsapp profile photoDeleteWhatsappProfilePhotoDELETE
Enable or disable Whatsapp calling for a phone numberPatchWhatsappCallingSettingsPATCH
Get calling settings for a phone numberGetWhatsappCallingSettingsGET
Get conversation window status for a phone numberGetWhatsappConversationWindowGETReturns whether the 24-hour conversation window is currently open for a given source/destination pair.
Get phone number business profileGetWhatsappProfileGET
Get phone number conversational componentsGetWhatsappConversationalComponentsGET
Get Whatsapp profile photoGetWhatsappProfilePhotoGET
Initialize Whatsapp phone number verificationInitializeWhatsappVerificationPOST
List Whatsapp phone numbersListPhoneNumbers_GET
Resend verification codeResendWhatsappVerificationPOST
Submit verification code for a phone numberVerifyWhatsappPhoneNumberPOST
Update phone number business profilePatchWhatsappProfilePATCH
Update phone number conversational componentsPatchWhatsappConversationalComponentsPATCH
Upload Whatsapp profile photoPostWhatsappProfilePhotoPOST
WireGuard Interface10
Create a WireGuard InterfaceCreateWireguardInterfacePOSTCreate a new WireGuard Interface.
Create a WireGuard PeerCreateWireguardPeerPOSTCreate a new WireGuard Peer.
Delete a WireGuard InterfaceDeleteWireguardInterfaceDELETEDelete a WireGuard Interface.
Delete the WireGuard PeerDeleteWireguardPeerDELETEDelete the WireGuard peer.
List all WireGuard InterfacesListWireguardInterfacesGETList all WireGuard Interfaces.
List all WireGuard PeersListWireguardPeersGETList all WireGuard peers.
Retrieve a WireGuard InterfacesGetWireguardInterfaceGETRetrieve a WireGuard Interfaces.
Retrieve the WireGuard PeerGetWireguardPeerGETRetrieve the WireGuard peer.
Retrieve Wireguard config template for PeerGetWireguardPeerConfigGETRetrieve Wireguard config template for Peer
Update the WireGuard PeerUpdateWireguardPeerPATCHUpdate the WireGuard peer.
Wireless Blocklist6
Create a Wireless BlocklistCreateWirelessBlocklistPOSTCreate a Wireless Blocklist to prevent SIMs from connecting to certain networks.
Delete a Wireless BlocklistDeleteWirelessBlocklistDELETEDeletes the Wireless Blocklist.
Get a Wireless BlocklistGetWirelessBlocklistGETRetrieve information about a Wireless Blocklist.
Get all possible wireless blocklist valuesWirelessBlocklistsGetAllGETRetrieve all wireless blocklist values for a given blocklist type.
Get all Wireless BlocklistsGetWirelessBlocklistsGatewaysGETGet all Wireless Blocklists belonging to the user.
Update a Wireless BlocklistUpdateWirelessBlocklistPATCHUpdate a Wireless Blocklist.
Wireless Region1
Get all wireless regionsWirelessRegionsGetAllGETRetrieve all wireless regions for the given product.
X402 Payment Transaction2
Create a payment quotecreateX402QuotePOSTCreates a payment quote for the specified USD amount.
Settle a paymentsettleX402PaymentPOSTSettles an x402 payment using the quote ID and a signed payment authorization.