Telnyx API
SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
SIP trunking, SMS, MMS, Call Control and Telephony Data Services.
Endpoints 361
Access Tokens
- POSTCreate an Access Token.
/telephony_credentials/:id/tokenCreate an Access Token (JWT) for the credential.
Addresses
- GETList all addresses
/addresses?page[number]=1&page[size]=20&filter[customer_reference][eq]=string&filter[customer_reference][contains]=string&filter[used_as_emergency]=null&filter[street_address][contains]=null&filter[address_book][eq]=null&sort=street_addressReturns a list of your addresses. - POSTCreates an address
/addressesCreates an address. - POSTValidate an address
/addresses/actions/validateValidates an address for emergency services. - GETRetrieve an address
/addresses/:idRetrieves the details of an existing address. - DELETEDeletes an address
/addresses/:idDeletes an existing address.
Authentication Providers
- GETList all SSO authentication providers
/authentication_providers?page[number]=1&page[size]=20&sort=nameReturns a list of your SSO authentication providers. - POSTCreates an authentication provider
/authentication_providersCreates an authentication provider. - GETRetrieve an authentication provider
/authentication_providers/:idRetrieves the details of an existing authentication provider. - DELETEDeletes an authentication provider
/authentication_providers/:idDeletes an existing authentication provider. - PATCHUpdate a authentication provider
/authentication_providers/:idUpdates settings of an existing authentication provider.
Billing
- GETRetrieve user balance details
/balance
Billing Groups
- GETList all billing groups
/billing_groups?page[number]=1&page[size]=20 - POSTCreate a billing group
/billing_groups - GETRetrieve a billing group
/billing_groups/:id - DELETEDelete a billing group
/billing_groups/:id - PATCHUpdate a billing group
/billing_groups/:id
Bulk Credentials
- POSTCreates several credentials
/actions/bulk/telephony_credentialsCreates several credentials in bulk. - DELETEDelete several credentials
/actions/bulk/telephony_credentials?filter[tag]=stringDelete several credentials in bulk. - PATCHUpdate several credentials
/actions/bulk/telephony_credentials?filter[tag]=stringUpdate several credentials in bulk. - POSTPerform activate or deactivate action on all credentials filtered by the provided tag.
/actions/:action/telephony_credentials?filter[tag]=stringPerform activate or deactivate action on all credentials filtered by the provided tag. Activate action will change the status to active, making it possible to…
Call Commands
- POSTDial
/callsDial 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… - POSTAnswer call
/calls/:call_control_id/actions/answerAnswer an incoming call. You must issue this command before executing subsequent commands on an incoming call. Expected Webhooks: call.answered - POSTBridge calls
/calls/:call_control_id/actions/bridgeBridge two call control calls. Expected Webhooks: call.bridged for Leg A call.bridged for Leg B - POSTEnqueue call
/calls/:call_control_id/actions/enqueuePut the call in a queue. - POSTForking start
/calls/:call_control_id/actions/fork_startCall 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… - POSTForking stop
/calls/:call_control_id/actions/fork_stopStop forking a call. Expected Webhooks: call.fork.stopped - POSTGather stop
/calls/:call_control_id/actions/gather_stopStop current gather. Expected Webhooks: call.gather.ended - POSTGather using audio
/calls/:call_control_id/actions/gather_using_audioPlay 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… - POSTGather using speak
/calls/:call_control_id/actions/gather_using_speakConvert 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… - POSTHangup call
/calls/:call_control_id/actions/hangupHang up the call. Expected Webhooks: call.hangup call.recording.saved - POSTRemove call from a queue
/calls/:call_control_id/actions/leave_queueRemoves the call from a queue. - POSTPlay audio URL
/calls/:call_control_id/actions/playback_startPlay 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.… - POSTStop audio playback
/calls/:call_control_id/actions/playback_stopStop audio being played on the call. Expected Webhooks: call.playback.ended or call.speak.ended - POSTRecord pause
/calls/:call_control_id/actions/record_pausePause recording the call. Recording can be resumed via Resume recording command. Expected Webhooks: There are no webhooks associated with this command. - POSTRecord resume
/calls/:call_control_id/actions/record_resumeResume recording the call. Expected Webhooks: There are no webhooks associated with this command. - POSTRecording start
/calls/:call_control_id/actions/record_startStart recording the call. Recording will stop on call hang-up, or can be initiated via the Stop Recording command. Expected Webhooks: call.recording.saved - POSTRecording stop
/calls/:call_control_id/actions/record_stopStop recording the call. Expected Webhooks: call.recording.saved - POSTSIP Refer a call
/calls/:call_control_id/actions/referInitiate 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… - POSTReject a call
/calls/:call_control_id/actions/rejectReject an incoming call. Expected Webhooks: call.hangup - POSTSend DTMF
/calls/:call_control_id/actions/send_dtmfSends 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. - POSTSpeak text
/calls/:call_control_id/actions/speakConvert 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… - POSTTranscription start
/calls/:call_control_id/actions/transcription_startStart real-time transcription. Transcription will stop on call hang-up, or can be initiated via the Transcription stop command. - POSTTranscription stop
/calls/:call_control_id/actions/transcription_stopStop real-time transcription. - POSTTransfer call
/calls/:call_control_id/actions/transferTransfer 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…
Call Control Applications
- GETList call control applications
/call_control_applications?page[number]=1&page[size]=20&filter[application_name][contains]=null&filter[outbound_voice_profile_id]=1293384261075731499&sort=connection_nameReturn a list of call control applications. - POSTCreate a call control application
/call_control_applicationsCreate a call control application. - GETRetrieve a call control application
/call_control_applications/:idRetrieves the details of an existing call control application. - DELETEDelete a call control application
/call_control_applications/:idDeletes a call control application. - PATCHUpdate a call control application
/call_control_applications/:idUpdates settings of an existing call control application.
Call Information
- GETRetrieve a call status
/calls/:call_control_idReturns the status of a call (data is available 10 minutes after call ended).
Conference Commands
- GETList conferences
/conferences?filter[name]=string&page[number]=1&page[size]=20Lists conferences. Conferences are created on demand, and will expire after all participants have left the conference or after 4 hours regardless of the… - POSTCreate conference
/conferencesCreate 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… - GETList conference participants
/conferences/:conference_id/participants?filter[muted]=true&filter[on_hold]=true&filter[whispering]=true&page[number]=1&page[size]=20Lists conference participants - GETRetrieve a conference
/conferences/:idRetrieve an existing conference - POSTDial a new participant into a conference
/conferences/:id/actions/dial_participantDials a phone number and, when the call is answered, automatically joins them into the specified conference. Expected Webhooks: call.hangup call.answered… - POSTHold conference participants
/conferences/:id/actions/holdHold a list of participants in a conference call - POSTJoin a conference
/conferences/:id/actions/joinJoin 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… - POSTLeave a conference
/conferences/:id/actions/leaveRemoves a call leg from a conference and moves it back to parked state. Expected Webhooks: conference.participant.left - POSTMute conference participants
/conferences/:id/actions/muteMute a list of participants in a conference call - POSTPlay audio to conference participants
/conferences/:id/actions/playPlay audio to all or some participants on a conference call. - POSTConference recording start
/conferences/:id/actions/record_startStart recording the conference. Recording will stop on conference end, or via the Stop Recording command. Expected Webhooks: conference.recording.saved - POSTConference recording stop
/conferences/:id/actions/record_stopStop recording the conference. Expected Webhooks: conference.recording.saved - POSTSpeak text to conference participants
/conferences/:id/actions/speakConvert text to speech and play it to all or some participants. - POSTStop audio being played on the conference
/conferences/:id/actions/stopStop audio being played to all or some participants on a conference call. - POSTUnhold conference participants
/conferences/:id/actions/unholdUnhold a list of participants in a conference call - POSTUnmute conference participants
/conferences/:id/actions/unmuteUnmute a list of participants in a conference call - POSTUpdate conference participant
/conferences/:id/actions/updateUpdate conference participant supervisor_role
Connections
- GETList connections
/connections?page[number]=1&page[size]=20&filter[connection_name][contains]=&filter[outbound_voice_profile_id]=1293384261075731499&sort=connection_nameReturns a list of your connections irrespective of type. - GETRetrieve a connection
/connections/:idRetrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.
Credential Connections
- GETList credential connections
/credential_connections?page[number]=1&page[size]=20&filter[connection_name][contains]=&filter[outbound.outbound_voice_profile_id]=1293384261075731499&sort=connection_nameReturns a list of your credential connections. - POSTCreate a credential connection
/credential_connectionsCreates a credential connection. - GETRetrieve a credential connection
/credential_connections/:idRetrieves the details of an existing credential connection. - DELETEDelete a credential connection
/credential_connections/:idDeletes an existing credential connection. - PATCHUpdate a credential connection
/credential_connections/:idUpdates settings of an existing credential connection.
Credentials
- GETList all credentials
/telephony_credentials?page[number]=1&page[size]=20&filter[tag]=string&filter[name]=string&filter[status]=string&filter[resource_id]=string&filter[sip_username]=stringList all On-demand Credentials. - POSTCreate a credential
/telephony_credentialsCreate a credential. - GETList all tags
/telephony_credentials/tags?page[number]=1&page[size]=20Returns a list of tags used on Credentials - GETGet a credential
/telephony_credentials/:idGet the details of an existing On-demand Credential. - DELETEDelete a credential
/telephony_credentials/:idDelete an existing credential. - PATCHUpdate a credential
/telephony_credentials/:idUpdate an existing credential. - POSTPerform activate or deactivate action on provided Credential
/telephony_credentials/:id/actions/:actionPerform activate or deactivate action on provided Credential. Activate action will change the status to active, making it possible to connect calls with the…
Debugging
- GETList call events
/call_events?filter[call_leg_id]=3fa85f64-5717-4562-b3fc-2c963f66afa6&filter[call_session_id]=3fa85f64-5717-4562-b3fc-2c963f66afa6&filter[status]=delivered&filter[type]=webhook&filter[event_timestamp][gt]=2019-03-29T11:10:00Z&filter[event_timestamp][gte]=2019-03-29T11:10:00Z&filter[event_timestamp][lt]=2019-03-29T11:10:00Z&filter[event_timestamp][lte]=2019-03-29T11:10:00Z&filter[event_timestamp][eq]=2019-03-29T11:10:00Z&page[number]=1&page[size]=20Filters 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…
Detail Records
- GETSearch detail records
/detail_records?filter[record_type]=messaging&filter[date_range]=last_3_days&filter=456&page[number]=1&page[size]=20&sort=created_atSearch for any detail record across the Telnyx Platform
Documents
- GETList all document links
/document_links?page[number]=1&page[size]=20&filter[document_id]=6a09cdc3-8948-47f0-aa62-74ac943d6c58&filter[linked_record_type]=porting_order&filter[linked_resource_id]=6a09cdc3-8948-47f0-aa62-74ac943d6c58List all documents links ordered by created_at descending. - GETList all documents
/documents?page[number]=1&page[size]=20List all documents ordered by created_at descending. - POSTUpload a document
/documentsUpload a document.<br /><br />Uploaded files must be linked to a service within 30 minutes or they will be automatically deleted. - GETRetrieve a document
/documents/:idRetrieve a document. - DELETEDelete a document
/documents/:idDelete a document.<br /><br />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… - PATCHUpdate a document
/documents/:idUpdate a document. - GETDownload a document
/documents/:id/downloadDownload a document.
FQDN Connections
- GETList FQDN connections
/fqdn_connections?page[number]=1&page[size]=20&filter[connection_name][contains]=&sort=connection_nameReturns a list of your FQDN connections. - POSTCreate an FQDN connection
/fqdn_connectionsCreates a FQDN connection. - GETRetrieve an FQDN connection
/fqdn_connections/:idRetrieves the details of an existing FQDN connection. - DELETEDelete an FQDN connection
/fqdn_connections/:idDeletes an FQDN connection. - PATCHUpdate an FQDN connection
/fqdn_connections/:idUpdates settings of an existing FQDN connection.
FQDNs
- GETList FQDNs
/fqdns?page[number]=1&page[size]=20&filter[connection_id]=string&filter[fqdn]=example.com&filter[port]=5060&filter[dns_record_type]=aGet all FQDNs belonging to the user that match the given filters. - POSTCreate an FQDN
/fqdnsCreate a new FQDN object. - GETRetrieve an FQDN
/fqdns/:idReturn the details regarding a specific FQDN. - DELETEDelete an FQDN
/fqdns/:idDelete an FQDN. - PATCHUpdate an FQDN
/fqdns/:idUpdate the details of a specific FQDN.
IP Connections
- GETList Ip connections
/ip_connections?page[number]=1&page[size]=20&filter[connection_name][contains]=&filter[outbound.outbound_voice_profile_id]=1293384261075731499&sort=connection_nameReturns a list of your IP connections. - POSTCreate an Ip connection
/ip_connectionsCreates an IP connection. - GETRetrieve an Ip connection
/ip_connections/:idRetrieves the details of an existing ip connection. - DELETEDelete an Ip connection
/ip_connections/:idDeletes an existing IP connection. - PATCHUpdate an Ip connection
/ip_connections/:idUpdates settings of an existing IP connection.
IPs
- GETList Ips
/ips?page[number]=1&page[size]=20&filter[connection_id]=string&filter[ip_address]=192.168.0.0&filter[port]=5060Get all IPs belonging to the user that match the given filters. - POSTCreate an Ip
/ipsCreate a new IP object. - GETRetrieve an Ip
/ips/:idReturn the details regarding a specific IP. - DELETEDelete an Ip
/ips/:idDelete an IP. - PATCHUpdate an Ip
/ips/:idUpdate the details of a specific IP.
Inbound Channels
- GETRetrieve your inbound channels
/phone_numbers/inbound_channelsReturns the inbound channels for your account. Inbound channels allows you to use Channel Billing for calls to your Telnyx phone numbers. Please check the… - PATCHUpdate inbound channels
/phone_numbers/inbound_channelsUpdate the inbound channels for the account
Inventory Level
- GETCreate an inventory coverage request
/inventory_coverage?filter[npa]=318&filter[nxx]=202&filter[administrative_area]=LA&filter[number_type]=did&filter[phone_number_type]=local&filter[country_code]=US&filter[count]=true&filter[groupBy]=nxxCreates 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…
MDR Search (Beta)
- GETFetch messaging detail records.
/message_detail_records?start_date=2020-07-01T00:00:00-06:00&end_date=2020-07-01T00:00:00-06:00&id=e093fbe0-5bde-11eb-ae93-0242ac130002&direction=INBOUND&outbound_profile_id=30ef55db-c4a2-4c4a-9804-a68077973d07&cld=+15551237654&cli=+15551237654&status=DELIVERED&message_type=text&country_iso=US&error=40001&normalized_carrier=Verizon&tag=Tag1&mcc=204&mnc=01&product=LONG_CODE&page[number]=1&page[size]=20&sort=created_atFetch all Mdr records - GETFetch message body by id.
/message_detail_records/:id/message_bodyFetch Mdr message body
Managed Accounts
- GETLists accounts managed by the current user.
/managed_accounts?page[number]=1&page[size]=20&filter[email][contains]=null&filter[email][eq]=null&sort=emailLists the accounts managed by the current user. Users need to be explictly approved by Telnyx in order to become manager accounts. - POSTCreate a new managed account.
/managed_accountsCreate a new managed account owned by the authenticated user. You need to be explictly approved by Telnyx in order to become a manager account. - GETRetrieve a managed account
/managed_accounts/:idRetrieves the details of a single managed account. - POSTDisables a managed account
/managed_accounts/:id/actions/disableDisables a managed account, forbidding it to use Telnyx services, including sending or receiving phone calls and SMS messages. Ongoing phone calls will not be… - POSTEnables a managed account
/managed_accounts/:id/actions/enableEnables a managed account and its sub-users to use Telnyx services.
Media Storage API
- GETList uploaded media
/mediaReturns a list of stored media files. - POSTUpload media
/mediaUpload media file to Telnyx so it can be used with other Telnyx services - GETRetrieve stored media
/media/:media_nameReturns the information about a stored media file. - PUTUpdate stored media
/media/:media_nameUpdates a stored media file. - DELETEDeletes stored media
/media/:media_nameDeletes a stored media file. - GETDownload stored media
/media/:media_name/downloadDownloads a stored media file.
Messages
- POSTSend a message
/messagesSend 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.… - POSTSend a long code message
/messages/long_code - POSTSend a message using number pool
/messages/number_pool - POSTSend a short code message
/messages/short_code - GETRetrieve a message
/messages/:idNote: 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…
Messaging Hosted Number
- GETList messaging hosted number orders
/messaging_hosted_number_orders?page[number]=1&page[size]=20 - POSTCreate a messaging hosted number order
/messaging_hosted_number_orders - GETRetrieve a messaging hosted number order
/messaging_hosted_number_orders/:id - POSTUpload file required for a messaging hosted number order
/messaging_hosted_number_orders/:id/actions/file_upload - DELETEDelete a messaging hosted number
/messaging_hosted_numbers/:id
Messaging Profiles
- GETList messaging profile metrics
/messaging_profile_metrics?page[number]=1&page[size]=20&id=3fa85f64-5717-4562-b3fc-2c963f66afa6&time_frame=24h - GETList messaging profiles
/messaging_profiles?page[number]=1&page[size]=20 - POSTCreate a messaging profile
/messaging_profiles - GETRetrieve a messaging profile
/messaging_profiles/:id - DELETEDelete a messaging profile
/messaging_profiles/:id - PATCHUpdate a messaging profile
/messaging_profiles/:id - GETRetrieve messaging profile metrics
/messaging_profiles/:id/metrics?time_frame=24h - GETList phone numbers associated with a messaging profile
/messaging_profiles/:id/phone_numbers?page[number]=1&page[size]=20 - GETList short codes associated with a messaging profile
/messaging_profiles/:id/short_codes?page[number]=1&page[size]=20
Messaging URL Domains
- GETList messaging URL domains
/messaging_url_domains?page[number]=1&page[size]=20
Mobile Operator Networks
- GETList mobile operator networks
/mobile_operator_networks?page[number]=1&page[size]=20&filter[name][starts_with]=AT&filter[name][contains]=T&T&filter[name][ends_with]=T&filter[country_code]=US&filter[mcc]=310&filter[mnc]=410&filter[tadig]=USACGTelnyx 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…
Notifications
- GETList notification channels
/notification_channels?page[number]=1&page[size]=20&filter[channel_type_id][eq]=webhookList notification channels. - POSTCreate a notification channel
/notification_channelsCreate a notification channel. - GETRetrieve a notification channel
/notification_channels/:idRetrieve a notification channel. - DELETEDelete a notification channel
/notification_channels/:idDelete a notification channel. - PATCHUpdate a notification channel
/notification_channels/:idUpdate a notification channel. - GETList all Notifications Events Conditions
/notification_event_conditions?page[number]=1&page[size]=20&filter[associated_record_type][eq]=phone_numberReturns a list of your notifications events conditions. - GETList all Notifications Events
/notification_events?page[number]=1&page[size]=20Returns a list of your notifications events. - GETList all Notifications Profiles
/notification_profiles?page[number]=1&page[size]=20Returns a list of your notifications profiles. - POSTCreate a notification profile
/notification_profilesCreate a notification profile. - GETRetrieve a notification profile
/notification_profiles/:idRetrieve a notification profile. - DELETEDelete a notification profile
/notification_profiles/:idDelete a notification profile. - PATCHUpdate a notification profile
/notification_profiles/:idUpdate a notification profile. - GETList notification settings
/notification_settings?page[number]=1&page[size]=20&filter[notification_profile_id][eq]=12455643-3cf1-4683-ad23-1cd32f7d5e0a&filter[notification_channel][eq]=12455643-3cf1-4683-ad23-1cd32f7d5e0a&filter[notification_event_condition_id][eq]=12455643-3cf1-4683-ad23-1cd32f7d5e0a&filter[associated_record_type][eq]=phone_number&filter[status][eq]=enable-receivedList notification settings. - POSTAdd a Notification Setting
/notification_settingsAdd a notification setting. - GETRetrieve a notification setting
/notification_settings/:idRetrieve a notification setting. - DELETEDelete a notification setting
/notification_settings/:idDelete a notification setting.
Number Background Jobs
- GETLists the phone numbers jobs
/phone_numbers/jobs?filter[type]=update_emergency_settings&page[number]=1&page[size]=20&sort=created_at - POSTDelete a batch of numbers
/phone_numbers/jobs/delete_phone_numbersCreates a new background job to delete a batch of numbers. At most one thousand numbers can be updated per API call. - POSTUpdate the emergency settings from a batch of numbers
/phone_numbers/jobs/update_emergency_settingsCreates 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. - POSTUpdate a batch of numbers
/phone_numbers/jobs/update_phone_numbersCreates 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… - GETRetrieve a phone numbers job
/phone_numbers/jobs/:id
Number Blocks Background Jobs
- GETLists the phone number blocks jobs
/phone_number_blocks/jobs?filter[type]=delete_phone_number_block&filter[status]=in_progress&page[number]=1&page[size]=20&sort=created_at - POSTDeletes all numbers associated with a phone number block
/phone_number_blocks/jobs/delete_phone_number_blockCreates 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… - GETRetrieves a phone number blocks job
/phone_number_blocks/jobs/:id
Number Configurations
- GETList phone numbers
/phone_numbers?page[number]=1&page[size]=20&filter[tag]=string&filter[phone_number]=string&filter[status]=active&filter[voice.connection_name][contains]=test&filter[voice.connection_name][starts_with]=test&filter[voice.connection_name][ends_with]=test&filter[voice.connection_name][eq]=test&filter[usage_payment_method]=channel&filter[billing_group_id]=62e4bf2e-c278-4282-b524-488d9c9c43b2&filter[emergency_address_id]=9102160989215728032&filter[customer_reference]=string&sort=connection_name - GETList phone numbers with messaging settings
/phone_numbers/messaging?page[number]=1&page[size]=20 - GETList phone numbers with voice settings
/phone_numbers/voice?page[number]=1&page[size]=20&filter[phone_number]=string&filter[connection_name][contains]=test&filter[customer_reference]=string&filter[usage_payment_method]=channel&sort=connection_name - GETRetrieve a phone number
/phone_numbers/:id - DELETEDelete a phone number
/phone_numbers/:id - PATCHUpdate a phone number
/phone_numbers/:id - POSTEnable emergency for a phone number
/phone_numbers/:id/actions/enable_emergency - GETRetrieve a phone number with messaging settings
/phone_numbers/:id/messaging - PATCHUpdate a phone number with messaging settings
/phone_numbers/:id/messaging - GETRetrieve a phone number with voice settings
/phone_numbers/:id/voice - PATCHUpdate a phone number with voice settings
/phone_numbers/:id/voice
Number Lookup
- GETLookup phone number data
/number_lookup/:phone_number?type=carrierReturns information about the provided phone number.
Number Order Documents
- GETList number order documents
/number_order_documents?filter[requirement_id]=string&filter[created_at][gt]=string&filter[created_at][lt]=string&page[number]=1&page[size]=20Gets a paginated list of number order documents. - POSTCreate a number order document
/number_order_documentsUpload a phone number order document. - GETRetrieve a number order document
/number_order_documents/:number_order_document_idGets a single number order document. - PATCHUpdate a number order document
/number_order_documents/:number_order_document_idUpdates a number order document.
Number Orders
- GETRetrieve all comments
/comments?filter[comment_record_type]=sub_number_order&filter[comment_record_id]=8ffb3622-7c6b-4ccc-b65f-7a3dc0099576 - POSTCreate a comment
/comments - GETRetrieve a comment
/comments/:id - PATCHMark a comment as read
/comments/:id/read - GETRetrieve a list of phone numbers associated to orders
/number_order_phone_numbersGet a list of phone numbers associated to orders. - GETRetrieve a number order phone number.
/number_order_phone_numbers/:number_order_phone_number_idGet an existing number order phone number. - PATCHUpdate a number order phone number.
/number_order_phone_numbers/:number_order_phone_number_idUpdates a number order phone number. - GETList number orders
/number_orders?filter[status]=string&filter[created_at][gt]=string&filter[created_at][lt]=string&filter[phone_numbers_count]=string&filter[customer_reference]=string&filter[requirements_met]=true&page[number]=1&page[size]=20Get a paginated list of number orders. - POSTCreate a number order
/number_ordersCreates a phone number order. - GETRetrieve a number order
/number_orders/:number_order_idGet an existing phone number order. - PATCHUpdate a number order
/number_orders/:number_order_idUpdates a phone number order. - GETList sub number orders
/sub_number_orders?filter[user_id]=d70873cd-7c98-401a-81b6-b1ae08246995&filter[order_request_id]=12ade33a-21c0-473b-b055-b3c836e1c293&filter[country_code]=US&filter[phone_number_type]=local&filter[phone_numbers_count]=1Get a paginated list of sub number orders. - GETRetrieve a sub number order
/sub_number_orders/:sub_number_order_id?filter[include_phone_numbers]=falseGet an existing sub number order. - PATCHUpdate a sub number order
/sub_number_orders/:sub_number_order_idUpdates a sub number order.
Number Portout
- GETRetrieve a list of portout requests
/portouts?filter[carrier_name]=string&filter[spid]=string&filter[status]=pending&page[number]=1&page[size]=20Returns the portout requests according to filters - GETRetrieve a portout request
/portouts/:idReturns the portout request based on the ID provided - GETList all comments for a portout request
/portouts/:id/commentsReturns a list of comments for a portout request. - POSTCreate a comment on a portout request
/portouts/:id/commentsCreates a comment on a portout request. - PATCHUpdate Status
/portouts/:id/:statusAuthorize or reject portout request
Number Reservations
- GETList number reservations
/number_reservations?filter[status]=string&filter[created_at][gt]=string&filter[created_at][lt]=string&filter[phone_numbers.phone_number]=string&filter[customer_reference]=string&page[number]=1&page[size]=20Gets a paginated list of phone number reservations. - POSTCreate a number reservation
/number_reservationsCreates a Phone Number Reservation for multiple numbers. - GETRetrieve a number reservation
/number_reservations/:number_reservation_idGets a single phone number reservation. - POSTExtend a number reservation
/number_reservations/:number_reservation_id/actions/extendExtends reservation expiry time on all phone numbers.
Number Search
- GETList available phone number blocks
/available_phone_number_blocks?filter[phone_number][starts_with]=201&filter[phone_number][ends_with]=8000&filter[phone_number][contains]=456&filter[locality]=Canberra&filter[administrative_area]=IL&filter[country_code]=US&filter[national_destination_code]=0251&filter[rate_center]=CHICAGO HEIGHTS&filter[number_type]=toll-free&filter[features]=voice,sms&filter[minimum_block_size]=100&filter[limit]=100 - GETList available phone numbers
/available_phone_numbers?filter[phone_number][starts_with]=FOO&filter[phone_number][ends_with]=CALL&filter[phone_number][contains]=TELNYX&filter[locality]=Canberra&filter[administrative_area]=IL&filter[country_code]=US&filter[national_destination_code]=0251&filter[rate_center]=CHICAGO HEIGHTS&filter[number_type]=local&filter[features]=voice,sms&filter[limit]=100&filter[best_effort]=false&filter[quickship]=true&filter[reservable]=true&filter[exclude_held_numbers]=false
OTA updates
- GETList OTA updates
/ota_updates?page[number]=1&page[size]=20&filter[status]=in-progress&filter[sim_card_id]=string&filter[type]=sim_card_network_preferences - GETGet OTA update
/ota_updates/:idThis API returns the details of an Over the Air (OTA) update.
Outbound Voice Profiles
- GETGet all outbound voice profiles
/outbound_voice_profiles?page[number]=1&page[size]=20&filter[name][contains]=office-profile&sort=nameGet all outbound voice profiles belonging to the user that match the given filters. - POSTCreate an outbound voice profile
/outbound_voice_profilesCreate an outbound voice profile. - GETRetrieve an outbound voice profile
/outbound_voice_profiles/:idRetrieves the details of an existing outbound voice profile. - DELETEDelete an outbound voice profile
/outbound_voice_profiles/:idDeletes an existing outbound voice profile. - PATCHUpdates an existing outbound voice profile.
/outbound_voice_profiles/:idUpdates an existing outbound voice profile.
Phone Number Porting
- POSTRun a portability check
/portability_checksRuns a portability check, returning the results immediately.
Porting Order
- GETList all porting orders
/porting_orders?page[number]=1&page[size]=20&include_phone_numbers=true&filter[status]={"details":[{"code":"ENTITY_NAME_MISMATCH","description":"Entity name does not match that on the CSR"}],"value":"ported"}&filter[customer_reference]=123abc&filter[phone_numbers][country_code]=US&filter[phone_numbers][carrier_name]=Telnyx&filter[misc][type]=full&filter[end_user][admin][entity_name]=Porter McPortersen&filter[end_user][admin][auth_person_name]=Admin McPortersen&filter[activation_settings][fast_port_eligible]=false&filter[activation_settings][foc_datetime_requested][gt]=2021-03-25T10:00:00.000Z&filter[activation_settings][foc_datetime_requested][lt]=2021-03-25T10:00:00.000Z&sort=created_atReturns a list of your porting order. - POSTCreate a porting order
/porting_ordersCreates a new porting order object. - GETList all exception types
/porting_orders/exception_typesReturns a list of all possible exception types for a porting order. - GETRetrieve a porting order
/porting_orders/:id?include_phone_numbers=trueRetrieves the details of an existing porting order. - DELETERequest cancellation
/porting_orders/:idRequest the cancellation of a porting order. - PATCHEdit a porting order
/porting_orders/:idEdits 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.… - POSTActivates every number on a porting order.
/porting_orders/:id/actions/activateActivate every numbers of a porting order asynchronously. - POSTCancel this porting order
/porting_orders/:id/actions/cancelCancel this porting order - POSTConfirms the porting order is ready to be actioned.
/porting_orders/:id/actions/confirmConfirm your porting order. - GETList all porting activation jobs
/porting_orders/:id/activation_jobs?page[number]=1&page[size]=20Returns a list of your porting activation jobs. - GETRetrieve a porting activation job
/porting_orders/:id/activation_jobs/:activationJobIdReturns a porting activation job. - GETList all comments of a porting order
/porting_orders/:id/comments?page[number]=1&page[size]=20Returns a list of all comments of a porting order. - POSTCreate a comment for a porting order
/porting_orders/:id/commentsCreates a new comment for a porting order. - GETDownload a porting order loa template
/porting_orders/:id/loa_templateDownload a porting order loa template - GETList all porting phone numbers
/porting_phone_numbers?page[number]=1&page[size]=20&filter[porting_order_id]=3fa85f64-5717-4562-b3fc-2c963f66afa6&filter[phone_number]=string&filter[activation_status]=Active&filter[portability_status]=confirmedReturns a list of your porting phone numbers.
Private Wireless Gateways
- GETGet all Private Wireless Gateways
/private_wireless_gateways?page[number]=1&page[size]=20&filter[name]=my private gateway&filter[ip_range]=192.168.0.0/24&filter[region_code]=ashburn-va&filter[created_at]=2018-02-02T22:25:27.521Z&filter[updated_at]=2018-02-02T22:25:27.521ZGet all Private Wireless Gateways belonging to the user. - POSTCreate a Private Wireless Gateway
/private_wireless_gatewaysAsynchronously create a Private Wireless Gateway for SIM cards for a previously created network. - GETGet a Private Wireless Gateway
/private_wireless_gateways/:idRetrieve information about a Private Wireless Gateway. - DELETEDelete a Private Wireless Gateway
/private_wireless_gateways/:idDeletes the Private Wireless Gateway.
Programmable Fax Applications
- GETList all Fax Applications
/fax_applications?page[number]=1&page[size]=20&filter[application_name][contains]=null&filter[outbound_voice_profile_id]=1293384261075731499&sort=connection_nameThis endpoint returns a list of your Fax Applications inside the 'data' attribute of the response. You can adjust which applications are listed by using… - POSTCreates a Fax Application
/fax_applicationsCreates 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… - GETRetrieve a Fax Application
/fax_applications/:idReturn the details of an existing Fax Application inside the 'data' attribute of the response. - DELETEDeletes a Fax Application
/fax_applications/:idPermanently deletes a Fax Application. Deletion may be prevented if the application is in use by phone numbers. - PATCHUpdate a Fax Application
/fax_applications/:idUpdates settings of an existing Fax Application based on the parameters of the request.
Programmable Fax Commands
- GETView a list of faxes
/faxes?filter[created_at][gte]=2020-02-02T22:25:27.521992Z&filter[created_at][gt]=2020-02-02T22:25:27.521992Z&filter[created_at][lte]=2020-02-02T22:25:27.521992Z&filter[created_at][lt]=2020-02-02T22:25:27.521992Z&filter[direction][eq]=inbound&filter[from][eq]=+13127367276&page[size]=2&page[number]=2 - POSTSend a fax
/faxes - GETView a fax
/faxes/:id - DELETEDelete a fax
/faxes/:id - POSTRefresh a fax
/faxes/:id/actions/refreshRefreshes the inbound fax's media_url when it has expired
Queue Commands
- GETRetrieve a call queue
/queues/:queue_nameRetrieve an existing call queue - GETRetrieve calls from a queue
/queues/:queue_name/calls?page[number]=1&page[size]=20Retrieve the list of calls in an existing queue - GETRetrieve a call from a queue
/queues/:queue_name/calls/:call_control_idRetrieve an existing call from an existing queue
Recordings Commands
- GETList recordings
/recordings?filter[conference_id]=428c31b6-7af4-4bcb-b7f5-5013ef9657c1&filter[created_at][gte]=2019-03-29T11:10:00Z&filter[created_at][lte]=2019-03-29T11:10:00Z&page[number]=1&page[size]=20Lists recordings for the authenticated user - GETRetrieve a recording
/recordings/:idRetrieve a recording from the authenticated user's recordings
Reporting
- GETGet all Wireless Detail Records (WDRs) Reports
/wireless/detail_records_reports?page[number]=1&page[size]=20Returns the WDR Reports that match the given parameters. - POSTCreate a Wireless Detail Records (WDRs) Report
/wireless/detail_records_reportsAsynchronously create a report containing Wireless Detail Records (WDRs) for the SIM cards that consumed wireless data in the given time period. - GETGet a Wireless Detail Record (WDR) Report
/wireless/detail_records_reports/:idReturns one specific WDR report - DELETEDelete a Wireless Detail Record (WDR) Report
/wireless/detail_records_reports/:idDeletes one specific WDR report
Requirement Types
- GETList all requirement types
/requirement_types?filter[name][contains]=utility bill&sort[]=country_codeList all requirement types ordered by created_at descending - GETRetrieve a requirement types
/requirement_types/:idRetrieve a requirement type by id
Requirements
- GETList all requirements
/requirements?filter[country_code]=US&filter[phone_number_type]=local&filter[action]=porting&sort[]=country_code&page[number]=1&page[size]=20List all requirements with filtering, sorting, and pagination - GETRetrieve a document requirement
/requirements/:idRetrieve a document requirement record
Room Participants
- GETView a list of room participants.
/room_participants?filter[date_joined_at][eq]=2021-04-25&filter[date_joined_at][gte]=2021-04-25&filter[date_joined_at][lte]=2021-04-25&filter[date_updated_at][eq]=2021-04-25&filter[date_updated_at][gte]=2021-04-25&filter[date_updated_at][lte]=2021-04-25&filter[date_left_at][eq]=2021-04-25&filter[date_left_at][gte]=2021-04-25&filter[date_left_at][lte]=2021-04-25&filter[context]=Alice&filter[session_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0&page[size]=20&page[number]=1 - GETView a room participant.
/room_participants/:room_participant_id
Room Sessions
- GETView a list of room sessions.
/room_sessions?filter[date_created_at][eq]=2021-04-25&filter[date_created_at][gte]=2021-04-25&filter[date_created_at][lte]=2021-04-25&filter[date_updated_at][eq]=2021-04-25&filter[date_updated_at][gte]=2021-04-25&filter[date_updated_at][lte]=2021-04-25&filter[date_ended_at][eq]=2021-04-25&filter[date_ended_at][gte]=2021-04-25&filter[date_ended_at][lte]=2021-04-25&filter[room_id]=0ccc7b54-4df3-4bca-a65a-3da1ecc777f0&filter[active]=true&include_participants=true&page[size]=20&page[number]=1 - GETView a room session.
/room_sessions/:room_session_id?include_participants=true - GETView a list of room participants.
/room_sessions/:room_session_id/participants?filter[date_joined_at][eq]=2021-04-25&filter[date_joined_at][gte]=2021-04-25&filter[date_joined_at][lte]=2021-04-25&filter[date_updated_at][eq]=2021-04-25&filter[date_updated_at][gte]=2021-04-25&filter[date_updated_at][lte]=2021-04-25&filter[date_left_at][eq]=2021-04-25&filter[date_left_at][gte]=2021-04-25&filter[date_left_at][lte]=2021-04-25&filter[context]=Alice&page[size]=20&page[number]=1
Rooms
- GETView a list of rooms.
/rooms?filter[date_created_at][eq]=2021-04-25&filter[date_created_at][gte]=2021-04-25&filter[date_created_at][lte]=2021-04-25&filter[date_updated_at][eq]=2021-04-25&filter[date_updated_at][gte]=2021-04-25&filter[date_updated_at][lte]=2021-04-25&filter[unique_name]=my_video_room&include_sessions=true&page[size]=20&page[number]=1 - POSTCreate a room.
/roomsSynchronously create a Room. - GETView a room.
/rooms/:room_id?include_sessions=true - DELETEDelete a room.
/rooms/:room_idSynchronously 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… - GETView a list of room sessions.
/rooms/:room_id/sessions?filter[date_created_at][eq]=2021-04-25&filter[date_created_at][gte]=2021-04-25&filter[date_created_at][lte]=2021-04-25&filter[date_updated_at][eq]=2021-04-25&filter[date_updated_at][gte]=2021-04-25&filter[date_updated_at][lte]=2021-04-25&filter[date_ended_at][eq]=2021-04-25&filter[date_ended_at][gte]=2021-04-25&filter[date_ended_at][lte]=2021-04-25&filter[active]=true&include_participants=true&page[size]=20&page[number]=1
Rooms Client Tokens
- POSTCreate Client Token to join a room.
/rooms/:room_id/actions/generate_join_client_tokenSynchronously 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… - POSTRefresh Client Token to join a room.
/rooms/:room_id/actions/refresh_client_tokenSynchronously 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.
SIM Card Group Actions
- GETList SIM card group actions
/sim_card_group_actions?page[number]=1&page[size]=20&filter[sim_card_group_id]=47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9&filter[status]=in-progress&filter[type]=set_private_wireless_gatewayThis API allows listing a paginated collection a SIM card group actions. It allows to explore a collection of existing asynchronous operation using specific… - GETGet SIM card group action details
/sim_card_group_actions/:idThis API allows fetching detailed information about a SIM card group action resource to make follow-ups in an existing asynchronous operation.
SIM Card Groups
- GETGet all SIM card groups
/sim_card_groups?page[number]=1&page[size]=20&filter[name]=My Test GroupGet all SIM card groups belonging to the user that match the given filters. - POSTCreate a SIM card group
/sim_card_groupsCreates a new SIM card group object - GETGet SIM card group
/sim_card_groups/:idReturns the details regarding a specific SIM card group - DELETEDelete a SIM card group
/sim_card_groups/:idPermanently deletes a SIM card group - PATCHUpdate a SIM card group
/sim_card_groups/:idUpdates a SIM card group - POSTRequest Private Wireless Gateway removal from SIM card group
/sim_card_groups/:id/actions/remove_private_wireless_gatewayThis action will asynchronously remove an existing Private Wireless Gateway definition from a SIM card group. Completing this operation defines that all SIM… - POSTRequest Private Wireless Gateway assignment for SIM card group
/sim_card_groups/:id/actions/set_private_wireless_gatewayThis action will asynchronously assign a provisioned Private Wireless Gateway to the SIM card group. Completing this operation defines that all SIM cards in…
SIM Card Orders
- POSTPreview SIM card orders
/sim_card_order_previewPreview SIM card order purchases. - GETGet all SIM card orders
/sim_card_orders?filter[created_at]=2018-02-02T22:25:27.521Z&filter[updated_at]=2018-02-02T22:25:27.521Z&filter[quantity]=21&filter[cost.amount]=2.53&filter[cost.currency]=USD&filter[address.id]=1293384261075731499&filter[address.street_address]=311 W Superior St&filter[address.extended_address]=Suite 504&filter[address.locality]=Chicago&filter[address.administrative_area]=IL&filter[address.country_code]=US&filter[address.postal_code]=60654&page[number]=1&page[size]=20Get all SIM card orders according to filters. - POSTCreate a SIM card order
/sim_card_ordersCreates a new order for SIM cards. - GETGet a single SIM card order
/sim_card_orders/:idGet a single SIM card order by its ID.
SIM Cards
- PUTBulk Network Preferences for SIM cards
/actions/network_preferences/sim_cardsThis API allows dispatching the same operation described for the PUT sim_cards/:sim_card_id/network_preferences API for multiple SIM cards at once.<br/><br/>… - POSTRegister SIM cards
/actions/register/sim_cardsRegister the SIM cards associated with the provided registration codes to the current user's account.<br/><br/> If <code>sim_card_group_id</code> is provided,… - GETGet all SIM cards
/sim_cards?page[number]=1&page[size]=20&include_sim_card_group=true&filter[sim_card_group_id]=47a1c2b0-cc7b-4ab1-bb98-b33fb0fc61b9&filter[tags]=personal,customers,active-customers&filter[iccid]=89310410106543789301Get all SIM cards belonging to the user that match the given filters. - POSTValidate SIM cards registration codes
/sim_cards/actions/validate_registration_codesIt validates whether SIM card registration codes are valid or not. - GETGet SIM card
/sim_cards/:id?include_sim_card_group=trueReturns the details regarding a specific SIM card. - DELETEDeletes a SIM card
/sim_cards/:idThe SIM card will be decommissioned, removed from your account and you will stop being charged.<br />The SIM card won't be able to connect to the network… - PATCHUpdate a SIM card
/sim_cards/:idUpdates a SIM card's group and tags - POSTRequest a SIM card disable
/sim_cards/:id/actions/disableThe SIM card won't be able to connect to the network after the disabling is completed, thus making it impossible to consume data.<br/> Transitioning to the… - POSTRequest a SIM card enable
/sim_cards/:id/actions/enableThe SIM card will be able to connect to the network once the enabling is complete, thus making it possible to consume data.<br/> To enable a SIM card, it must… - POSTRequest setting a SIM card to standby
/sim_cards/:id/actions/set_standbyThe 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.<br/> To… - GETGet network preferences
/sim_cards/:sim_card_id/network_preferences?include_ota_updates=trueIt returns the network preferences currently applied in the SIM card. - PUTSet network preferences
/sim_cards/:sim_card_id/network_preferencesThis API allows setting or updating a SIM card network preference. <br/><br/> Every SIM card has default network preferences defined on Telnyx. These…
Showing 300 of 361 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://api.telnyx.com/v2- Authentication
- A bearer token in the Authorization header
A bearer token in the Authorization header - Operations
- 361 operations on 251 pathsGET 166POST 122DELETE 36PATCH 34PUT 3
- Main resources
- Call Commands 24Conference Commands 17SIM Cards 17Notifications 16Porting Order 15Number Orders 14Verify 13Number Configurations 11Messaging Profiles 9Credentials 7
- Response formats
application/jsontext/plain- Description format
- OpenAPI 3.0.0, API version
2.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Telnyx API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Telnyx API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Create an Access Token.” (POST /telephony_credentials/:id/token), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Telnyx API?
SIP trunking, SMS, MMS, Call Control and Telephony Data Services. It is listed under Communication and has 361 endpoints.
Who publishes the Telnyx API?
It is listed from Telnyx's public API description (an OpenAPI document), not published by Telnyx on Swastik Codes. Anyone who controls telnyx.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Telnyx API?
Requests go to https://api.telnyx.com/v2. Endpoint paths are added to this base URL.
How do I authenticate with the Telnyx API?
It accepts 2 methods: A bearer token in the Authorization header; A bearer token in the Authorization header.
How many endpoints does the Telnyx API have?
361 operations on 251 paths (166 GET, 122 POST, 36 DELETE, 34 PATCH, 3 PUT). The largest groups are Call Commands, Conference Commands, SIM Cards, Notifications.
Is forking the Telnyx API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.