Skip to main content
Telnyx home page
Search...
⌘K
Login
Sign Up
Sign Up
Search...
Navigation
Page Not Found
Home
Guides
Development
API reference
Contact us
Slack community
OAuth Discovery
GET
Authorization server metadata
GET
Protected resource metadata
IP Addresses
GET
List all Access IP Addresses
POST
Create new Access IP Address
GET
Retrieve an access IP address
DEL
Delete access IP address
IP Ranges
GET
List all Access IP Ranges
POST
Create new Access IP Range
DEL
Delete access IP ranges
SIM Cards
POST
Purchase eSIMs
POST
Register SIM cards
GET
List SIM card data usage notifications
POST
Create a new SIM card data usage notification
GET
Get a single SIM card data usage notification
DEL
Delete SIM card data usage notifications
PATCH
Updates information for a SIM Card Data Usage Notification
GET
Get all SIM cards
POST
Request bulk setting SIM card public IPs.
POST
Validate SIM cards registration codes
GET
Get SIM card
DEL
Deletes a SIM card
PATCH
Update a SIM card
POST
Request a SIM card disable
POST
Request a SIM card enable
POST
Request removing a SIM card public IP
POST
Request setting a SIM card public IP
POST
Request setting a SIM card to standby
GET
Get activation code for an eSIM
GET
Get SIM card device details
GET
Get SIM card public IP definition
GET
List wireless connectivity logs
Addresses
GET
List all addresses
POST
Creates an address
POST
Validate an address
GET
Retrieve an address
DEL
Deletes an address
POST
Accepts this address suggestion as a new emergency address for Operator Connect and finishes the uploads of the numbers associated with it to Microsoft.
Advanced Number Orders
GET
List Advanced Orders
POST
Create Advanced Order
PATCH
Update Advanced Order
GET
Get Advanced Order
Assistants
GET
List assistants
POST
Create an assistant
POST
Import assistants from external provider
GET
List assistant tests with pagination
POST
Create a new assistant test
GET
Get all test suite names
GET
Get test suite run history
POST
Trigger test suite execution
GET
Get assistant test by ID
PUT
Update an assistant test
DEL
Delete an assistant test
GET
Get test run history for a specific test
POST
Trigger a manual test run
GET
Get specific test run details
GET
Get an assistant
POST
Update an assistant
DEL
Delete an assistant
GET
Get Canary Deploy
PUT
Update Canary Deploy
POST
Create Canary Deploy
DEL
Delete Canary Deploy
POST
Assistant Chat (BETA)
POST
Assistant Sms Chat
POST
Clone Assistant
GET
List scheduled events
POST
Create a scheduled event
GET
Get a scheduled event
DEL
Delete a scheduled event
GET
Get assistant texml
POST
Test Assistant Tool
GET
Get all versions of an assistant
GET
Get a specific assistant version
POST
Update a specific assistant version
DEL
Delete a specific assistant version
POST
Promote an assistant version to main
Audio
POST
Transcribe speech to text
Chat
POST
Create a chat completion
GET
Get available models
POST
Summarize file content
Clusters
GET
List all clusters
POST
Compute new clusters
GET
Fetch a cluster
DEL
Delete a cluster
GET
Fetch a cluster visualization
Conversations
GET
List conversations
POST
Create a conversation
GET
Get Insight Template Groups
POST
Create Insight Template Group
GET
Get Insight Template Group
PUT
Update Insight Template Group
DEL
Delete Insight Template Group
POST
Assign Insight Template To Group
DEL
Unassign Insight Template From Group
GET
Get Insight Templates
POST
Create Insight Template
GET
Get Insight Template
PUT
Update Insight Template
DEL
Delete Insight Template
GET
Get a conversation
PUT
Update conversation metadata
DEL
Delete a conversation
GET
Get insights for a conversation
POST
Create Message
GET
Get conversation messages
Embeddings
GET
Get Tasks by Status
POST
Embed documents
GET
List embedded buckets
GET
Get file-level embedding statuses for a bucket
DEL
Disable AI for an Embedded Bucket
POST
Search for documents
POST
Embed URL content
GET
Get an embedding task's status
Fine Tuning
GET
List fine tuning jobs
POST
Create a fine tuning job
GET
Get a fine tuning job
POST
Cancel a fine tuning job
Integrations
GET
List Integrations
GET
List User Integrations
GET
Get User Integration connection By Id
DEL
Delete Integration Connection
GET
List Integration By Id
MCP Servers
GET
List MCP Servers
POST
Create MCP Server
GET
Get MCP Server
PUT
Update MCP Server
DEL
Delete MCP Server
Audit Logs
GET
List Audit Logs
Authentication Providers
GET
List all SSO authentication providers
POST
Creates an authentication provider
GET
Retrieve an authentication provider
DEL
Deletes an authentication provider
PATCH
Update an authentication provider
Phone Number Search
GET
List available phone number blocks
GET
List available phone numbers
Billing
GET
Get user balance details
Billing Groups
GET
List all billing groups
POST
Create a billing group
GET
Get a billing group
DEL
Delete a billing group
PATCH
Update a billing group
Brands
GET
List Brands
POST
Create Brand
GET
Get Brand Feedback By Id
GET
Get Brand
PUT
Update Brand
DEL
Delete Brand
POST
Resend brand 2FA email
GET
List External Vettings
PUT
Import External Vetting Record
POST
Order Brand External Vetting
PUT
Revet Brand
SIM Card Actions
GET
List bulk SIM card actions
GET
Get bulk SIM card action details
GET
List SIM card actions
GET
Get SIM card action details
Bundles
GET
Retrieve Bundles
GET
Get Bundle By Id
User Bundles
GET
Get User Bundles
POST
Create User Bundles
GET
Get Unused User Bundles
GET
Get User Bundle by Id
DEL
Deactivate User Bundle
GET
Get User Bundle Resources
Call Control Applications
GET
List call control applications
POST
Create a call control application
GET
Retrieve a call control application
DEL
Delete a call control application
PATCH
Update a call control application
Debugging
GET
List call events
Call Commands
POST
Dial
POST
Start AI Assistant
POST
Stop AI Assistant
POST
Answer call
POST
Bridge calls
PUT
Update client state
POST
Enqueue call
POST
Forking start
POST
Forking stop
POST
Gather
POST
Gather stop
POST
Gather using AI
POST
Gather using audio
POST
Gather using speak
POST
Hangup call
POST
Remove call from a queue
POST
Play audio URL
POST
Stop audio playback
POST
Record pause
POST
Record resume
POST
Recording start
POST
Recording stop
POST
SIP Refer a call
POST
Reject a call
POST
Send DTMF
POST
Send SIP info
POST
SIPREC start
POST
SIPREC stop
POST
Speak text
POST
Streaming start
POST
Streaming stop
POST
Noise Suppression Start (BETA)
POST
Noise Suppression Stop (BETA)
POST
Switch supervisor role
POST
Transcription start
POST
Transcription stop
POST
Transfer call
Call Information
GET
Retrieve a call status
GET
List all active calls for given connection
Campaign
GET
List Campaigns
POST
Accept Shared Campaign
GET
Get Campaign Cost
GET
Get My Campaign
PUT
Update My Campaign
DEL
Deactivate My Campaign
POST
Submit campaign appeal for manual review
GET
Get Campaign Mno Metadata
GET
Get My Campaign Operation Status
GET
Get My Osr Campaign Attributes
GET
Get Sharing Status
POST
Submit Campaign
GET
Qualify By Usecase
Voice Channels
GET
List your voice channels for non-US zones
PUT
Update voice channels for non-US Zones
GET
List your voice channels for US Zone
PATCH
Update voice channels for US Zone
GET
List All Numbers using Channel Billing
GET
List Numbers using Channel Billing for a specific Zone
API Reference
GET
Get monthly charges breakdown
GET
Get monthly charges summary
GET
List invoices
GET
Get invoice by ID
Phone Number Orders
GET
Retrieve all comments
POST
Create a comment
GET
Retrieve a comment
PATCH
Mark a comment as read
GET
Retrieve a list of phone numbers associated to orders
GET
Retrieve a single phone number within a number order.
PATCH
Update requirements for a single phone number within a number order.
GET
List number orders
POST
Create a number order
GET
Retrieve a number order
PATCH
Update a number order
GET
List sub number orders
GET
Retrieve a sub number order
PATCH
Update a sub number order's requirements
PATCH
Cancel a sub number order
POST
Create a sub number orders report
GET
Retrieve a sub number orders report
GET
Download a sub number orders report
Conference Commands
GET
List conferences
POST
Create conference
GET
List conference participants
GET
Retrieve a conference
POST
Hold conference participants
POST
Join a conference
POST
Leave a conference
POST
Mute conference participants
POST
Play audio to conference participants
POST
Conference recording pause
POST
Conference recording resume
POST
Conference recording start
POST
Conference recording stop
POST
Speak text to conference participants
POST
Stop audio being played on the conference
POST
Unhold conference participants
POST
Unmute conference participants
POST
Update conference participant
Connections
GET
List connections
GET
Retrieve a connection
Country Coverage
GET
Get country coverage
GET
Get coverage for a specific country
Credential Connections
GET
List credential connections
POST
Create a credential connection
GET
Retrieve a credential connection
DEL
Delete a credential connection
PATCH
Update a credential connection
POST
Check a Credential Connection Registration Status
Call Recordings
GET
Retrieve a stored credential
PUT
Update a stored credential
POST
Create a custom storage credential
DEL
Delete a stored credential
GET
List all recording transcriptions
GET
Retrieve a recording transcription
DEL
Delete a recording transcription
GET
List all call recordings
POST
Delete a list of call recordings
GET
Retrieve a call recording
DEL
Delete a call recording
Customer Service Record
GET
List customer service records
POST
Create a customer service record
POST
Verify CSR phone number coverage
GET
Get a customer service record
Detail Records
GET
Search detail records
Dialogflow Integration
GET
Retrieve stored Dialogflow Connection
PUT
Update stored Dialogflow Connection
POST
Create a Dialogflow Connection
DEL
Delete stored Dialogflow Connection
Documents
GET
List all document links
GET
List all documents
POST
Upload a document
GET
Retrieve a document
DEL
Delete a document
PATCH
Update a document
GET
Download a document
GET
Generate a temporary download link for a document
POST
Upload a document
Dynamic Emergency Addresses
GET
List dynamic emergency addresses
POST
Create a dynamic emergency address.
GET
Get a dynamic emergency address
DEL
Delete a dynamic emergency address
Dynamic Emergency Endpoints
GET
List dynamic emergency endpoints
POST
Create a dynamic emergency endpoint.
GET
Get a dynamic emergency endpoint
DEL
Delete a dynamic emergency endpoint
Enum
GET
Get Enum
External Connections
GET
List all External Connections
POST
Creates an External Connection
GET
List all log messages
GET
Retrieve a log message
DEL
Dismiss a log message
GET
Retrieve an External Connection
DEL
Deletes an External Connection
PATCH
Update an External Connection
GET
List all civic addresses and locations
GET
Retrieve a Civic Address
PATCH
Update a location's static emergency address
GET
List all phone numbers
GET
Retrieve a phone number
PATCH
Update a phone number
GET
List all Releases
GET
Retrieve a Release request
GET
List all Upload requests
POST
Creates an Upload request
POST
Refresh the status of all Upload requests
GET
Get the count of pending upload requests
GET
Retrieve an Upload request
POST
Retry an Upload request
POST
Refresh Operator Connect integration
Programmable Fax Applications
GET
List all Fax Applications
POST
Creates a Fax Application
GET
Retrieve a Fax Application
DEL
Deletes a Fax Application
PATCH
Update a Fax Application
Programmable Fax Commands
GET
View a list of faxes
POST
Send a fax
GET
View a fax
DEL
Delete a fax
POST
Cancel a fax
POST
Refresh a fax
FQDN Connections
GET
List FQDN connections
POST
Create an FQDN connection
GET
Retrieve an FQDN connection
DEL
Delete an FQDN connection
PATCH
Update an FQDN connection
FQDNs
GET
List FQDNs
POST
Create an FQDN
GET
Retrieve an FQDN
DEL
Delete an FQDN
PATCH
Update an FQDN
Global IPs
GET
List all Global IP Allowed Ports
GET
Global IP Assignment Health Check Metrics
GET
List all Global IP assignments
POST
Create a Global IP assignment
GET
Retrieve a Global IP
DEL
Delete a Global IP assignment
PATCH
Update a Global IP assignment
GET
Global IP Assignment Usage Metrics
GET
List all Global IP Health check types
GET
List all Global IP health checks
POST
Create a Global IP health check
GET
Retrieve a Global IP health check
DEL
Delete a Global IP health check
GET
Global IP Latency Metrics
GET
List all Global IP Protocols
GET
Global IP Usage Metrics
GET
List all Global IPs
POST
Create a Global IP
GET
Retrieve a Global IP
DEL
Delete a Global IP
Inexplicit Number Orders
GET
List inexplicit number orders
POST
Create an inexplicit number order
GET
Retrieve an inexplicit number order
Integration Secrets
GET
List integration secrets
POST
Create a secret
DEL
Delete an integration secret
Inventory Level
GET
Create an inventory coverage request
IP Connections
GET
List Ip connections
POST
Create an Ip connection
GET
Retrieve an Ip connection
DEL
Delete an Ip connection
PATCH
Update an Ip connection
IPs
GET
List Ips
POST
Create an Ip
GET
Retrieve an Ip
DEL
Delete an Ip
PATCH
Update an Ip
Reports
POST
Create a ledger billing group report
GET
Get a ledger billing group report
MDR Detailed Reports
GET
Get all MDR detailed report requests
POST
Create a new MDR detailed report request
GET
Get a specific MDR detailed report request
DEL
Delete a MDR detailed report request
Speech to Text Batch Reports
GET
Get all Speech to Text batch report requests
POST
Create a new Speech to Text batch report request
GET
Get a specific Speech to Text batch report request
DEL
Delete a Speech to Text batch report request
CDR Reports
GET
Get all CDR report requests
POST
Create a new CDR report request
GET
Get available CDR report fields
GET
Get a specific CDR report request
DEL
Delete a CDR report request
MDR Usage Reports
GET
List MDR usage reports
POST
Create a new legacy usage V2 MDR report request
GET
Get an MDR usage report
DEL
Delete a V2 legacy usage MDR report request
GET
Fetch all Messaging usage reports
POST
Create MDR Usage Report
GET
Generate and fetch MDR Usage Report
GET
Retrieve messaging report
DEL
Delete MDR Usage Report
Telco Data Usage Reports
GET
List telco data usage reports
POST
Submit telco data usage report
GET
Get telco data usage report by ID
DEL
Delete telco data usage report
Speech to text Usage Reports
GET
Get speech to text usage report
CDR Usage Reports
GET
List CDR usage reports
POST
Create a new legacy usage V2 CDR report request
GET
Get a CDR usage report
DEL
Delete a V2 legacy usage CDR report request
GET
Generates and fetches CDR Usage Reports
Managed Accounts
GET
Lists accounts managed by the current user.
POST
Create a new managed account.
GET
Display information about allocatable global outbound channels for the current user.
GET
Retrieve a managed account
PATCH
Update a managed account
POST
Disables a managed account
POST
Enables a managed account
PATCH
Update the amount of allocatable global outbound channels allocated to a specific managed account.
Media Storage API
GET
List uploaded media
POST
Upload media
GET
Retrieve stored media
PUT
Update stored media
DEL
Deletes stored media
GET
Download stored media
Messages
POST
Send a message
POST
Send a group MMS message
POST
Send a long code message
POST
Send a message using number pool
POST
Schedule a message
POST
Send a short code message
GET
Retrieve a message
DEL
Cancel a scheduled message
RCS messaging
GET
Generate RCS deeplink
GET
List all RCS agents
GET
Retrieve an RCS agent
PATCH
Modify an RCS agent
POST
List RCS capabilities of a given batch of phone numbers
GET
List RCS capabilities of a phone number
PUT
Invite a test number to an RCS agent
POST
Send an RCS message
Messaging Hosted Number
GET
List messaging hosted number orders
POST
Create a messaging hosted number order
POST
Check eligibility of phone numbers for hosted messaging
GET
Retrieve a messaging hosted number order
DEL
Delete a messaging hosted number order
POST
Upload file required for a messaging hosted number order
POST
Validate the verification codes for the hosted numbers order
POST
Create verification codes for the hosted numbers order
DEL
Delete a messaging hosted number
Number Configurations
POST
Update the messaging profile of multiple phone numbers
GET
Retrieve bulk update status
GET
List phone numbers with messaging settings
GET
Retrieve a phone number with messaging settings
PATCH
Update the messaging profile and/or messaging product of a phone number
Advanced OptIn/OptOut
GET
List opt-outs
GET
List Auto-Response Settings
POST
Create Auto-Reponse Setting
GET
Get Auto-Response Setting
PUT
Update Auto-Response Setting
DEL
Delete Auto-Response Setting
Messaging Profiles
GET
List messaging profiles
POST
Create a messaging profile
GET
Retrieve a messaging profile
DEL
Delete a messaging profile
PATCH
Update a messaging profile
GET
List phone numbers associated with a messaging profile
GET
List short codes associated with a messaging profile
Messaging Tollfree Verification
GET
List Verification Requests
POST
Submit Verification Request
GET
Get Verification Request
DEL
Delete Verification Request
PATCH
Update Verification Request
Messaging URL Domains
GET
List messaging URL domains
Mobile Network Operators
GET
List mobile network operators
Push Credentials
GET
List mobile push credentials
POST
Creates a new mobile push credential
GET
Retrieves a mobile push credential
DEL
Deletes a mobile push credential
Coverage
GET
List network coverage locations
Networks
GET
List all Networks
POST
Create a Network
GET
Retrieve a Network
DEL
Delete a Network
PATCH
Update a Network
GET
Get Default Gateway status.
POST
Create Default Gateway.
DEL
Delete Default Gateway.
GET
List all Interfaces for a Network.
Notifications
GET
List notification channels
POST
Create a notification channel
GET
Get a notification channel
DEL
Delete a notification channel
PATCH
Update a notification channel
GET
List all Notifications Events Conditions
GET
List all Notifications Events
GET
List all Notifications Profiles
POST
Create a notification profile
GET
Get a notification profile
DEL
Delete a notification profile
PATCH
Update a notification profile
GET
List notification settings
POST
Add a Notification Setting
GET
Get a notification setting
DEL
Delete a notification setting
Phone Number Block Orders
GET
List number block orders
POST
Create a number block order
GET
Retrieve a number block order
Number Lookup
GET
Lookup phone number data
Requirement Groups
POST
Update requirement group for a phone number order
GET
List requirement groups
POST
Create a new requirement group
GET
Get a single requirement group by ID
DEL
Delete a requirement group by ID
PATCH
Update requirement values in requirement group
POST
Submit a Requirement Group for Approval
POST
Update requirement group for a sub number order
Phone Number Reservations
GET
List number reservations
POST
Create a number reservation
GET
Retrieve a number reservation
POST
Extend a number reservation
numbers features
POST
Retrieve the features for a list of numbers
OAuth Protocol
GET
OAuth authorization endpoint
GET
Get OAuth consent token
POST
Create OAuth grant
POST
Token introspection
GET
JSON Web Key Set
POST
Dynamic client registration
POST
OAuth token endpoint
OAuth Clients
GET
List OAuth clients
POST
Create OAuth client
GET
Get OAuth client
PUT
Update OAuth client
DEL
Delete OAuth client
OAuth Grants
GET
List OAuth grants
GET
Get OAuth grant
DEL
Revoke OAuth grant
OTA updates
GET
List OTA updates
GET
Get OTA update
Outbound Voice Profiles
GET
Get all outbound voice profiles
POST
Create an outbound voice profile
GET
Retrieve an outbound voice profile
DEL
Delete an outbound voice profile
PATCH
Updates an existing outbound voice profile.
Shared Campaigns
GET
Get Partner Campaigns Shared By User
GET
Get Sharing Status
GET
List Shared Campaigns
GET
Get Single Shared Campaign
PATCH
Update Single Shared Campaign
AutoRechargePreferences
GET
List auto recharge preferences
PATCH
Update auto recharge preferences
Bulk Phone Number Campaigns
POST
Assign Messaging Profile To Campaign
GET
Get Assignment Task Status
GET
Get Phone Number Status
Phone Number Blocks Background Jobs
GET
Lists the phone number blocks jobs
POST
Deletes all numbers associated with a phone number block
GET
Retrieves a phone number blocks job
Phone Number Campaigns
GET
Retrieve All Phone Number Campaigns
POST
Create New Phone Number Campaign
GET
Get Single Phone Number Campaign
PUT
Create New Phone Number Campaign
DEL
Delete Phone Number Campaign
Phone Number Configurations
GET
List phone numbers
POST
Verify ownership of phone numbers
GET
Slim List phone numbers
GET
List phone numbers with voice settings
GET
Retrieve a phone number
DEL
Delete a phone number
PATCH
Update a phone number
PATCH
Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)
POST
Enable emergency for a phone number
GET
Retrieve a phone number with voice settings
PATCH
Update a phone number with voice settings
CSV Downloads
GET
List CSV downloads
POST
Create a CSV download
GET
Retrieve a CSV download
Bulk Phone Number Operations
GET
Lists the phone numbers jobs
POST
Delete a batch of numbers
POST
Update the emergency settings from a batch of numbers
POST
Update a batch of numbers
GET
Retrieve a phone numbers job
Voicemail
GET
Get voicemail
POST
Create voicemail
PATCH
Update voicemail
Regulatory Requirements
GET
Retrieve regulatory requirements for a list of phone numbers
GET
Retrieve regulatory requirements
Phone Number Porting
POST
Run a portability check
Porting Orders
GET
List all porting events
GET
Show a porting event
POST
Republish a porting event
POST
Preview the LOA configuration parameters
GET
List LOA configurations
POST
Create a LOA configuration
GET
Retrieve a LOA configuration
DEL
Delete a LOA configuration
PATCH
Update a LOA configuration
GET
Preview a LOA configuration
GET
List porting related reports
POST
Create a porting related report
GET
Retrieve a report
GET
List available carriers in the UK
GET
List all porting orders
POST
Create a porting order
GET
List all exception types
GET
List all phone number configurations
POST
Create a list of phone number configurations
GET
Retrieve a porting order
DEL
Delete a porting order
PATCH
Edit a porting order
POST
Activate every number in a porting order asynchronously.
POST
Cancel a porting order
POST
Submit a porting order.
POST
Share a porting order
GET
List all porting activation jobs
GET
Retrieve a porting activation job
PATCH
Update a porting activation job
GET
List additional documents
POST
Create a list of additional documents
DEL
Delete an additional document
GET
List allowed FOC dates
GET
List all comments of a porting order
POST
Create a comment for a porting order
GET
Download a porting order loa template
GET
List porting order requirements
GET
Retrieve the associated V1 sub_request_id and port_request_id
GET
List verification codes
POST
Send the verification codes
POST
Verify the verification code for a list of phone numbers
GET
List action requirements for a porting order
POST
Initiate an action requirement
GET
List all associated phone numbers
POST
Create an associated phone number
DEL
Delete an associated phone number
GET
List all phone number blocks
POST
Create a phone number block
DEL
Delete a phone number block
GET
List all phone number extensions
POST
Create a phone number extension
DEL
Delete a phone number extension
GET
List all porting phone numbers
Number Portout
GET
List portout requests
GET
List all port-out events
GET
Show a port-out event
POST
Republish a port-out event
GET
List eligible port-out rejection codes for a specific order
GET
List port-out related reports
POST
Create a port-out related report
GET
Retrieve a report
GET
Get a portout request
GET
List all comments for a portout request
POST
Create a comment on a portout request
GET
List supporting documents on a portout request
POST
Create a list of supporting documents on a portout request
PATCH
Update Status
Private Wireless Gateways
GET
Get all Private Wireless Gateways
POST
Create a Private Wireless Gateway
GET
Get a Private Wireless Gateway
DEL
Delete a Private Wireless Gateway
Public Internet Gateways
GET
List all Public Internet Gateways
POST
Create a Public Internet Gateway
GET
Retrieve a Public Internet Gateway
DEL
Delete a Public Internet Gateway
Queue Commands
GET
Retrieve a call queue
GET
Retrieve calls from a queue
GET
Retrieve a call from a queue
DEL
Force remove a call from a queue
PATCH
Update queued call
Regions
GET
List all Regions
MDR Detail Reports
GET
Fetch all Mdr records
WDR Detail Reports
GET
Fetches all Wdr records
Requirement Types
GET
List all requirement types
GET
Retrieve a requirement types
Requirements
GET
List all requirements
GET
Retrieve a document requirement
Room Compositions
GET
View a list of room compositions.
POST
Create a room composition.
GET
View a room composition.
DEL
Delete a room composition.
Room Participants
GET
View a list of room participants.
GET
View a room participant.
Room Recordings
GET
View a list of room recordings.
DEL
Delete several room recordings in a bulk.
GET
View a room recording.
DEL
Delete a room recording.
Room Sessions
GET
View a list of room sessions.
GET
View a room session.
POST
End a room session.
POST
Kick participants from a room session.
POST
Mute participants in room session.
POST
Unmute participants in room session.
GET
View a list of room participants.
Rooms
GET
View a list of rooms.
POST
Create a room.
GET
View a room.
DEL
Delete a room.
PATCH
Update a room.
GET
View a list of room sessions.
Rooms Client Tokens
POST
Create Client Token to join a room.
POST
Refresh Client Token to join a room.
SETI Observability
GET
Retrieve Black Box Test Results
Short Codes
GET
List short codes
GET
Retrieve a short code
PATCH
Update short code
SIM Card Group Actions
GET
List SIM card group actions
GET
Get SIM card group action details
SIM Card Groups
GET
Get all SIM card groups
POST
Create a SIM card group
GET
Get SIM card group
DEL
Delete a SIM card group
PATCH
Update a SIM card group
POST
Request Private Wireless Gateway removal from SIM card group
POST
Request Wireless Blocklist removal from SIM card group
POST
Request Private Wireless Gateway assignment for SIM card group
POST
Request Wireless Blocklist assignment for SIM card group
SIM Card Orders
POST
Preview SIM card orders
GET
Get all SIM card orders
POST
Create a SIM card order
GET
Get a single SIM card order
SIPREC Connectors
POST
Create a SIPREC connector
GET
Retrieve a SIPREC connector
PUT
Update a SIPREC connector
DEL
Delete a SIPREC connector
Bucket SSL Certificate
GET
Get Bucket SSL Certificate
PUT
Add SSL Certificate
DEL
Remove SSL Certificate
Bucket Usage
GET
Get API Usage
GET
Get Bucket Usage
Presigned Object URLs
POST
Create Presigned Object URL
Data Migration
GET
List Migration Source coverage
GET
List all Migration Sources
POST
Create a Migration Source
GET
Get a Migration Source
DEL
Delete a Migration Source
GET
List all Migrations
POST
Create a Migration
GET
Get a Migration
POST
Stop a Migration
Credentials
GET
List all credentials
POST
Create a credential
GET
Get a credential
DEL
Delete a credential
PATCH
Update a credential
Access Tokens
POST
Create an Access Token.
TeXML REST Commands
GET
Fetch multiple call resources
POST
Initiate an outbound call
GET
Fetch a call
POST
Update call
GET
Fetch recordings for a call
POST
Request recording for a call
POST
Update recording on a call
POST
Request siprec session for a call
POST
Updates siprec session for a call
POST
Start streaming media from a call.
POST
Update streaming on a call
GET
List conference resources
GET
Fetch a conference resource
POST
Update a conference resource
GET
List conference participants
POST
Dial a new conference participant
GET
Get conference participant resource
POST
Update a conference participant
DEL
Delete a conference participant
GET
List conference recordings
GET
Fetch recordings for a conference
GET
Fetch multiple recording resources
GET
Fetch recording resource
DEL
Delete recording resource
GET
List recording transcriptions
GET
Fetch a recording transcription resource
DEL
Delete a recording transcription
POST
(Deprecated) Initiate an outbound call
POST
(Deprecated) Update call
POST
Create a TeXML secret
TeXML Applications
GET
List all TeXML Applications
POST
Creates a TeXML Application
GET
Retrieve a TeXML Application
DEL
Deletes a TeXML Application
PATCH
Update a TeXML Application
Text to Speech Commands
POST
Generate speech from text
GET
List available text to speech voices
Usage Reports (BETA)
GET
Get Telnyx product usage data (BETA)
GET
Get Usage Reports query options (BETA)
UserAddresses
GET
List all user addresses
POST
Creates a user address
GET
Retrieve a user address
User Tags
GET
List User Tags
Verify
GET
List verifications by phone number
POST
Verify verification code by phone number
POST
Trigger Call verification
POST
Trigger Flash call verification
POST
Trigger SMS verification
GET
Retrieve verification
POST
Verify verification code by ID
GET
List all Verify profiles
POST
Create a Verify profile
GET
Retrieve Verify profile message templates
POST
Create message template
PATCH
Update message template
GET
Retrieve Verify profile
DEL
Delete Verify profile
PATCH
Update Verify profile
Verified Numbers
GET
List all Verified Numbers
POST
Request phone number verification
GET
Retrieve a verified number
DEL
Delete a verified number
POST
Submit verification code
Virtual Cross Connects
GET
List all Virtual Cross Connects
POST
Create a Virtual Cross Connect
GET
Retrieve a Virtual Cross Connect
DEL
Delete a Virtual Cross Connect
PATCH
Update the Virtual Cross Connect
GET
List Virtual Cross Connect Cloud Coverage
Webhooks
GET
List webhook deliveries
GET
Find webhook_delivery details by ID
WireGuard Interfaces
GET
List all WireGuard Interfaces
POST
Create a WireGuard Interface
GET
Retrieve a WireGuard Interfaces
DEL
Delete a WireGuard Interface
GET
List all WireGuard Peers
POST
Create a WireGuard Peer
GET
Retrieve the WireGuard Peer
DEL
Delete the WireGuard Peer
PATCH
Update the WireGuard Peer
GET
Retrieve Wireguard config template for Peer
Reporting
GET
Get all Wireless Detail Records (WDRs) Reports
POST
Create a Wireless Detail Records (WDRs) Report
GET
Get a Wireless Detail Record (WDR) Report
DEL
Delete a Wireless Detail Record (WDR) Report
Wireless Regions
GET
Get all wireless regions
Wireless Blocklists
GET
Get all possible wireless blocklist values
GET
Get all Wireless Blocklists
POST
Create a Wireless Blocklist
PATCH
Update a Wireless Blocklist
GET
Get a Wireless Blocklist
DEL
Delete a Wireless Blocklist
Callbacks
HOOK
Call ai gather ended
HOOK
Call ai gather message history updated
HOOK
Call ai gather partial results
HOOK
Customer service record status changed
HOOK
Call answered
HOOK
Call bridged
HOOK
Call conversation ended
HOOK
Call conversation insights generated
HOOK
Call dtmf received
HOOK
Call enqueued
HOOK
Call fork started
HOOK
Call fork stopped
HOOK
Call gather ended
HOOK
Call hangup
HOOK
Call initiated
HOOK
Call left queue
HOOK
Call machine detection ended
HOOK
Call machine greeting ended
HOOK
Call machine premium detection ended
HOOK
Call machine premium greeting ended
HOOK
Call playback ended
HOOK
Call playback started
HOOK
Call recording error
HOOK
Call recording saved
HOOK
Call recording transcription saved
HOOK
Call refer completed
HOOK
Call refer failed
HOOK
Call refer started
HOOK
Call siprec failed
HOOK
Call siprec started
HOOK
Call siprec stopped
HOOK
Call speak ended
HOOK
Call speak started
HOOK
Call streaming failed
HOOK
Call streaming started
HOOK
Call streaming stopped
HOOK
Campaign status update
HOOK
Conference created
HOOK
Conference ended
HOOK
Conference floor changed
HOOK
Conference participant joined
HOOK
Conference participant left
HOOK
Conference participant playback ended
HOOK
Conference participant playback started
HOOK
Conference participant speak ended
HOOK
Conference participant speak started
HOOK
Conference playback ended
HOOK
Conference playback started
HOOK
Conference recording saved
HOOK
Conference speak ended
HOOK
Conference speak started
HOOK
Delivery update
HOOK
Fax delivered
HOOK
Fax failed
HOOK
Fax media processed
HOOK
Fax queued
HOOK
Fax sending started
HOOK
Inbound message
HOOK
Number order status update
HOOK
Replaced link click
HOOK
Streaming failed
HOOK
Streaming started
HOOK
Streaming stopped
HOOK
Transcription
404
Page Not Found
We couldn't find the page. Maybe you were looking for one of these pages below?
Mute conference participants
Telnyx Conferencing Demo
Telnyx IVR Demo
⌘I