Telnyx API

OpenAPI apis-guru telecom

SIP trunking, SMS, MMS, Call Control and Telephony Data Services.

Homepage: https://api.apis.guru/v2/specs/telnyx.com/2.0.0.json
Provider: telnyx.com
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/telnyx.com/2.0.0/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/telnyx.com/2.0.0/openapi.yaml

Tools (363)

Extracted live via the executor SDK.

accessTokens.createTelephonyCredentialToken

Create an Access Token (JWT) for the credential.
addresses.createAddress

Creates an address.
addresses.deleteAddress

Deletes an existing address.
addresses.findAddresss

Returns a list of your addresses.
addresses.getAddress

Retrieves the details of an existing address.
addresses.validateAddress

Validates an address for emergency services.
authenticationProviders.createAuthenticationProvider

Creates an authentication provider.
authenticationProviders.deleteAuthenticationProvider

Deletes an existing authentication provider.
authenticationProviders.findAuthenticationProviders

Returns a list of your SSO authentication providers.
authenticationProviders.getAuthenticationProvider

Retrieves the details of an existing authentication provider.
authenticationProviders.updateAuthenticationProvider

Updates settings of an existing authentication provider.
billing.getUserBalance

Retrieve user balance details
billingGroups.createBillingGroup

Create a billing group
billingGroups.deleteBillingGroup

Delete a billing group
billingGroups.listBillingGroups

List all billing groups
billingGroups.retrieveBillingGroup

Retrieve a billing group
billingGroups.updateBillingGroup

Update a billing group
bulkCredentials.bulkCredentialAction

Perform activate or deactivate action on all credentials filtered by the provided tag. Activate action will change the status to active, making it possible to connect calls with the credential. Deactivate action will change the status to inactive, making it impossible to connect calls with the credential.
bulkCredentials.createBulkTelephonyCredential

Creates several credentials in bulk.
bulkCredentials.deleteBulkTelephonyCredential

Delete several credentials in bulk.
bulkCredentials.updateBulkTelephonyCredential

Update several credentials in bulk.
callCommands.callAnswer
Answer an incoming call. You must issue this command before executing subsequent commands on an incoming call.
Expected Webhooks:
- call.answered
callCommands.callBridge
Bridge two call control calls.
Expected Webhooks:
- call.bridged for Leg A
- call.bridged for Leg B
callCommands.callDial
Dial a number or SIP URI from a given connection. A successful response will include a call_leg_id which can be used to correlate the command with subsequent webhooks.
Expected Webhooks:
- call.initiated
- call.answered or call.hangup
- call.machine.detection.ended if answering_machine_detection was requested
- call.machine.greeting.ended if answering_machine_detection was set to detect_beep, greeting_end or detect_words
callCommands.callEnqueue

Put the call in a queue.

callCommands.callForkStart

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

Expected Webhooks:

call.fork.started
call.fork.stopped

Simple Telnyx RTP Encapsulation Protocol (STREP)

Note: This header/encapsulation is not used when the rx and tx parameters have been specified; it only applies when media is forked using the target attribute.

If the destination for forked media is specified using the "target" attribute, the RTP will be encapsulated in an extra Telnyx protocol, which adds a 24 byte header to the RTP payload in each packet. The STREP header includes the Call Control call_leg_id for stream identification, along with bits that represent the direction (inbound or outbound) of the media. This 24-byte header sits between the UDP header and the RTP header.

The STREP header makes it possible to fork RTP for multiple calls (or two RTP streams for the same call) to the same IP:port, where the streams can be demultiplexed by your application using the information in the header. Of course, it's still possible to ignore this header completely, for example, if sending forked media for different calls to different ports or IP addresses. In this case, simply strip 24 bytes (or use the second byte to find the header length) from the received UDP payload to get the RTP (RTP header and payload).

STREP Specification
  0                   1                   2                   3  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |1 1|Version|L|D|    HeaderLen  |  reserved (2 bytes)           | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |       reserved (4 bytes, for UDP ports or anything else)      | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |               The call_leg_id                                 | |                   from Call Control                           | |                       (128 bits / 16 bytes)                   | |                           (this is binary data)               | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 11   Static bits 11, always set to 11 to easily distinguish forked media   from RTP (10) and T.38 media (usually 00) and SIP (which begins   with a capital letter, so begins with bits 01). This is a magic number.
 Version   Four bits to indicate the version number of the protocol, starting at 0001.
 L   One bit to represent the leg of the call (A or B).   0 represents the A (first) leg of the call.   1 represents the B (second) leg of the call.
 D   One bit to represent the direction of this RTP stream.   0 represents media received by Telnyx.   1 represents media transmitted by Telnyx.
 HeaderLen (1 byte)   The length of the header in bytes.   Note that this value does not include the length of the payload. The total   size of the RTP can be calculated by subtracting the HeaderLen from the UDP   length (minus 8 for the UDP header).   In version 1, this value will always be 24.
 Reserved (6 bytes)   Reserved for future use and to make sure that the header is a multiple of 32 bits
 Call Leg ID   A 128-bit identifier for the call leg.   This is the call_leg_id from Call Control.

STREP Specification
  0                   1                   2                   3  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |1 1|Version|L|D|    HeaderLen  |  reserved (2 bytes)           | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |       reserved (4 bytes, for UDP ports or anything else)      | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |               The call_leg_id                                 | |                   from Call Control                           | |                       (128 bits / 16 bytes)                   | |                           (this is binary data)               | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 11   Static bits 11, always set to 11 to easily distinguish forked media   from RTP (10) and T.38 media (usually 00) and SIP (which begins   with a capital letter, so begins with bits 01). This is a magic number.
 Version   Four bits to indicate the version number of the protocol, starting at 0001.
 L   One bit to represent the leg of the call (A or B).   0 represents the A (first) leg of the call.   1 represents the B (second) leg of the call.
 D   One bit to represent the direction of this RTP stream.   0 represents media received by Telnyx.   1 represents media transmitted by Telnyx.
 HeaderLen (1 byte)   The length of the header in bytes.   Note that this value does not include the length of the payload. The total   size of the RTP can be calculated by subtracting the HeaderLen from the UDP   length (minus 8 for the UDP header).   In version 1, this value will always be 24.
 Reserved (6 bytes)   Reserved for future use and to make sure that the header is a multiple of 32 bits
 Call Leg ID   A 128-bit identifier for the call leg.   This is the call_leg_id from Call Control.

callCommands.callForkStop
Stop forking a call.
Expected Webhooks:
- call.fork.stopped
callCommands.callGatherStop
Stop current gather.
Expected Webhooks:
- call.gather.ended
callCommands.callGatherUsingAudio
Play an audio file on the call until the required DTMF signals are gathered to build interactive menus.
You can pass a list of valid digits along with an 'invalid_audio_url', which will be played back at the beginning of each prompt. Playback will be interrupted when a DTMF signal is received. The command must be issued before the gather_using_audio command.
Expected Webhooks:
- call.playback.started
- call.playback.ended
- call.dtmf.received (you may receive many of these webhooks)
- call.gather.ended
callCommands.callGatherUsingSpeak
Convert text to speech and play it on the call until the required DTMF signals are gathered to build interactive menus.
You can pass a list of valid digits along with an 'invalid_payload', which will be played back at the beginning of each prompt. Speech will be interrupted when a DTMF signal is received. The command must be issued before the gather_using_speak command.
Expected Webhooks:
- call.dtmf.received (you may receive many of these webhooks)
- call.gather.ended
callCommands.callHangup
Hang up the call.
Expected Webhooks:
- call.hangup
- call.recording.saved
callCommands.callPlaybackStart
Play an audio file on the call. If multiple play audio commands are issued consecutively, the audio files will be placed in a queue awaiting playback.
Notes:
- When overlay is enabled, target_legs is limited to self.
- A customer cannot Play Audio with overlay=true unless there is a Play Audio with overlay=false actively playing.
Expected Webhooks:
- call.playback.started
- call.playback.ended
callCommands.callPlaybackStop
Stop audio being played on the call.
Expected Webhooks:
- call.playback.ended or call.speak.ended
callCommands.callRecordPause

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

Resume recording the call.
Expected Webhooks:
There are no webhooks associated with this command.
callCommands.callRecordStart
Start recording the call. Recording will stop on call hang-up, or can be initiated via the Stop Recording command.
Expected Webhooks:
- call.recording.saved
callCommands.callRecordStop
Stop recording the call.
Expected Webhooks:
- call.recording.saved
callCommands.callRefer
Initiate a SIP Refer on a Call Control call. You can initiate a SIP Refer at any point in the duration of a call.
Expected Webhooks:
- call.refer.started
- call.refer.completed
- call.refer.failed
callCommands.callReject
Reject an incoming call.
Expected Webhooks:
- call.hangup
callCommands.callSendDtmf

Sends DTMF tones from this leg. DTMF tones will be heard by the other end of the call.
Expected Webhooks:
There are no webhooks associated with this command.
callCommands.callSpeak
Convert text to speech and play it back on the call. If multiple speak text commands are issued consecutively, the audio files will be placed in a queue awaiting playback.
Expected Webhooks:
- call.speak.started
- call.speak.ended
callCommands.callTranscriptionStart

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

Stop real-time transcription.
callCommands.callTransfer
Transfer a call to a new destination. If the transfer is unsuccessful, a call.hangup webhook for the other call (Leg B) will be sent indicating that the transfer could not be completed. The original call will remain active and may be issued additional commands, potentially transfering the call to an alternate destination.
Expected Webhooks:
- call.initiated
- call.bridged to Leg B
- call.answered or call.hangup
- call.machine.detection.ended if answering_machine_detection was requested
- call.machine.greeting.ended if answering_machine_detection was set to detect_beep, greeting_end or detect_words
callCommands.leaveQueue

Removes the call from a queue.
callControlApplications.createCallControlApplication

Create a call control application.
callControlApplications.deleteCallControlApplication

Deletes a call control application.
callControlApplications.listCallControlApplications

Return a list of call control applications.
callControlApplications.retrieveCallControlApplication

Retrieves the details of an existing call control application.
callControlApplications.updateCallControlApplication

Updates settings of an existing call control application.
callInformation.retrieveCallStatus

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

Generate and fetch voice usage report synchronously. This endpoint will both generate and fetch the voice report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
conferenceCommands.conferenceDialParticipantIn
Dials a phone number and, when the call is answered, automatically joins them into the specified conference.
Expected Webhooks:
- call.hangup
- call.answered
- conference.participant.joined
- conference.participant.left
conferenceCommands.conferenceHoldParticipants

Hold a list of participants in a conference call
conferenceCommands.conferenceJoin
Join an existing call leg to a conference. Issue the Join Conference command with the conference ID in the path and the call_control_id of the leg you wish to join to the conference as an attribute.
Expected Webhooks:
- conference.participant.joined
- conference.participant.left
conferenceCommands.conferenceLeave
Removes a call leg from a conference and moves it back to parked state. Expected Webhooks:
- conference.participant.left
conferenceCommands.conferenceMuteParticipants

Mute a list of participants in a conference call
conferenceCommands.conferencePlayAudio

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

Convert text to speech and play it to all or some participants.
conferenceCommands.conferenceStartRecording
Start recording the conference. Recording will stop on conference end, or via the Stop Recording command.
Expected Webhooks:
- conference.recording.saved
conferenceCommands.conferenceStopAudio

Stop audio being played to all or some participants on a conference call.
conferenceCommands.conferenceStopRecording
Stop recording the conference.
Expected Webhooks:
- conference.recording.saved
conferenceCommands.conferenceUnholdParticipants

Unhold a list of participants in a conference call
conferenceCommands.conferenceUnmuteParticipants

Unmute a list of participants in a conference call
conferenceCommands.conferenceUpdate

Update conference participant supervisor_role
conferenceCommands.createConference
Create a conference from an existing call leg using a call_control_id and a conference name. Upon creating the conference, the call will be automatically bridged to the conference. Conferences will expire after all participants have left the conference or after 4 hours regardless of the number of active participants.
Expected Webhooks:
- conference.created
- conference.participant.joined
- conference.participant.left
- conference.ended
- conference.recording.saved
- conference.floor.changed
conferenceCommands.listConferenceParticipants

Lists conference participants
conferenceCommands.listConferences

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

Retrieve an existing conference
connections.listConnections

Returns a list of your connections irrespective of type.
connections.retrieveConnection

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

Creates a credential connection.
credentialConnections.deleteCredentialConnection

Deletes an existing credential connection.
credentialConnections.listCredentialConnections

Returns a list of your credential connections.
credentialConnections.retrieveCredentialConnection

Retrieves the details of an existing credential connection.
credentialConnections.updateCredentialConnection

Updates settings of an existing credential connection.
credentials.createTelephonyCredential

Create a credential.
credentials.deleteTelephonyCredential

Delete an existing credential.
credentials.findTelephonyCredentials

List all On-demand Credentials.
credentials.getTelephonyCredential

Get the details of an existing On-demand Credential.
credentials.listTags

Returns a list of tags used on Credentials
credentials.telephonyCredentialAction

Perform activate or deactivate action on provided Credential. Activate action will change the status to active, making it possible to connect calls with the credential. Deactivate action will change the status to inactive, making it impossible to connect calls with the credential.
credentials.updateTelephonyCredential

Update an existing credential.
csvDownloads.createCsvDownload

Create a CSV download
csvDownloads.listCsvDownloads

List CSV downloads
csvDownloads.retrieveCsvDownload

Retrieve a CSV download
debugging.listCallEvents

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

Search for any detail record across the Telnyx Platform
documents.createDocument

Upload a document.

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

Delete a document.

A document can only be deleted if it's not linked to a service. If it is linked to a service, it must be unlinked prior to deleting.
documents.downloadDocServiceDocument

Download a document.
documents.listDocumentLinks

List all documents links ordered by created_at descending.
documents.listDocuments

List all documents ordered by created_at descending.
documents.retrieveDocument

Retrieve a document.
documents.updateDocument

Update a document.
fqdnConnections.createFqdnConnection

Creates a FQDN connection.
fqdnConnections.deleteFqdnConnection

Deletes an FQDN connection.
fqdnConnections.listFqdnConnections

Returns a list of your FQDN connections.
fqdnConnections.retrieveFqdnConnection

Retrieves the details of an existing FQDN connection.
fqdnConnections.updateFqdnConnection

Updates settings of an existing FQDN connection.
fqdNs.createFqdn

Create a new FQDN object.
fqdNs.deleteFqdn

Delete an FQDN.
fqdNs.listFqdns

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

Return the details regarding a specific FQDN.
fqdNs.updateFqdn

Update the details of a specific FQDN.
inboundChannels.listOutboundChannels

Returns the inbound channels for your account. Inbound channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the Telnyx Support Articles section for full information and examples of how to utilize Channel Billing.
inboundChannels.updateOutboundChannels

Update the inbound channels for the account
inventoryLevel.createInventoryCoverageRequest

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

Creates an IP connection.
ipConnections.deleteIpConnection

Deletes an existing IP connection.
ipConnections.listIpConnections

Returns a list of your IP connections.
ipConnections.retrieveIpConnection

Retrieves the details of an existing ip connection.
ipConnections.updateIpConnection

Updates settings of an existing IP connection.
iPs.createIp

Create a new IP object.
iPs.deleteIp

Delete an IP.
iPs.listIps

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

Return the details regarding a specific IP.
iPs.updateIp

Update the details of a specific IP.
managedAccounts.createManagedAccount

Create a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account.
managedAccounts.disableManagedAccount

Disables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be affected. The managed account and its sub-users will still be able to log in via the mission control portal.
managedAccounts.enableManagedAccount

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

Lists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts.
managedAccounts.retrieveManagedAccount

Retrieves the details of a single managed account.
mdrDetailReports.deleteMdrRequest

Delete generated messaging detail report by id
mdrDetailReports.getCdrRequests

Fetch all previous requests for messaging detail reports. Messaging detail reports are reports for pulling all messaging records.
mdrDetailReports.getMdrRequest

Fetch single messaging detail report by id.
mdrDetailReports.getReportsMdrs

Fetch all Mdr records
mdrDetailReports.submitMdrRequest

Submit a request for new messaging detail report. Messaging detail report pulls all raw messaging data according to defined filters.
mdrSearchBeta.getMdrMessageBody

Fetch Mdr message body
mdrSearchBeta.getPaginatedMdrs

Fetch all Mdr records
mdrUsageReports.deleteUsageReport

Delete messaging usage report by id
mdrUsageReports.getUsageReport

Fetch a single messaging usage report by id
mdrUsageReports.getUsageReports

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

Generate and fetch messaging usage report synchronously. This endpoint will both generate and fetch the messaging report over a specified time period. No polling is necessary but the response may take up to a couple of minutes.
mdrUsageReports.submitUsageReport

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

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

Deletes a stored media file.
mediaStorageApi.downloadMedia

Downloads a stored media file.
mediaStorageApi.getMedia

Returns the information about a stored media file.
mediaStorageApi.listMedia

Returns a list of stored media files.
mediaStorageApi.updateMedia

Updates a stored media file.
messages.createLongCodeMessage

Send a long code message
messages.createMessage

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

Send a message using number pool
messages.createShortCodeMessage

Send a short code message
messages.retrieveMessage

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

Create a messaging hosted number order
messagingHostedNumber.deleteMessagingHostedNumber

Delete a messaging hosted number
messagingHostedNumber.listMessagingHostedNumberOrder

List messaging hosted number orders
messagingHostedNumber.retrieveMessagingHostedNumberOrder

Retrieve a messaging hosted number order
messagingHostedNumber.uploadFileMessagingHostedNumberOrder

Upload file required for a messaging hosted number order
messagingProfiles.createMessagingProfile

Create a messaging profile
messagingProfiles.deleteMessagingProfile

Delete a messaging profile
messagingProfiles.listMessagingProfileMetrics

List messaging profile metrics
messagingProfiles.listMessagingProfilePhoneNumbers

List phone numbers associated with a messaging profile
messagingProfiles.listMessagingProfiles

List messaging profiles
messagingProfiles.listMessagingProfileShortCodes

List short codes associated with a messaging profile
messagingProfiles.retrieveMessagingProfile

Retrieve a messaging profile
messagingProfiles.retrieveMessagingProfileDetailedMetrics

Retrieve messaging profile metrics
messagingProfiles.updateMessagingProfile

Update a messaging profile
messagingUrlDomains.listMessagingUrlDomains

List messaging URL domains
mobileOperatorNetworks.mobileOperatorNetworksGet

Telnyx has a set of GSM mobile operators partners that are available through our mobile network roaming. This resource is entirely managed by Telnyx and may change over time. That means that this resource won't allow any write operations for it. Still, it's available so it can be used as a support resource that can be related to other resources or become a configuration option.
notifications.createNotificationChannels

Create a notification channel.
notifications.createNotificationProfile

Create a notification profile.
notifications.createNotificationSetting

Add a notification setting.
notifications.deleteNotificationChannel

Delete a notification channel.
notifications.deleteNotificationProfile

Delete a notification profile.
notifications.deleteNotificationSetting

Delete a notification setting.
notifications.findNotificationsEvents

Returns a list of your notifications events.
notifications.findNotificationsEventsConditions

Returns a list of your notifications events conditions.
notifications.findNotificationsProfiles

Returns a list of your notifications profiles.
notifications.listNotificationChannels

List notification channels.
notifications.listNotificationSettings

List notification settings.
notifications.retrieveNotificationChannel

Retrieve a notification channel.
notifications.retrieveNotificationProfile

Retrieve a notification profile.
notifications.retrieveNotificationSetting

Retrieve a notification setting.
notifications.updateNotificationChannel

Update a notification channel.
notifications.updateNotificationProfile

Update a notification profile.
numberBackgroundJobs.createPhoneNumbersJobDeletePhoneNumbers

Creates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call.
numberBackgroundJobs.createPhoneNumbersJobUpdateEmergencySettings

Creates a background job to update the emergency settings of a collection of phone numbers. At most one thousand numbers can be updated per API call.
numberBackgroundJobs.createPhoneNumbersJobUpdatePhoneNumber

Creates a new background job to update a batch of numbers. At most one thousand numbers can be updated per API call. At least one of the updateable fields must be submitted.
numberBackgroundJobs.listPhoneNumbersJobs

Lists the phone numbers jobs
numberBackgroundJobs.retrievePhoneNumbersJob

Retrieve a phone numbers job
numberBlockOrders.createNumberBlockOrder

Creates a phone number block order.
numberBlockOrders.listNumberBlockOrders

Get a paginated list of number block orders.
numberBlockOrders.retrieveNumberBlockOrder

Get an existing phone number block order.
numberBlocksBackgroundJobs.createPhoneNumberBlocksJobDeletePhoneNumberBlock

Creates a new background job to delete all the phone numbers associated with the given block. We will only consider the phone number block as deleted after all phone numbers associated with it are removed, so multiple executions of this job may be necessary in case some of the phone numbers present errors during the deletion process.
numberBlocksBackgroundJobs.listPhoneNumberBlocksJobs

Lists the phone number blocks jobs
numberBlocksBackgroundJobs.retrievePhoneNumberBlocksJob

Retrieves a phone number blocks job
numberConfigurations.deletePhoneNumber

Delete a phone number
numberConfigurations.enableEmergencyPhoneNumber

Enable emergency for a phone number
numberConfigurations.listPhoneNumbers

List phone numbers
numberConfigurations.listPhoneNumbersWithMessagingSettings

List phone numbers with messaging settings
numberConfigurations.listPhoneNumbersWithVoiceSettings

List phone numbers with voice settings
numberConfigurations.retrievePhoneNumber

Retrieve a phone number
numberConfigurations.retrievePhoneNumberWithMessagingSettings

Retrieve a phone number with messaging settings
numberConfigurations.retrievePhoneNumberWithVoiceSettings

Retrieve a phone number with voice settings
numberConfigurations.updatePhoneNumber

Update a phone number
numberConfigurations.updatePhoneNumberWithMessagingSettings

Update a phone number with messaging settings
numberConfigurations.updatePhoneNumberWithVoiceSettings

Update a phone number with voice settings
numberLookup.getOperation

Returns information about the provided phone number.
numberOrderDocuments.createNumberOrderDocument

Upload a phone number order document.
numberOrderDocuments.listNumberOrderDocuments

Gets a paginated list of number order documents.
numberOrderDocuments.retrieveNumberOrderDocument

Gets a single number order document.
numberOrderDocuments.updateNumberOrderDocument

Updates a number order document.
numberOrders.createComment

Create a comment
numberOrders.createNumberOrder

Creates a phone number order.
numberOrders.listComments

Retrieve all comments
numberOrders.listNumberOrders

Get a paginated list of number orders.
numberOrders.listSubNumberOrders

Get a paginated list of sub number orders.
numberOrders.markCommentRead

Mark a comment as read
numberOrders.retrieveComment

Retrieve a comment
numberOrders.retrieveNumberOrder

Get an existing phone number order.
numberOrders.retrieveNumberOrderPhoneNumber

Get an existing number order phone number.
numberOrders.retrieveNumberOrderPhoneNumbers

Get a list of phone numbers associated to orders.
numberOrders.retrieveSubNumberOrder

Get an existing sub number order.
numberOrders.updateNumberOrder

Updates a phone number order.
numberOrders.updateNumberOrderPhoneNumber

Updates a number order phone number.
numberOrders.updateSubNumberOrder

Updates a sub number order.
numberPortout.findPortoutComments

Returns a list of comments for a portout request.
numberPortout.findPortoutRequest

Returns the portout request based on the ID provided
numberPortout.listPortoutRequest

Returns the portout requests according to filters
numberPortout.postPortRequestComment

Creates a comment on a portout request.
numberPortout.updatePortoutRequest

Authorize or reject portout request
numberReservations.createNumberReservation

Creates a Phone Number Reservation for multiple numbers.
numberReservations.extendNumberReservationExpiryTime

Extends reservation expiry time on all phone numbers.
numberReservations.listNumberReservations

Gets a paginated list of phone number reservations.
numberReservations.retrieveNumberReservation

Gets a single phone number reservation.
numberSearch.listAvailablePhoneNumberBlocks

List available phone number blocks
numberSearch.listAvailablePhoneNumbers

List available phone numbers
otaUpdates.otaUpdateGet

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

List OTA updates
outboundVoiceProfiles.createOutboundVoiceProfile

Create an outbound voice profile.
outboundVoiceProfiles.deleteOutboundVoiceProfile

Deletes an existing outbound voice profile.
outboundVoiceProfiles.listOutboundVoiceProfiles

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

Retrieves the details of an existing outbound voice profile.
outboundVoiceProfiles.updateOutboundVoiceProfile

Updates an existing outbound voice profile.
phoneNumberPorting.postPortabilityCheck

Runs a portability check, returning the results immediately.
portingOrder.activatePortingOrder

Activate every numbers of a porting order asynchronously.
portingOrder.cancelPortingOrder

Cancel this porting order
portingOrder.confirmPortingOrder

Confirm your porting order.
portingOrder.createPortingOrder

Creates a new porting order object.
portingOrder.createPortingOrderComment

Creates a new comment for a porting order.
portingOrder.deletePortingOrder

Request the cancellation of a porting order.
portingOrder.getPortingOrder

Retrieves the details of an existing porting order.
portingOrder.getPortingOrderLoaTemplate

Download a porting order loa template
portingOrder.getPortingOrdersActivationJob

Returns a porting activation job.
portingOrder.getPortingPhoneNumbers

Returns a list of your porting phone numbers.
portingOrder.listPortingOrders

Returns a list of your porting order.
portingOrder.listPortingOrdersActivationJobs

Returns a list of your porting activation jobs.
portingOrder.listPortingOrdersComments

Returns a list of all comments of a porting order.
portingOrder.listPortingOrdersExceptionTypes

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

Edits the details of an existing porting order.
Any or all of a porting order’s attributes may be included in the resource object included in a PATCH request.
If a request does not include all of the attributes for a resource, the system will interpret the missing attributes as if they were included with their current values. To explicitly set something to null, it must be included in the request with a null value.
privateWirelessGateways.createPrivateWirelessGateway

Asynchronously create a Private Wireless Gateway for SIM cards for a previously created network.
privateWirelessGateways.deletePrivateWirelessGateway

Deletes the Private Wireless Gateway.
privateWirelessGateways.getPrivateWirelessGateway

Retrieve information about a Private Wireless Gateway.
privateWirelessGateways.getPrivateWirelessGateways

Get all Private Wireless Gateways belonging to the user.
programmableFaxApplications.createFaxApplication

Creates a new Fax Application based on the parameters sent in the request. The application name and webhook URL are required. Once created, you can assign phone numbers to your application using the /phone_numbers endpoint.
programmableFaxApplications.deleteFaxApplication

Permanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers.
programmableFaxApplications.getFaxApplication

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

This endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. You can adjust which applications are listed by using filters. Fax Applications are used to configure how you send and receive faxes using the Programmable Fax API with Telnyx.
programmableFaxApplications.updateFaxApplication

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

Delete a fax
programmableFaxCommands.listFaxes
programmableFaxCommands.refreshFax

Refreshes the inbound fax's media_url when it has expired
programmableFaxCommands.sendFax
programmableFaxCommands.viewFax

View a fax
queueCommands.listQueueCalls

Retrieve the list of calls in an existing queue
queueCommands.retrieveCallFromQueue

Retrieve an existing call from an existing queue
queueCommands.retrieveCallQueue

Retrieve an existing call queue
recordingsCommands.listRecordings

Lists recordings for the authenticated user
recordingsCommands.retrieveRecording

Retrieve a recording from the authenticated user's recordings
reporting.createWdrReport

Asynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period.
reporting.deleteWdrReport

Deletes one specific WDR report
reporting.getWdrReport

Returns one specific WDR report
reporting.getWdrReports

Returns the WDR Reports that match the given parameters.
reports.createLedgerBillingGroupReport

Create a ledger billing group report
reports.retrieveLedgerBillingGroupReport

Retrieve a ledger billing group report
requirements.docReqsRetrieveDocumentRequirements

Retrieve a document requirement record
requirements.listRequirements

List all requirements with filtering, sorting, and pagination
requirementTypes.docReqsListRequirementTypes

List all requirement types ordered by created_at descending
requirementTypes.docReqsRetrieveRequirementType

Retrieve a requirement type by id
roomParticipants.listRoomParticipants
roomParticipants.viewRoomParticipant

View a room participant.
rooms.createRoom

Synchronously create a Room.
rooms.deleteRoom

Synchronously delete a Room. Participants from that room will be kicked out, they won't be able to join that room anymore, and you won't be charged anymore for that room.
rooms.listRooms
rooms.nestedListRoomSessions
rooms.viewRoom

View a room.
roomsClientTokens.createRoomClientToken

Synchronously create an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after token_ttl_secs, a Refresh Token is also provided to refresh a Client Token, the Refresh Token expires after refresh_token_ttl_secs.
roomsClientTokens.refreshRoomClientToken

Synchronously refresh an Client Token to join a Room. Client Token is necessary to join a Telnyx Room. Client Token will expire after token_ttl_secs.
roomSessions.listRoomSessions
roomSessions.nestedListRoomParticipants
roomSessions.viewRoomSession

View a room session.
shortCodes.listShortCodes

List short codes
shortCodes.retrieveShortCode

Retrieve a short code
shortCodes.updateShortCode

Update the settings for a specific short code. To unbind a short code from a profile, set the messaging_profile_id to null or an empty string.
simCardGroupActions.simCardGroupActionGet

This API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.
simCardGroupActions.simCardGroupActionsGet

This API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific filters.
simCardGroups.removeSimCardGroupPrivateWirelessGateway

This action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic handled by Telnyx's default mobile network configuration.
simCardGroups.setSimCardGroupPrivateWirelessGateway

This action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in the SIM card group will get their traffic controlled by the associated Private Wireless Gateway. This operation will also imply that new SIM cards assigned to a group will inherit its network definitions. If it's moved to a different group that doesn't have a Private Wireless Gateway, it'll use Telnyx's default mobile network configuration.
simCardGroups.simCardGroupDelete

Permanently deletes a SIM card group
simCardGroups.simCardGroupsGet

Returns the details regarding a specific SIM card group
simCardGroups.simCardGroupsGetAll

Get all SIM card groups belonging to the user that match the given filters.
simCardGroups.simCardGroupsPost

Creates a new SIM card group object
simCardGroups.simCardGroupUpdate

Updates a SIM card group
simCardOrders.simCardOrderGet

Get a single SIM card order by its ID.
simCardOrders.simCardOrdersGet

Get all SIM card orders according to filters.
simCardOrders.simCardOrdersPost

Creates a new order for SIM cards.
simCardOrders.simCardOrdersPreview

Preview SIM card order purchases.
simCards.bulkSimCardNetworkPreferences

This API allows dispatching the same operation described for the PUT sim_cards/:sim_card_id/network_preferences API for multiple SIM cards at once.

Although, a SIM card network preference may fail individually under any validation triggered as a consequence of its state. For example, a SIM can't have an in-progress OTA update for applying a Network Preference, so they'll fail when requested in this API. In that scenario, the specific error will be present in the response along with the successful definitions in the "errors" response node.
simCards.postValidateRegistrationCodes

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

The SIM card will be decommissioned, removed from your account and you will stop being charged.
The SIM card won't be able to connect to the network after the deletion is completed, thus making it impossible to consume data.
Transitioning to the disabled state may take a period of time.
Until the transition is completed, the SIM card status will be disabling disabling.
In order to re-enable the SIM card, you will need to re-register it.
simCards.simCardDisable

The SIM card won't be able to connect to the network after the disabling is completed, thus making it impossible to consume data.
Transitioning to the disabled state may take a period of time.
Until the transition is completed, the SIM card status will be disabling.
simCards.simCardEnable

The SIM card will be able to connect to the network once the enabling is complete, thus making it possible to consume data.
To enable a SIM card, it must be associated with SIM card group.
Transitioning to the enabled state may take a period of time. Until the transition is completed, the SIM card status will be enabling.
simCards.simCardGet

Returns the details regarding a specific SIM card.
simCards.simCardNetworkPreferencesDelete

This API asynchronously removes the custom-defined network preferences settings. After this operation is done the Telnyx default settings, the same applied for an unaltered SIM card, will be in place.
simCards.simCardNetworkPreferencesGet

It returns the network preferences currently applied in the SIM card.
simCards.simCardNetworkPreferencesPut

This API allows setting or updating a SIM card network preference.

Every SIM card has default network preferences defined on Telnyx. These preferences will determine how a SIMCard will connect to the network by considering a list of preferable operators.

There can be multiple scenarios where an operator can be preferred over another, for example, when a specific mobile operator can provide better network latency or better pricing.
simCards.simCardPublicIpDelete

This API asynchronously removes an existing public IP from a SIM card.
simCards.simCardPublicIpGet

It returns the public IP requested for a SIM card.
simCards.simCardPublicIpPost

This API will asynchronously map a random public IP to a SIM card, making it reachable on the public internet.

The request will return the resource as "provisioning" right away, and it'll eventually get "provisioned", meaning it completed the setup.

Setting up a public IP will generate charges, and we won't be able to provide the IP if the account doesn't have a balance. In that case, this operation will succeed, but its status will change to failed eventually, and the resource will be updated with the associated status. The IP resource will need to be deleted and re-created with our DELETE and POST APIs in this scenario.
simCards.simCardRegister

Register the SIM cards associated with the provided registration codes to the current user's account.

If sim_card_group_id is provided, the SIM cards will be associated with that group. Otherwise, the default group for the current user will be used.
simCards.simCardSetStandby

The SIM card will be able to connect to the network once the process to set it to standby has been completed, thus making it possible to consume data.
To set a SIM card to standby, it must be associated with SIM card group.
Transitioning to the standby state may take a period of time. Until the transition is completed, the SIM card status will be setting_standby.
simCards.simCardsGet

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

Updates a SIM card's group and tags
simCards.wirelessConnectivityLogsGet

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

Creates a TeXML Application.
teXmlApplications.deleteTexmlApplication

Deletes a TeXML Application.
teXmlApplications.findTexmlApplications

Returns a list of your TeXML Applications.
teXmlApplications.getTexmlApplication

Retrieves the details of an existing TeXML Application.
teXmlApplications.updateTexmlApplication

Updates settings of an existing TeXML Application.
verify.createVerificationCall

Trigger a Call verification
verify.createVerificationFlashcall

Trigger a Flash call verification
verify.createVerificationPsD2

Trigger a PSD2 verification
verify.createVerificationSms

Trigger a SMS verification
verify.createVerificationWhatsapp

Trigger a Whatsapp verification
verify.createVerifyProfile

Creates a new Verify profile to associate verifications with.
verify.deleteVerifyProfile

Delete a Verify profile
verify.listVerifications

List verifications by phone number
verify.listVerifyProfiles

Gets a paginated list of Verify profiles.
verify.retrieveVerification

Retrieve a verification
verify.retrieveVerifyProfile

Gets a single Verify profile.
verify.updateVerifyProfile

Update a Verify profile
verify.verifyVerificationCode

Submit a verification code
wdrDetailReports.getPaginatedWdrs

Fetch all Wdr records
webhooks.getWebhookDeliveries

Lists webhook_deliveries for the authenticated user
webhooks.getWebhookDelivery

Provides webhook_delivery debug data, such as timestamps, delivery status and attempts.
whatsAppContacts.checkContact

Verify that a phone number belongs to a valid WhatsApp account. You must ensure that the status is valid before you can message a user, and you'll get their WhatsApp ID to use for messaging.
whatsAppDetailReports.deleteRequest

Delete generated WhatsApp detail report by id
whatsAppDetailReports.getRequest

Fetch single whatsapp detail report by id.
whatsAppDetailReports.getRequests

Fetch all previous requests for WhatsApp detail reports. WhatsApp detail reports are reports for pulling all WhatsApp records.
whatsAppDetailReports.submitRequest

Submit a request for new WhatsApp detail report. WhatsApp detail report pulls all raw WhatsApp data according to defined filters.
whatsAppMedia.deleteWhatsappMediaWhatsappUserIdMediaId

Delete uploaded media.
whatsAppMedia.getWhatsappMediaWhatsappUserIdMediaId

Retrieve uploaded media. Media is typically available for 30 days after uploading.
whatsAppMedia.uploadMedia

Upload media. Accepted media types include image/jpeg, image/png, video/mp4, video/3gpp, audio/aac, audio/ogg.
whatsAppMessages.markMessageAsRead

Mark a message as read.
whatsAppMessages.sendMessage

Send text messages, media/documents, and message templates to your customers.
whatsAppUsageAggregations.getUsageAggregationsSync

Generate and fetch WhatsApp usage aggregations synchronously. This endpoint will both generate and fetch the WhatsApp aggregations over a specified time period.
whatsAppUsers.getUser

Retrieve WhatsApp user information.
whatsAppUsers.updateWhatsAppWebhook

Update webhook URL used for a given WhatsApp user.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools