Telnyx_Test

Copy Page

Telnyx_Test

• Bucket
  • ListBuckets
  • DeleteBucket
  • HeadBucket
  • CreateBucket
• IP Addresses
  • List all Access IP Addresses
  • Create new Access IP Address
  • Delete access IP address
  • Retrieve an access IP address
• IP Ranges
  • List all Access IP Ranges
  • Create new Access IP Range
  • Delete access IP ranges
• SIM Cards
  • Purchase eSIMs
  • Register SIM cards
  • List SIM card data usage notifications
  • Create a new SIM card data usage notification
  • Delete SIM card data usage notifications
  • Get a single SIM card data usage notification
  • Updates information for a SIM Card Data Usage Notification
  • Get all SIM cards
  • Request bulk setting SIM card public IPs.
  • Validate SIM cards registration codes
  • Deletes a SIM card
  • Get SIM card
  • Update a SIM card
  • Request a SIM card disable
  • Request a SIM card enable
  • Request removing a SIM card public IP
  • Request setting a SIM card public IP
  • Request setting a SIM card to standby
  • Get activation code for an eSIM
  • Get SIM card device details
  • Get SIM card public IP definition
  • List wireless connectivity logs
• Addresses
  • List all addresses
  • Creates an address
  • Validate an address
  • Deletes an address
  • Retrieve an address
  • 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
  • List Advanced Orders
  • Create Advanced Order
  • Get Advanced Order
• Assistants
  • List assistants
  • Create an assistant
  • Import assistants from external provider
  • Delete an assistant
  • Get an assistant
  • Update an assistant
  • List scheduled events
  • Create a scheduled event
  • Delete a scheduled event
  • Get a scheduled event
  • Get assistant texml
  • Test Assistant Tool
• Audio
  • Transcribe speech to text
• Chat
  • Create a chat completion
  • Get available models
  • Summarize file content
• Clusters
  • List all clusters
  • Compute new clusters
  • Delete a cluster
  • Fetch a cluster
  • Fetch a cluster visualization
• Conversations
  • List conversations
  • Create a conversation
  • Delete a conversation
  • Get a conversation
  • Update conversation metadata
  • Get insights for a conversation
  • Get conversation messages
• Embeddings
  • Get Tasks by Status
  • Embed documents
  • List embedded buckets
  • Disable AI for an Embedded Bucket
  • Get file-level embedding statuses for a bucket
  • Search for documents
  • Embed URL content
  • Get an embedding task's status
• Fine Tuning
  • List fine tuning jobs
  • Create a fine tuning job
  • Get a fine tuning job
  • Cancel a fine tuning job
• Audit Logs
  • List Audit Logs
• Authentication Providers
  • List all SSO authentication providers
  • Creates an authentication provider
  • Deletes an authentication provider
  • Retrieve an authentication provider
  • Update an authentication provider
• Phone Number Search
  • List available phone number blocks
  • List available phone numbers
• Billing
  • Get user balance details
• Billing Groups
  • List all billing groups
  • Create a billing group
  • Delete a billing group
  • Get a billing group
  • Update a billing group
• Brands
  • List Brands
  • Create Brand
  • Get Brand Feedback By Id
  • Delete Brand
  • Get Brand
  • Update Brand
  • Resend brand 2FA email
  • List External Vettings
  • Order Brand External Vetting
  • Import External Vetting Record
  • Revet Brand
• SIM Card Actions
  • List bulk SIM card actions
  • Get bulk SIM card action details
  • List SIM card actions
  • Get SIM card action details
• Bundles
  • Retrieve Bundles
  • Get Bundle By Id
• User Bundles
  • Get User Bundles
  • Create User Bundles
  • Get Unused User Bundles
  • Deactivate User Bundle
  • Get User Bundle by Id
  • Get User Bundle Resources
• Call Control Applications
  • List call control applications
  • Create a call control application
  • Delete a call control application
  • Retrieve a call control application
  • Update a call control application
• Debugging
  • List call events
• Call Commands
  • Dial
  • Start AI Assistant
  • Stop AI Assistant
  • Answer call
  • Bridge calls
  • Update client state
  • Enqueue call
  • Forking start
  • Forking stop
  • Gather
  • Gather stop
  • Gather using AI
  • Gather using audio
  • Gather using speak
  • Hangup call
  • Remove call from a queue
  • Play audio URL
  • Stop audio playback
  • Record pause
  • Record resume
  • Recording start
  • Recording stop
  • SIP Refer a call
  • Reject a call
  • Send DTMF
  • Send SIP info
  • SIPREC start
  • SIPREC stop
  • Speak text
  • Streaming start
  • Streaming stop
  • Noise Suppression Start (BETA)
  • Noise Suppression Stop (BETA)
  • Transcription start
  • Transcription stop
  • Transfer call
• Call Information
  • Retrieve a call status
  • List all active calls for given connection
• Campaign
  • List Campaigns
  • Accept Shared Campaign
  • Get Campaign Cost
  • Deactivate My Campaign
  • Get My Campaign
  • Update My Campaign
  • Get Campaign Mno Metadata
  • Get My Campaign Operation Status
  • Get My Osr Campaign Attributes
  • Get Sharing Status
  • Submit Campaign
  • Qualify By Usecase
• Voice Channels
  • List your voice channels for non-US zones
  • Update voice channels for non-US Zones
  • List your voice channels for US Zone
  • Update voice channels for US Zone
  • List All Numbers using Channel Billing
  • List Numbers using Channel Billing for a specific Zone
• Phone Number Orders
  • Retrieve all comments
  • Create a comment
  • Retrieve a comment
  • Mark a comment as read
  • Retrieve a list of phone numbers associated to orders
  • Retrieve a single phone number within a number order.
  • Update requirements for a single phone number within a number order.
  • List number orders
  • Create a number order
  • Retrieve a number order
  • Update a number order
  • List sub number orders
  • Retrieve a sub number order
  • Update a sub number order's requirements
  • Cancel a sub number order
  • Create a sub number orders report
  • Retrieve a sub number orders report
  • Download a sub number orders report
• Conference Commands
  • List conferences
  • Create conference
  • List conference participants
  • Retrieve a conference
  • Hold conference participants
  • Join a conference
  • Leave a conference
  • Mute conference participants
  • Play audio to conference participants
  • Conference recording pause
  • Conference recording resume
  • Conference recording start
  • Conference recording stop
  • Speak text to conference participants
  • Stop audio being played on the conference
  • Unhold conference participants
  • Unmute conference participants
  • Update conference participant
• Connections
  • List connections
  • Retrieve a connection
• Country Coverage
  • Get country coverage
  • Get coverage for a specific country
• Credential Connections
  • List credential connections
  • Create a credential connection
  • Delete a credential connection
  • Retrieve a credential connection
  • Update a credential connection
  • Check a Credential Connection Registration Status
• Call Recordings
  • Delete a stored credential
  • Retrieve a stored credential
  • Create a custom storage credential
  • Update a stored credential
  • List all recording transcriptions
  • Delete a recording transcription
  • Retrieve a recording transcription
  • List all call recordings
  • Delete a list of call recordings
  • Delete a call recording
  • Retrieve a call recording
• Customer Service Record
  • List customer service records
  • Create a customer service record
  • Verify CSR phone number coverage
  • Get a customer service record
• Detail Records
  • Search detail records
• Dialogflow Integration
  • Delete stored Dialogflow Connection
  • Retrieve stored Dialogflow Connection
  • Create a Dialogflow Connection
  • Update stored Dialogflow Connection
• Documents
  • List all document links
  • List all documents
  • Upload a document
  • Delete a document
  • Retrieve a document
  • Update a document
  • Download a document
• Dynamic Emergency Addresses
  • List dynamic emergency addresses
  • Create a dynamic emergency address.
  • Delete a dynamic emergency address
  • Get a dynamic emergency address
• Dynamic Emergency Endpoints
  • List dynamic emergency endpoints
  • Create a dynamic emergency endpoint.
  • Delete a dynamic emergency endpoint
  • Get a dynamic emergency endpoint
• Enum
  • Get Enum
• External Connections
  • List all External Connections
  • Creates an External Connection
  • List all log messages
  • Dismiss a log message
  • Retrieve a log message
  • Deletes an External Connection
  • Retrieve an External Connection
  • Update an External Connection
  • List all civic addresses and locations
  • Retrieve a Civic Address
  • Update a location's static emergency address
  • List all phone numbers
  • Retrieve a phone number
  • Update a phone number
  • List all Releases
  • Retrieve a Release request
  • List all Upload requests
  • Creates an Upload request
  • Refresh the status of all Upload requests
  • Get the count of pending upload requests
  • Retrieve an Upload request
  • Retry an Upload request
  • Refresh Operator Connect integration
• Programmable Fax Applications
  • List all Fax Applications
  • Creates a Fax Application
  • Deletes a Fax Application
  • Retrieve a Fax Application
  • Update a Fax Application
• Programmable Fax Commands
  • View a list of faxes
  • Send a fax
  • Delete a fax
  • View a fax
  • Cancel a fax
  • Refresh a fax
• FQDN Connections
  • List FQDN connections
  • Create an FQDN connection
  • Delete an FQDN connection
  • Retrieve an FQDN connection
  • Update an FQDN connection
• FQDNs
  • List FQDNs
  • Create an FQDN
  • Delete an FQDN
  • Retrieve an FQDN
  • Update an FQDN
• Global IPs
  • List all Global IP Allowed Ports
  • Global IP Assignment Health Check Metrics
  • List all Global IP assignments
  • Create a Global IP assignment
  • Delete a Global IP assignment
  • Retrieve a Global IP
  • Update a Global IP assignment
  • Global IP Assignment Usage Metrics
  • List all Global IP Health check types
  • List all Global IP health checks
  • Create a Global IP health check
  • Delete a Global IP health check
  • Retrieve a Global IP health check
  • Global IP Latency Metrics
  • List all Global IP Protocols
  • Global IP Usage Metrics
  • List all Global IPs
  • Create a Global IP
  • Delete a Global IP
  • Retrieve a Global IP
• Integration Secrets
  • List integration secrets
  • Create a secret
  • Delete an integration secret
• Inventory Level
  • Create an inventory coverage request
• IP Connections
  • List Ip connections
  • Create an Ip connection
  • Delete an Ip connection
  • Retrieve an Ip connection
  • Update an Ip connection
• IPs
  • List Ips
  • Create an Ip
  • Delete an Ip
  • Retrieve an Ip
  • Update an Ip
• Reports
  • Create a ledger billing group report
  • Get a ledger billing group report
• Managed Accounts
  • Lists accounts managed by the current user.
  • Create a new managed account.
  • Display information about allocatable global outbound channels for the current user.
  • Retrieve a managed account
  • Update a managed account
  • Disables a managed account
  • Enables a managed account
  • Update the amount of allocatable global outbound channels allocated to a specific managed account.
• Media Storage API
  • List uploaded media
  • Upload media
  • Deletes stored media
  • Retrieve stored media
  • Update stored media
  • Download stored media
• Messages
  • Send a message
  • Send a group MMS message
  • Send a long code message
  • Send a message using number pool
  • Send a short code message
  • Retrieve a message
• Messaging Hosted Number
  • List messaging hosted number orders
  • Create a messaging hosted number order
  • Check eligibility of phone numbers for hosted messaging
  • Retrieve a messaging hosted number order
  • Upload file required for a messaging hosted number order
  • Validate the verification codes for the hosted numbers order
  • Create verification codes for the hosted numbers order
  • Delete a messaging hosted number
• Number Configurations
  • Update the messaging profile of multiple phone numbers
  • Retrieve bulk update status
  • List phone numbers with messaging settings
  • Retrieve a phone number with messaging settings
  • Update the messaging profile and/or messaging product of a phone number
• Advanced OptIn
  • OptOut
    • List opt-outs
    • List Auto-Response Settings
    • Create Auto-Reponse Setting
    • Delete Auto-Response Setting
    • Get Auto-Response Setting
    • Update Auto-Response Setting
• Messaging Profiles
  • List messaging profile metrics
  • List messaging profiles
  • Create a messaging profile
  • Delete a messaging profile
  • Retrieve a messaging profile
  • Update a messaging profile
  • Retrieve messaging profile metrics
  • List phone numbers associated with a messaging profile
  • List short codes associated with a messaging profile
• Messaging Tollfree Verification
  • List Verification Requests
  • Submit Verification Request
  • Delete Verification Request
  • Get Verification Request
  • Update Verification Request
• Messaging URL Domains
  • List messaging URL domains
• RCS messaging
  • Send an RCS message
  • List all RCS agents
  • Retrieve an RCS agent
  • Modify an RCS agent
• Mobile Network Operators
  • List mobile network operators
• Push Credentials
  • List mobile push credentials
  • Creates a new mobile push credential
  • Deletes a mobile push credential
  • Retrieves a mobile push credential
• Coverage
  • List network coverage locations
• Networks
  • List all Networks
  • Create a Network
  • Delete a Network
  • Retrieve a Network
  • Update a Network
  • Delete Default Gateway.
  • Get Default Gateway status.
  • Create Default Gateway.
  • List all Interfaces for a Network.
• Notifications
  • List notification channels
  • Create a notification channel
  • Delete a notification channel
  • Get a notification channel
  • Update a notification channel
  • List all Notifications Events Conditions
  • List all Notifications Events
  • List all Notifications Profiles
  • Create a notification profile
  • Delete a notification profile
  • Get a notification profile
  • Update a notification profile
  • List notification settings
  • Add a Notification Setting
  • Delete a notification setting
  • Get a notification setting
• Phone Number Block Orders
  • List number block orders
  • Create a number block order
  • Retrieve a number block order
• Number Lookup
  • Lookup phone number data
• Requirement Groups
  • Update requirement group for a phone number order
  • List requirement groups
  • Create a new requirement group
  • Delete a requirement group by ID
  • Get a single requirement group by ID
  • Update requirement values in requirement group
  • Submit a Requirement Group for Approval
  • Update requirement group for a sub number order
• Phone Number Reservations
  • List number reservations
  • Create a number reservation
  • Retrieve a number reservation
  • Extend a number reservation
• numbers features
  • Retrieve the features for a list of numbers
• OTA updates
  • List OTA updates
  • Get OTA update
• Outbound Voice Profiles
  • Get all outbound voice profiles
  • Create an outbound voice profile
  • Delete an outbound voice profile
  • Retrieve an outbound voice profile
  • Updates an existing outbound voice profile.
• Shared Campaigns
  • Get Partner Campaigns Shared By User
  • Get Sharing Status
  • List Shared Campaigns
  • Get Single Shared Campaign
  • Update Single Shared Campaign
• AutoRechargePreferences
  • List auto recharge preferences
  • Update auto recharge preferences
• Bulk Phone Number Campaigns
  • Assign Messaging Profile To Campaign
  • Get Assignment Task Status
  • Get Phone Number Status
• Phone Number Blocks Background Jobs
  • Lists the phone number blocks jobs
  • Deletes all numbers associated with a phone number block
  • Retrieves a phone number blocks job
• Phone Number Campaigns
  • Retrieve All Phone Number Campaigns
  • Create New Phone Number Campaign
  • Delete Phone Number Campaign
  • Get Single Phone Number Campaign
  • Create New Phone Number Campaign
• Phone Number Configurations
  • List phone numbers
  • Slim List phone numbers
  • List phone numbers with voice settings
  • Delete a phone number
  • Retrieve a phone number
  • Update a phone number
  • Change the bundle status for a phone number (set to being in a bundle or remove from a bundle)
  • Enable emergency for a phone number
  • Retrieve a phone number with voice settings
  • Update a phone number with voice settings
• CSV Downloads
  • List CSV downloads
  • Create a CSV download
  • Retrieve a CSV download
• Bulk Phone Number Operations
  • Lists the phone numbers jobs
  • Delete a batch of numbers
  • Update the emergency settings from a batch of numbers
  • Update a batch of numbers
  • Retrieve a phone numbers job
• Voicemail
  • Get voicemail
  • Update voicemail
  • Create voicemail
• Regulatory Requirements
  • Retrieve regulatory requirements for a list of phone numbers
  • Retrieve regulatory requirements
• Phone Number Porting
  • Run a portability check
• Porting Orders
  • List all porting events
  • Show a porting event
  • Republish a porting event
  • Preview the LOA configuration parameters
  • List LOA configurations
  • Create a LOA configuration
  • Delete a LOA configuration
  • Retrieve a LOA configuration
  • Update a LOA configuration
  • Preview a LOA configuration
  • List porting related reports
  • Create a porting related report
  • Retrieve a report
  • List all porting orders
  • Create a porting order
  • List all exception types
  • List all phone number configurations
  • Create a list of phone number configurations
  • Delete a porting order
  • Retrieve a porting order
  • Edit a porting order
  • Activate every number in a porting order asynchronously.
  • Cancel a porting order
  • Submit a porting order.
  • Share a porting order
  • List all porting activation jobs
  • Retrieve a porting activation job
  • Update a porting activation job
  • List additional documents
  • Create a list of additional documents
  • Delete an additional document
  • List allowed FOC dates
  • List all comments of a porting order
  • Create a comment for a porting order
  • Download a porting order loa template
  • List porting order requirements
  • Retrieve the associated V1 sub_request_id and port_request_id
  • List verification codes
  • Send the verification codes
  • Verify the verification code for a list of phone numbers
  • List all phone number blocks
  • Create a phone number block
  • Delete a phone number block
  • List all phone number extensions
  • Create a phone number extension
  • Delete a phone number extension
  • List all porting phone numbers
• Number Portout
  • List portout requests
  • List all port-out events
  • Show a port-out event
  • Republish a port-out event
  • List eligible port-out rejection codes for a specific order
  • List port-out related reports
  • Create a port-out related report
  • Retrieve a report
  • Get a portout request
  • List all comments for a portout request
  • Create a comment on a portout request
  • List supporting documents on a portout request
  • Create a list of supporting documents on a portout request
  • Update Status
• Private Wireless Gateways
  • Get all Private Wireless Gateways
  • Create a Private Wireless Gateway
  • Delete a Private Wireless Gateway
  • Get a Private Wireless Gateway
• Public Internet Gateways
  • List all Public Internet Gateways
  • Create a Public Internet Gateway
  • Delete a Public Internet Gateway
  • Retrieve a Public Internet Gateway
• Queue Commands
  • Retrieve a call queue
  • Retrieve calls from a queue
  • Retrieve a call from a queue
• Regions
  • List all Regions
• CDR Usage Reports
  • Generates and fetches CDR Usage Reports
• MDR Usage Reports
  • Fetch all Messaging usage reports
  • Create MDR Usage Report
  • Generate and fetch MDR Usage Report
  • Delete MDR Usage Report
  • Retrieve messaging report
• MDR Detail Reports
  • Fetch all Mdr records
• WDR Detail Reports
  • Fetches all Wdr records
• Requirement Types
  • List all requirement types
  • Retrieve a requirement type
• Requirements
  • List all requirements
  • Retrieve a document requirement
• Room Compositions
  • View a list of room compositions.
  • Create a room composition.
  • Delete a room composition.
  • View a room composition.
• Room Participants
  • View a list of room participants.
  • View a room participant.
• Room Recordings
  • Delete several room recordings in a bulk.
  • View a list of room recordings.
  • Delete a room recording.
  • View a room recording.
• Room Sessions
  • View a list of room sessions.
  • View a room session.
  • End a room session.
  • Kick participants from a room session.
  • Mute participants in room session.
  • Unmute participants in room session.
  • View a list of room participants.
• Rooms
  • View a list of rooms.
  • Create a room.
  • Delete a room.
  • View a room.
  • Update a room.
  • View a list of room sessions.
• Rooms Client Tokens
  • Create Client Token to join a room.
  • Refresh Client Token to join a room.
• Short Codes
  • List short codes
  • Retrieve a short code
  • Update short code
• SIM Card Group Actions
  • List SIM card group actions
  • Get SIM card group action details
• SIM Card Groups
  • Get all SIM card groups
  • Create a SIM card group
  • Delete a SIM card group
  • Get SIM card group
  • Update a SIM card group
  • Request Private Wireless Gateway removal from SIM card group
  • Request Private Wireless Gateway assignment for SIM card group
• SIM Card Orders
  • Preview SIM card orders
  • Get all SIM card orders
  • Create a SIM card order
  • Get a single SIM card order
• SIPREC Connectors
  • Create a SIPREC connector
  • Delete a SIPREC connector
  • Retrieve a SIPREC connector
  • Update a SIPREC connector
• Bucket SSL Certificate
  • Remove SSL Certificate
  • Get Bucket SSL Certificate
  • Add SSL Certificate
• Bucket Usage
  • Get API Usage
  • Get Bucket Usage
• Presigned Object URLs
  • Create Presigned Object URL
• Data Migration
  • List Migration Source coverage
  • List all Migration Sources
  • Create a Migration Source
  • Delete a Migration Source
  • Get a Migration Source
  • List all Migrations
  • Create a Migration
  • Get a Migration
  • Stop a Migration
• Credentials
  • List all credentials
  • Create a credential
  • Delete a credential
  • Get a credential
  • Update a credential
• Access Tokens
  • Create an Access Token.
• TeXML REST Commands
  • Fetch multiple call resources
  • Initiate an outbound call
  • Fetch a call
  • Update call
  • Fetch recordings for a call
  • Request recording for a call
  • Update recording on a call
  • Request siprec session for a call
  • Updates siprec session for a call
  • Start streaming media from a call.
  • Update streaming on a call
  • List conference resources
  • Fetch a conference resource
  • Update a conference resource
  • List conference participants
  • Dial a new conference participant
  • Delete a conference participant
  • Get conference participant resource
  • Update a conference participant
  • List conference recordings
  • Fetch recordings for a conference
  • Fetch multiple recording resources
  • Delete recording resource
  • Fetch recording resource
  • List recording transcriptions
  • Delete a recording transcription
  • Fetch a recording transcription resource
  • (Deprecated) Initiate an outbound call
  • (Deprecated) Update call
  • Create a TeXML secret
• TeXML Applications
  • List all TeXML Applications
  • Creates a TeXML Application
  • Deletes a TeXML Application
  • Retrieve a TeXML Application
  • Update a TeXML Application
• Text to Speech Commands
  • Generate speech from text
  • List available text to speech voices
• Usage Reports (BETA)
  • Get Telnyx product usage data (BETA)
  • Get Usage Reports query options (BETA)
• UserAddresses
  • List all user addresses
  • Creates a user address
  • Retrieve a user address
• User Tags
  • List User Tags
• Verify
  • List verifications by phone number
  • Verify verification code by phone number
  • Trigger Call verification
  • Trigger Flash call verification
  • Trigger SMS verification
  • Retrieve verification
  • Verify verification code by ID
  • List all Verify profiles
  • Create a Verify profile
  • Retrieve Verify profile message templates
  • Delete Verify profile
  • Retrieve Verify profile
  • Update Verify profile
• Verified Numbers
  • Request phone number verification for numbers with extensions
  • List all Verified Numbers
  • Request phone number verification
  • Delete a verified number
  • Retrieve a verified number
  • Submit verification code
• Virtual Cross Connects
  • List all Virtual Cross Connects
  • Create a Virtual Cross Connect
  • Delete a Virtual Cross Connect
  • Retrieve a Virtual Cross Connect
  • Update the Virtual Cross Connect
  • List Virtual Cross Connect Cloud Coverage
• Webhooks
  • List webhook deliveries
  • Find webhook_delivery details by ID
• WireGuard Interfaces
  • List all WireGuard Interfaces
  • Create a WireGuard Interface
  • Delete a WireGuard Interface
  • Retrieve a WireGuard Interfaces
  • List all WireGuard Peers
  • Create a WireGuard Peer
  • Delete the WireGuard Peer
  • Retrieve the WireGuard Peer
  • Update the WireGuard Peer
  • Retrieve Wireguard config template for Peer
• Reporting
  • Get all Wireless Detail Records (WDRs) Reports
  • Create a Wireless Detail Records (WDRs) Report
  • Delete a Wireless Detail Record (WDR) Report
  • Get a Wireless Detail Record (WDR) Report
• Wireless Regions
  • Get all wireless regions
• Object
  • ListObjectsV2
  • DeleteObjects
  • DeleteObject
  • GetObject
  • HeadObject
  • PutObject
• Schemas
  • Schemas
    • AIAssistantStartRequest
    • AI Assistant Stop Request
    • AWS Voice Settings
    • AcceptSuggestionsRequest
    • AccessIPAddressListResponseSchema
    • AccessIPAddressPOST
    • AccessIPAddressResponseSchema
    • AccessIPRangeListResponseSchema
    • AccessIPRangePOST
    • AccessIPRangeResponseSchema
    • AccountSid
    • ActionsParticipantsRequest
    • Active Call
    • Address
    • AddressCreate
    • AddressSuggestionResponse
    • AdvancedOrderRequest
    • AdvancedOrderResponse
    • AltBusinessIdType
    • AmdDetailRecord
    • Anchorsite Override
    • Answer Request
    • Application Name
    • AssignProfileToCampaignRequest
    • AssignProfileToCampaignResponse
    • AssignmentTaskStatusResponse
    • Assistant
    • AssistantChatReq
    • AssistantChatResponse
    • AssistantDeletedResponse
    • AssistantTools
    • AssistantsListData
    • AudioTranscriptionRequest
    • AudioTranscriptionResponse
    • AudioTranscriptionResponseSegments
    • Audit Event Changes
    • Audit Log Entry
    • Audit Log List
    • AuthenticationProvider
    • AuthenticationProviderCreate
    • AutoRechargePref
    • AutoRechargePrefRequest
    • AutoRespConfigCreateSchema
    • AutorespConfigResponseSchema
    • AutorespConfigSchema
    • AutorespConfigsResponseSchema
    • AvailablePhoneNumber
    • AvailablePhoneNumberBlock
    • AvailablePhoneNumbersMetadata
    • Available service
    • AwsAccessKeyId
    • AwsSecretAccessKey
    • AzureAccountKey
    • AzureAccountName
    • Azure Blob Storage Configuration Data
    • BackgroundTaskStatus
    • BackgroundTasksQueryResponse
    • BackgroundTasksQueryResponseData
    • BillingBundleResponse
    • BillingBundleSchema
    • BillingBundleSummary
    • BillingGroup
    • BookAppointmentTool
    • BookAppointmentToolParams
    • ListedBrand
    • BrandFeedback
    • BrandFeedbackCategory
    • BrandIdentityStatus
    • BrandOptionalAttributes
    • BrandRecordSetCSP
    • BrandRelationship
    • Bridge Request
    • Bucket
    • BucketAPIUsageResponse
    • BucketIds
    • HTTPValidationError
    • BucketOps
    • BucketOpsTotal
    • BucketUsage
    • BulkMessagingSettingsUpdatePhoneNumbers
    • BulkMessagingSettingsUpdatePhoneNumbersRequest
    • BulkSIMCardAction
    • BulkSIMCardActionDetailed
    • BundleLimitDirection
    • BundleLimitSchema
    • Call
    • Call AI Gather Ended
    • Call AI Gather Ended Event
    • Call AI Gather Message History Updated
    • Call AI Gather Message History Updated Event
    • Call AI Gather Partial Results
    • Call AI Gather Partial Results Event
    • Call Answered
    • Call Answered Event
    • Call Bridged
    • Call Bridged Event
    • Call Control Application
    • Call Control Application Inbound
    • Call Control Application Outbound
    • Call Control Command Result
    • Call Control Command Result With Recording ID
    • CallControlId
    • Call Cost Received Event
    • Call DTMF Received
    • Call DTMF Received Event
    • Call Enqueued
    • Call Enqueued Event
    • Call Event
    • Call Fork Started
    • Call Fork Started Event
    • Call Fork Stopped
    • Call Fork Stopped Event
    • CallForwarding
    • Call Gather Ended
    • Call Gather Ended Event
    • Call Hangup
    • Call Hangup Event
    • Call Initiated
    • Call Initiated Event
    • Call Left Queue
    • Call Left Queue Event
    • Call Machine Detection Ended
    • Call Machine Detection Ended Event
    • Call Machine Greeting Ended
    • Call Machine Greeting Ended Event
    • Call Machine Premium Detection Ended
    • Call Machine Premium Detection Ended Event
    • Call Machine Premium Greeting Ended
    • Call Machine Premium Greeting Ended Event
    • Call Playback Ended
    • Call Playback Ended Event
    • Call Playback Started
    • Call Playback Started Event
    • CallRecording
    • Call Recording Saved
    • Call Recording Saved Event
    • CallReferCompleted
    • Call Refer Completed Event
    • CallReferFailed
    • Call Refer Failed Event
    • Call Refer Started
    • Call Refer Started Event
    • Dial Request
    • Call resource
    • Multiple call resources
    • Siprec Failed
    • Siprec Failed Event
    • Siprec Started
    • Siprec Started Event
    • Siprec Stopped
    • Siprec Stopped Event
    • Call Speak Ended
    • Call Speak Ended Event
    • Call Speak Started
    • Call Speak Started Event
    • Streaming Failed
    • Streaming Failed Event
    • Streaming Started
    • Streaming Started Event
    • Streaming Stopped
    • Streaming Stopped Event
    • Call With Recording ID
    • CallbackWebhookMeta
    • CallerName
    • CampaignCost
    • CampaignDeletionResponse
    • CampaignRecordSet_CSP
    • CampaignRequest
    • CampaignSharingChain
    • CampaignSharingStatus
    • Campaign Status Update Event
    • Carrier
    • CdrGetSyncUsageReportResponse
    • CdrUsageReportResponse
    • ChatCompletionRequest
    • ChatCompletionResponseFormatParam
    • ChatCompletionSystemMessageParam
    • Function
    • CheckAvailabilityTool
    • CheckAvailabilityToolParams
    • Civic Address
    • Update client state Request
    • CloudflareSyncStatus
    • ClusterNode
    • ClusteringRequestInfo
    • ClusteringRequestInfoData
    • ClusteringStatusResponse
    • ClusteringStatusResponseData
    • CnamListing
    • Comment
    • OTAUpdate
    • Conference
    • Conference Command Result
    • Conference Created
    • Conference Created Event
    • ConferenceDetailRecord
    • Conference Ended
    • Conference Ended Event
    • Conference Floor Changed
    • Conference Hold Request
    • Conference Mute Request
    • ConferenceParticipantDetailRecord
    • Conference Participant Joined
    • Conference Participant Joined Event
    • Conference Participant Left
    • Conference Participant Left Event
    • Conference Participant Playback Ended
    • Conference Participant Playback Ended Event
    • Conference Participant Playback Started
    • Conference Participant Playback Started Event
    • Conference Participant Speak Ended
    • Conference Participant Speak Ended Event
    • Conference Participant Speak Started
    • Conference Participant Speak Started Event
    • Conference Play Request
    • Conference Playback Ended
    • Conference Playback Ended Event
    • Conference Playback Started
    • Conference Playback Started Event
    • Conference recording resource
    • Multiple conference recording resources
    • Conference Recording Saved
    • Conference Recording Saved Event
    • Conference resource
    • Multiple conference resources
    • ConferenceSid
    • Conference Speak Ended
    • Conference Speak Ended Event
    • Conference Speak Request
    • Conference Speak Started
    • Conference Speak Started Event
    • Conference Stop Request
    • Conference Unhold Request
    • Conference Unmute Request
    • Connection
    • Connection Active
    • Android Push Credential Id
    • ConnectionId
    • ConnectionIdCredentials
    • Ios Push Credential Id
    • Connection Name
    • Connection RTCP Settings
    • ConsumedData
    • Conversation
    • ConversationChannelType
    • ConversationInsight
    • ConversationInsightListData
    • ConversationMessage
    • ConversationMessageListData
    • ConversationsListData
    • CostInformation
    • CountryCoverage
    • Create Android Push Credential Request
    • CreateAssistantRequest
    • CreateBrand
    • CreateBucketRequest
    • Create Call Control Application Request
    • Create Conference Request
    • CreateConversationRequest
    • Create Credential Connection Request
    • Create External Connection Request
    • Create Upload Request
    • Create Fax Application Request
    • CreateFineTuningJobRequest
    • Create FQDN Connection Request
    • Create Fqdn Request
    • CreateGroupMMSMessageRequest
    • Create Inbound Ip Request
    • CreateIntegrationSecretRequest
    • Create iOS push credential request
    • Create IP Connection Request
    • Create Ip Request
    • CreateLongCodeMessageRequest
    • Create Managed Account Request
    • CreateMessageRequest
    • CreateMessagingHostedNumberOrderRequest
    • CreateMessagingProfileRequest
    • CreateNumberBlockOrderRequest
    • CreateNumberOrderRequest
    • CreateNumberPoolMessageRequest
    • CreateNumberReservationRequest
    • Outbound Voice Profile
    • CreatePortingOrder
    • CreatePortingOrderComment
    • CreateRoomClientTokenRequest
    • CreateRoomCompositionRequest
    • CreateRoomRequest
    • CreateScheduledEventRequest
    • CreateShortCodeMessageRequest
    • CreateSubNumberOrdersReportRequest
    • Create TeXML Secret request
    • Create TeXML Secret result
    • Create Texml Application Request
    • CreateUserBundlesBulkRequest
    • CreateVerificationRequestCall
    • CreateVerificationRequestFlashcall
    • CreateVerificationRequestSMS
    • CreateVerifyVerificationResponse
    • CreateVerifiedNumberResponse
    • CreateVerifyProfileCallRequest
    • CreateVerifyProfileFlashcallRequest
    • CreateVerifyProfileSMSRequest
    • Created At
    • CreatedUserBundlesResponse
    • CreatedVerificationCodesResponse
    • Credential Active
    • Credential Connection
    • Credential Inbound
    • Credential Outbound
    • Credentials
    • CredentialsResponse
    • CsvDownload
    • Cursor
    • Cursor Pagination Meta
    • Custom SIP Header
    • Custom Storage Configuration
    • CustomerServiceRecord
    • CustomerServiceRecordAdditionalData
    • CustomerServiceRecordPhoneNumberCoverage
    • CustomerServiceRecordStatusChangedEvent
    • DTMFTool
    • DateTimeRFC2822
    • DefaultGateway
    • DeleteObjectsRequest
    • DeleteObjectsResponse
    • Initiate Call Request
    • DetailRecord
    • DetailRecordsSearchResponse
    • Create Conference Participant Request
    • Dialogflow Config
    • Dialogflow Connection Params
    • Dialogflow Connection Response
    • Direction
    • DocReqsRequirement
    • DocReqsRequirementList
    • DocReqsRequirementType
    • DocReqsRequirementTypeList
    • DocServiceDocument
    • DocServiceDocumentLink
    • DocServiceRecord
    • DownlinkData
    • DTMF Type
    • DynamicEmergencyAddress
    • DynamicEmergencyEndpoint
    • SIMCardRegistration
    • ElevenLabs Voice Settings
    • EligibilityNumberResponse
    • EligibilityNumbersRequest
    • EligibilityNumbersResponse
    • EmbeddingBucketRequest
    • EmbeddingMetadata
    • EmbeddingResponse
    • EmbeddingSimilaritySearchDocument
    • EmbeddingSimilaritySearchRequest
    • EmbeddingSimilaritySearchResponse
    • EmbeddingUrlRequest
    • EmbeddingsBucketFiles
    • EmbeddingsBucketFilesData
    • EmergencySettings
    • EnabledFeatures
    • EncryptedMedia
    • Enqueue Request
    • EntityType
    • EnumListResponse
    • EnumObjectResponse
    • EnumPaginatedResponse
    • Error
    • ErrorRecord
    • ErrorResponse
    • Errors
    • EventStatus
    • ExportPortingOrdersCSVReport
    • ExportPortoutsCSVReport
    • External Connection
    • Phone number details with relation to an external connection
    • External SIP Connection
    • External SIP Connection
    • ExternalVetting
    • ExternalWdrDetailRecordDto
    • ExternalWdrGetDetailResponse
    • FailClusteringProcessRequest
    • Fax
    • Fax Application
    • FaxDelivered
    • Fax Email Recipient
    • FaxFailed
    • FaxId
    • FaxMediaProcessed
    • FaxQueued
    • FaxSendingStarted
    • Feature
    • FineTuningJob
    • FineTuningJobListData
    • First Command Timeout
    • First Command Timeout Secs
    • ForbiddenError
    • Fqdn
    • FQDN Connection
    • FqdnConnectionTransportProtocol
    • From
    • FunctionDefinition
    • Google Cloud Storage Configuration Data
    • Gather
    • Gather Using AI Request
    • Gather Using Audio Request
    • Gather Using Speak Request
    • Channel zone object
    • Phone Number object
    • GenericError
    • GetSubRequestByPortingOrder
    • GlobalIP
    • GlobalIPAllowedPort
    • GlobalIPHealthCheck
    • GlobalIPProtocol
    • GlobalIpAssignment
    • GlobalIpAssignmentHealthMetric
    • GlobalIpAssignmentUpdate
    • GlobalIpAssignmentUsageMetric
    • GlobalIpHealthCheckType
    • GlobalIpLatencyMetric
    • GlobalIpUsageMetric
    • Google transcription engine list of languages
    • Google transcription engine list of languages
    • HTTPValidationError
    • HandoffTool
    • HandoffToolParams
    • Hangup Request
    • HangupTool
    • HangupToolParams
    • HostedNumber
    • Id
    • ImportAssistantsRequest
    • ImportExternalVetting
    • ImportMetadata
    • Inbound FQDN
    • Inbound Ip
    • InboundMessage
    • InboundMessageEvent
    • InboundMessagePayload
    • Initiate Call Request
    • Initaite TeXML Call Result
    • InsightSettings
    • Int ID
    • IntegrationSecret
    • IntegrationSecretCreatedResponse
    • SecretsListData
    • Interface
    • InterfaceStatus
    • InterruptionSettings
    • InventoryCoverage
    • InventoryCoverageMetadata
    • Ip
    • Ip Connection
    • Join Conference Request
    • Leave Conference Request
    • Leave Queue Request
    • LedgerBillingGroupReport
    • ListAdvancedOrderResponse
    • ListBucketsResponse
    • ListObjectsResponse
    • ListPushCredentialsResponse
    • ListVerificationsResponse
    • ListVerifiedNumbersResponse
    • ListVerifyProfileMessageTemplateResponse
    • ListVerifyProfilesResponse
    • Location
    • LocationResponse
    • LogMessage
    • Loopcount
    • MMSFallback
    • ManagedAccount
    • ManagedAccountBalance
    • ManagedAccount
    • Managed Accounts Global Outbound Channels
    • MdrDeleteUsageReportsResponse
    • MdrDetailResponse
    • MdrGetDetailResponse
    • MdrGetSyncUsageReportResponse
    • MdrGetUsageReportsByIdResponse
    • MdrGetUsageReportsResponse
    • MdrPostUsageReportRequest
    • MdrPostUsageReportsResponse
    • MdrUsageRecord
    • MdrUsageReportResponse
    • MediaFeatures
    • MediaName
    • Media Resource
    • MediaStorageDetailRecord
    • MediaUrl
    • MessageDetailRecord
    • MessagingFeatureSet
    • MessagingHostedNumberOrder
    • MessagingProfile
    • MessagingProfileDetailedMetric
    • MessagingProfileDetailedMetrics
    • MessagingProfileHighLevelMetrics
    • MessagingProfileMessageTypeMetrics
    • MessagingSettings
    • MessagingUrlDomain
    • Meta
    • MetaResponse
    • Metadata
    • MigrationParams
    • MigrationSourceCoverageParams
    • MigrationSourceParams
    • MnoMetadata
    • MnoMetadataItem
    • MobileNetworkOperator
    • MobileNetworkOperatorPreferencesResponse
    • MobileNetworkOperatorsPreferencesResponse
    • ModelMetadata
    • ModelsResponse
    • Monochrome
    • Network
    • NetworkCoverage
    • NetworkCreate
    • NetworkInterface
    • NewBillingGroup
    • NewLedgerBillingGroupReport
    • New participant resource
    • Noise Suppression Direction
    • Noise Suppression Start Request
    • Noise Suppression Stop Request
    • NotFoundError
    • NotificationChannel
    • NotificationEvent
    • NotificationEventCondition
    • NotificationProfile
    • NotificationSetting
    • NumberBlockOrder
    • NumberHealthMetrics
    • NumberLookup
    • Number Order With Phone Numbers
    • Number Order Event
    • NumberOrderPhoneNumber
    • NumberOrderPhoneNumberRequirementGroupResponse
    • NumberOrder
    • NumberPoolSettings
    • NumberReservation
    • OptOutItem
    • OptOutListResponse
    • OrderExternalVetting
    • OriginalMediaUrl
    • OutboundCallRecording
    • Connection Outbound Settings
    • Outbound Ip
    • OutboundMessage
    • OutboundMessageEvent
    • OutboundMessagePayload
    • Outbound Voice Profile
    • Outbound Voice Profile ID
    • PWGAssignedResourcesSummary
    • PaginatedBillingBundlesResponse
    • PaginatedScheduledEventList
    • PaginatedUserBundlesResponse
    • Paginated[VerificationRequestStatus]
    • PaginationData
    • PaginationMeta
    • PaginationMetaSimple
    • PaginationResponse
    • Participant
    • Participant resource
    • Multiple participant resources
    • PatchRoomRequest
    • Pause Recording Request
    • Pause Recording Request
    • PhoneNumberBlocksJob
    • PhoneNumberBlocksJobDeletePhoneNumberBlockRequest
    • PhoneNumberBlocksJobFailedOperation
    • PhoneNumberBlocksJobSuccessfulOperation
    • PhoneNumberBundleStatusChangeRequest
    • PhoneNumberCampaign
    • PhoneNumberCampaignCreate
    • PhoneNumberCampaignPaginated
    • PhoneNumberDeletedDetailed
    • PhoneNumberDetailed
    • PhoneNumberEnableEmergencyRequest
    • PhoneNumberStatusResponsePaginated
    • PhoneNumberWithMessagingSettings
    • PhoneNumberWithVoiceSettings
    • PhoneNumbersJob
    • PhoneNumbersJobDeletePhoneNumbersRequest
    • PhoneNumbersJobFailedOperation
    • PhoneNumbersJobPendingOperation
    • PhoneNumbersJobPhoneNumber
    • PhoneNumbersJobSuccessfulOperation
    • PhoneNumbersJobUpdateEmergencySettingsRequest
    • PhoneNumbersJobUpdatePhoneNumbersRequest
    • Play Audio URL Request
    • PlayBeep
    • Playback Stop Request
    • PortOutSupportingDocument
    • Portability
    • PortabilityCheckDetails
    • PortabilityStatus
    • PortingAdditionalDocument
    • PortingEvent
    • PortingLOAConfiguration
    • PortingOrder
    • PortingOrderActivationSettings
    • PortingOrderActivationStatus
    • PortingOrderDocuments
    • PortingOrderEndUser
    • PortingOrderEndUserAdmin
    • PortingOrderEndUserLocation
    • PortingOrderMessaging
    • PortingOrderMisc
    • PortingOrderPhoneNumberConfiguration
    • PortingOrderRequirement
    • PortingOrderRequirementDetail
    • PortingOrderSharingToken
    • PortingOrderStatus
    • PortingOrderType
    • PortingOrderUserFeedback
    • PortingOrdersActivationJob
    • PortingOrdersAllowedFocWindow
    • PortingOrdersComment
    • PortingOrdersExceptionType
    • PortingPhoneNumber
    • PortingPhoneNumberBlock
    • PortingPhoneNumberConfiguration
    • PortingPhoneNumberExtension
    • PortingReport
    • PortingVerificationCode
    • PortoutComment
    • PortoutDetails
    • PortoutEvent
    • PortoutRejection
    • PortoutReport
    • PresignedObjectUrl
    • PresignedObjectUrlParams
    • PrivacySettings
    • PrivateWirelessGateway
    • PrivateWirelessGatewayStatus
    • ProfileAssignmentPhoneNumbers
    • PublicInternetGateway
    • PublicInternetGatewayCreate
    • PublicInternetGatewayRead
    • PublicTextClusteringRequest
    • Successful response with details about a push credential
    • PushCredentialResponse
    • Quality
    • Queue
    • QueueCall
    • RCSAction
    • RCSAgent
    • RCSAgentMessage
    • RCSAgentResponse
    • RCSAgentUpdate
    • RCSAgentsResponse
    • RCSCardContent
    • RCSCarouselCard
    • RCSComposeAction
    • RCSComposeRecordingMessage
    • RCSComposeTextMessage
    • RCSContentInfo
    • RCSContentMessage
    • RCSCreateCalendarEventAction
    • RCSDialAction
    • RCSEvent
    • RCSFrom
    • RCSLatLng
    • RCSMedia
    • RCSMessage
    • RCSOpenUrlAction
    • RCSReply
    • RCSResponse
    • RCSRichCard
    • RCSShareLocationAction
    • RCSStandaloneCard
    • RCSSuggestion
    • RCSTo
    • RCSToItem
    • RCSViewLocationAction
    • Record
    • RecordType
    • RecordingResponse
    • RecordingResponseData
    • RecordingSource
    • RecordingStatusCallbackEvent
    • RecordingTrack
    • RecordingTranscriptionsResponseData
    • RecursiveCluster
    • Refer request
    • RefreshRoomClientTokenRequest
    • Region
    • RegionIn
    • RegionInformation
    • RegionOut
    • RegulatoryRequirement
    • RegulatoryRequirements
    • RegulatoryRequirementsPhoneNumbers
    • Reject Request
    • Phone Number Release
    • ReplacedLinkClick
    • ReplacedLinkClickEvent
    • RequirementGroup
    • ReservedPhoneNumber
    • Resource not found
    • Pause Recording Request
    • Resume Recording Request
    • Retrieval
    • RetrievalTool
    • RetrieveVerificationResponse
    • Room
    • RoomComposition
    • RoomParticipant
    • RoomRecording
    • RoomSession
    • AWS S3 Storage Configuration Data
    • SIMCard
    • SIMCardAction
    • SIMCardActionsSummary
    • SIMCardActivationCode
    • SIMCardDeviceDetails
    • SIMCardGroup
    • SIMCardGroupAction
    • SIMCardGroupCreate
    • SIMCardGroupPatch
    • SIMCardOrder
    • SIMCardOrderPreview
    • SIMCardPublicIP
    • SIMCardRegistration
    • SIMCardRegistrationCodeValidation
    • SIMCardRegistrationCodeValidations
    • SIMCardStatus
    • SIPReferTool
    • SIPReferToolParams
    • SMSFallback
    • SSLCertificate
    • ScheduledEventResponse
    • ScheduledPhoneCallEventResponse
    • ScheduledSmsEventResponse
    • SIMCardGroup
    • Send DTMF Request
    • Send fax multipart request
    • Send fax request
    • SendRecordingUrl
    • Send SIP Info Request
    • ServicePlan
    • SettingsDataErrorMessage
    • SharedCampaign
    • SharedCampaignRecordSet
    • ShortCode
    • SimCardDataUsageNotification
    • SimCardOrderCreate
    • SimCardUsageDetailRecord
    • SIMCard
    • OTAUpdate
    • Global Outbound Channels Details for a Managed Account
    • SIP Header
    • SIPREC connector configuration
    • SIPREC Connector Response
    • SlimPhoneNumberDetailed
    • Sound modifications
    • SourceResponse
    • Speak Request
    • Start Conference Recording Request
    • Start Forking Request
    • Start Recording Request
    • Start Siprec Request
    • Start Streaming Request
    • StockExchange
    • Stop Forking Request
    • Stop Gather Request
    • Stop Recording Request
    • Stop Siprec Request
    • Stop Streaming Request
    • StoreMedia
    • StorePreview
    • Bidirectional Stream Codec
    • Bidirectional Stream Mode
    • Bidirectional Stream Sampling Rate
    • Bidirectional Stream Target Legs
    • StreamCodec
    • StreamName
    • StreamStatus
    • StreamTrack
    • SubNumberOrder
    • SubNumberOrderPhoneNumber
    • SubNumberOrderRegulatoryRequirement
    • SubNumberOrderRegulatoryRequirementWithValue
    • SubNumberOrderRequirementGroupResponse
    • SubNumberOrdersReport
    • SummaryRequest
    • SummaryResponse
    • SummaryResponseData
    • SupportedEmbeddingLoaders
    • SupportedEmbeddingModels
    • T38Enabled
    • PhoneNumber
    • VerificationRequest
    • VerificationStatus
    • TaskStatus
    • TaskStatusResponse
    • On-demand Credential
    • TelephonyCredentialCreateRequest
    • TelephonyCredentialUpdateRequest
    • TelephonySettings
    • TelnyxBrand
    • TelnyxBrandWithCampaignsCount
    • TelnyxCampaignWithAssignedCount_CSP
    • TelnyxCampaign_CSP
    • TelnyxDownstreamCampaign
    • TelnyxDownstreamCampaignRecordSet
    • Telnyx transcription engine list of languages
    • Telnyx Voice Settings
    • TestWebhookToolRequest
    • TestWebhookToolResponse
    • TestWebhookToolResponseData
    • Texml Application
    • Stream Bidirectional Codec
    • Stream Bidirectional Mode
    • Texml Create Call Recording Request Body
    • Texml Create Call Recording Response Body
    • Texml Create Call Streaming Request Body
    • Texml Create Call Streaming Response Body
    • Create Siprec Session Request
    • Create Siprec Session Response
    • TexmlErrorCode
    • Texml Get Call Recording Response Body
    • Multiple recording resources
    • TexmlPriceUnit
    • TexmlRecordingChannels
    • TexmlRecordingDuration
    • TexmlRecordingMediaUrl
    • TexmlRecordingPrice
    • TexmlRecordingStatus
    • Texml recording subresources uris
    • Texml Get Call Recording Transcription Response Body
    • TexmlSid
    • TexmlStatusCallback
    • TexmlStatusCallbackMethod
    • Stream destination URL
    • Texml Create Call Recording Request Body
    • Texml Update Call Streaming Request Body
    • Texml Update Call Streaming Response Body
    • Update Siprec Session Request
    • Update Siprec Session Response
    • TextClusteringResponse
    • TextClusteringResponseData
    • TnReleaseEntry
    • TnUploadEntry
    • To
    • ToNumber
    • TrafficType
    • Transcription
    • TranscriptionConfig
    • Transcription engine A config
    • Transcription engine B config
    • Transcription Event
    • TranscriptionSettings
    • Transcription start request
    • Transcription stop request
    • Transfer Call Request
    • TransferTool
    • TransferToolParams
    • TwimlRecordingChannels
    • UUID
    • UnauthorizedError
    • UnexpectedError
    • UnprocessableEntityError
    • UnusedUserBundlesResponse
    • UnusedUserBundlesSchema
    • UpdateAssistantRequest
    • Update Authentication Provider Request
    • UpdateBillingGroup
    • UpdateBrand
    • Update Call Control Application Request
    • Update Call Request
    • UpdateCampaignRequest
    • TeXml REST Update Command Result
    • Update Conference Participant Request
    • Update Conference Request
    • UpdateConversationRequest
    • Update Credential Connection Request
    • Update External Connection Phone Number Request
    • Update External Connection Request
    • Update Fax Application Request
    • Update FQDN Connection Request
    • Update FQDN Request
    • Update Ip Connection Request
    • Update Ip Request
    • Update Managed Account Global Outbound Channels Request
    • Update Managed Account Request
    • Upload media multipart request
    • Upload media request
    • UpdateMessagingProfileRequest
    • UpdateNumberOrderPhoneNumberRequest
    • UpdateNumberOrderRequest
    • Outbound Voice Profile
    • UpdateCampaignRequest
    • UpdatePhoneNumberMessagingSettingsRequest
    • UpdatePhoneNumberRequest
    • UpdatePhoneNumberVoiceSettingsRequest
    • UpdatePortingOrder
    • UpdatePortingOrderRequirement
    • UpdateRegulatoryRequirement
    • UpdateShortCodeRequest
    • UpdateSubNumberOrderRequest
    • Update Texml Application Request
    • UpdateVerifyProfileCallRequest
    • UpdateVerifyProfileFlashcallRequest
    • UpdateVerifyProfileSMSRequest
    • Updated At
    • UplinkData
    • Upload
    • UploadFileMessagingHostedNumberOrderRequest
    • Upload media multipart request
    • Upload media request
    • Url
    • UrlShortenerSettings
    • UsagePaymentMethod
    • UsageReportsOptionsRecord
    • UsageReportsOptionsResponse
    • UsageReportsResponse
    • UseCaseCategories
    • UsecaseMetadata
    • UserAddress
    • UserAddressCreate
    • UserBalance
    • UserBundle
    • UserBundleCreateRequest
    • UserBundleCreateResponse
    • UserBundleResourceSchema
    • UserBundleResourcesResponse
    • UserBundleResponse
    • UserBundleSummary
    • UserEmbeddedBuckets
    • UserEmbeddedBucketsData
    • UserId
    • UserRequirement
    • UserTagList
    • ValidateAddressField
    • ValidateAddressRequest
    • Validate address action result
    • ValidationCodes
    • ValidationCodesRequest
    • ValidationError
    • Verification
    • VerificationCodesRequest
    • VerificationProfileRecordType
    • VerificationRecordType
    • VerificationRequestEgress
    • VerificationRequestStatus
    • VerificationStatus
    • VerificationType
    • VerifiedNumberRecordType
    • VerifiedNumberResponse
    • VerifiedNumberResponseDataWrapper
    • VerifyDetailRecord
    • VerifyProfileCallResponse
    • VerifyProfileFlashcallResponse
    • VerifyProfileResponse
    • VerifyProfileResponse
    • VerifyProfileResponseDataWrapper
    • VerifyProfileSMSResponse
    • VerifyVerificationCodeRequestById
    • VerifyVerificationCodeRequestByPhoneNumber
    • VerifyVerificationCodeResponse
    • Vertical
    • VideoRegion
    • VirtualCrossConnect
    • VirtualCrossConnectCombined
    • VirtualCrossConnectCoverage
    • VirtualCrossConnectCreate
    • VirtualCrossConnectPatch
    • VoiceConfig
    • VoiceSettings
    • VoicemailPrefResponse
    • VoicemailRequest
    • Volume
    • WdrReport
    • WdrReportRequest
    • Webhook API Version
    • Webhook Event Failover URL
    • Webhook Event URL
    • WebhookPortingOrderDeletedPayload
    • WebhookPortingOrderMessagingChangedPayload
    • WebhookPortingOrderNewCommentPayload
    • WebhookPortingOrderSplitPayload
    • WebhookPortingOrderStatusChangedPayload
    • WebhookPortoutFocDateChangedPayload
    • WebhookPortoutNewCommentPayload
    • WebhookPortoutStatusChangedPayload
    • Webhook Timeout Secs
    • WebhookTool
    • WebhookToolParams
    • WireguardInterface
    • WireguardInterfaceCreate
    • WireguardInterfaceRead
    • WireguardPeer
    • WireguardPeerCreate
    • WireguardPeerPatch
    • WirelessConnectivityLog
    • WirelessCost
    • WirelessRate
    • active
    • address_book
    • administrative_area
    • attempt
    • borough
    • business_name
    • Call Conversation Ended
    • Call Conversation Ended Event
    • Call Conversation Insights Generated
    • Call Conversation Insights Generated Event
    • Call Recording Error
    • Call Recording Error Event
    • Call Recording Transcription Saved
    • Call Recording Transcription Saved Event
    • country_code
    • customer_reference
    • extended_address
    • first_name
    • http
    • http_headers
    • last_name
    • locality
    • name
    • neighborhood
    • organization_id
    • phone_number
    • postal_code
    • settings
    • settings_url
    • short_name
    • skip_address_verification
    • street_address
    • validate_address
    • webhook_delivery
  • Response
    • ActionSuccessResponse
    • Active Calls Response
    • AddressResponse
    • AuditLogListResponse
    • AutoRechargePrefResponse
    • BadRequestResponse
    • Bulk Room Recordings Delete Response
    • Retrieve bulk update messaging settings Response
    • BulkSIMCardActionCollectionResponse
    • BulkSIMCardActionDetailedResponse
    • BulkSIMCardActionResponse
    • Call Control Application Response
    • Call Control Command Response
    • Call Control Command Response With Recording ID
    • Successful response upon accepting cancel fax command
    • CancelPortingOrderResponse
    • CommentResponse
    • Conference Command Response
    • Conference Response
    • ConfirmPortingOrderResponse
    • Connection Response
    • CountryCoverageResponse
    • CreateCustomerServiceRecord
    • CreatePortOutSupportingDocumentsResponse
    • CreatePortingAdditionalDocuments
    • CreatePortingLOAConfiguration
    • CreatePortingPhoneNumberConfigurations
    • CreatePortingReport
    • CreatePortoutReport
    • CreatePrivateWirelessGatewayResponse
    • CreateRoomClientTokenResponse
    • CreateRoomCompositionResponse
    • CreateRoomResponse
    • CreateSimCardDataUsageNotificationResponse
    • CreateSimCardGroupResponse
    • CreateSimCardOrderResponse
    • Create TeXML Secret request
    • CreateWdrReportResponse
    • Credential Connection Response
    • CredentialsResponseBody
    • CSV Download Response
    • DefaultGatewayResponse
    • Phone Number Response
    • DeletePrivateWirelessGatewayResponse
    • DeleteSimCardDataUsageNotificationResponse
    • DeleteSimCardGroupResponse
    • DeleteSimCardResponse
    • DeleteWdrReportResponse
    • Initiate TeXML Call Response
    • DialParticipantResponse
    • DialogflowConnectionResponseBody
    • DynamicEmergencyAddressResponse
    • DynamicEmergencyEndpointResponse
    • External Connection Response
    • Fax Application Response
    • Forbidden
    • ForbiddenErrorResponse
    • FQDN Connection Response
    • ForbiddenResponse
    • FQDN Response
    • GenericErrorResponse
    • GetAllAddressResponse
    • Get All Civic Addresses Response
    • Get All External Connections Response
    • Get All Fax Applications Response
    • GetAllPrivateWirelessGatewaysResponse
    • GetAllSimCardGroupsResponse
    • GetAllSimCardOrdersResponse
    • Get All Telephony Credential Response
    • Get All Texml Applications Response
    • GetAllUserAddressResponse
    • GetCallResponse
    • GetCallsResponse
    • Get Civic Address Response
    • GetConferenceRecordingsResponse
    • GetConferenceResponse
    • GetConferencesResponse
    • Get External Connection Phone Number Response
    • Get Fax Response
    • GetGcbChannelZoneRequestResponse
    • GetGcbChannelZonesRequestResponse
    • GetGcbNumbersResponse
    • GetGcbPhoneNumbersRequestResponse
    • Get Log Message Response
    • GetParticipantResponse
    • GetParticipantsResponse
    • GetPrivateWirelessGatewayResponse
    • Get Release Response
    • GetRoomCompositionResponse
    • GetRoomParticipantResponse
    • GetRoomRecordingResponse
    • GetRoomResponse
    • GetRoomSessionResponse
    • GetSimCardDataUsageNotificationResponse
    • GetSimCardGroupResponse
    • GetSimCardOrderResponse
    • GetSimCardResponse
    • Get Upload Response
    • Get Uploads Status Response
    • GetWdrReportResponse
    • GetWdrReportsResponse
    • GlobalIpAllowedPortListResponse
    • GlobalIpAssignmentListResponse
    • GlobalIpAssignmentResponse
    • GlobalIpAssignmentUsageResponse
    • GlobalIpHealthCheckListResponse
    • GlobalIpHealthCheckResponse
    • GlobalIpHealthCheckTypesResponse
    • GlobalIpHealthResponse
    • GlobalIpLatencyResponse
    • GlobalIpListResponse
    • GlobalIpProtocolListResponse
    • GlobalIpResponse
    • GlobalIpUsageResponse
    • InitiateCallResponse
    • InventoryCoverageResponse
    • Ip Connection Response
    • Ip Response
    • ListAllowedFocWindows
    • List Available Phone Numbers Blocks Response
    • List Available Phone Numbers Response
    • List Call Control Applications Response
    • List Call Events Response
    • List Conferences Response
    • List Connections Response
    • List Credential Connections Response
    • List CSV Downloads Response
    • ListCustomerServiceRecordPhoneNumberCoverage
    • ListCustomerServiceRecords
    • ListDraftPortingOrdersWithoutPagination
    • List External Connection Phone Numbers Response
    • List Faxes Response
    • List FQDN Connections Response
    • List FQDNs Response
    • List Ip Connections Response
    • List Ips Response
    • List Log Messages Response
    • ListManagedAccountsAllocatableGlobalOutboundChannelsResponse
    • ListManagedAccountsResponse
    • List of media resources response
    • List Messaging Hosted Number Order Response
    • List Messaging Profile Metrics Response
    • List Messaging Profile Phone Numbers Response
    • List Messaging Profile Short Codes Response
    • List Messaging Profiles Response
    • List Messaging Profile Url Domains Response
    • List Number Block Orders Response
    • List Number Order Phone Numbers Response
    • List Number Orders Response
    • List Number Reservations Response
    • List Outbound Voice Profiles Response
    • List Participants Response
    • List Phone Number Blocks Background Jobs Response
    • List Phone Numbers Background Jobs Response
    • List Phone Numbers Response
    • List Messaging Settings Response
    • List Phone Numbers With Voice Settings Response
    • ListPortingAdditionalDocuments
    • ListPortingEventsResponse
    • ListPortingLOAConfigurations
    • ListPortingOrder
    • ListPortingOrderRequirements
    • ListPortingOrdersActivationJobs
    • ListPortingOrdersComments
    • ListPortingOrdersExceptionTypes
    • ListPortingPhoneNumberBlocks
    • ListPortingPhoneNumberConfigurations
    • ListPortingPhoneNumberExtensions
    • ListPortingPhoneNumbers
    • ListPortingReports
    • ListPortingVerificationCodes
    • ListPortoutComments
    • ListPortoutEventsResponse
    • ListPortoutRejections
    • ListPortoutReports
    • ListPortoutResponse
    • List Queue Calls Response
    • ListRecordingTranscriptionsResponse
    • List Releases Response
    • ListRoomCompositionsResponse
    • ListRoomParticipantsResponse
    • ListRoomRecordingsResponse
    • ListRoomSessionsResponse
    • ListRoomsResponse
    • List Short Codes Response
    • List Sub Number Orders Response
    • List Uploads Response
    • ListUserTagsResponse
    • ListWebhookDeliveriesResponse
    • ManagedAccountResponse
    • MediaDownloadResponse
    • Media resource response
    • Message Response
    • Retrieve Messaging Hosted Number Order Response
    • Retrieve Messaging Hosted Number Response
    • Messaging Profile Response
    • NetworkCoverageListResponse
    • NetworkInterfaceListResponse
    • NetworkListResponse
    • NetworkResponse
    • NotFoundErrorResponse
    • NotFoundResponse
    • NotFoundResponseApp
    • Number Block Order Response
    • Number Lookup Response
    • Number Order Phone Number Response
    • Number Order Response
    • Number Reservation Response
    • OTAUpdateResponse
    • Outbound Voice Profile Response
    • PatchGcbChannelZoneRequestResponse
    • PatchRoomResponse
    • Phone Number Response
    • Retrieve Messaging Settings Response
    • Retrieve Phone Number Voice Response
    • PortOutListSupportingDocumentsResponse
    • PortabilityCheckResponse
    • PortoutCommentResponse
    • PortoutResponse
    • PostGcbPhoneNumberRequestResponse
    • PublicInternetGatewayListResponse
    • PublicInternetGatewayResponse
    • Queue Call Response
    • Queue Response
    • ReadCommentResponse
    • RecordingResponseBody
    • RecordingTranscriptionResponse
    • RecordingsResponseBody
    • Refresh Fax Response
    • RefreshRoomClientTokenResponse
    • RegionListResponse
    • RegisterSimCardsResponse
    • Registration Status Response
    • ResourceNotFound
    • ResourceNotFoundErrorResponse
    • Retrieve Call Status Response
    • Retrieve Call Status Response With Recording ID
    • Retrieve Messaging Profile Metrics Response
    • SIMCardActionResponse
    • SIMCardActivationCodeResponse
    • SIMCardDeviceDetailsResponse
    • SIMCardGroupActionResponse
    • SIMCardOrdersPreviewResponse
    • SIMCardPublicIPResponse
    • SearchMobileNetworkOperatorsResponse
    • SearchOTAUpdateResponse
    • SearchSimCardsResponse
    • Send Fax Response
    • SharePortingOrder
    • Short Code Response
    • ShowCustomerServiceRecord
    • ShowPortingEventResponse
    • ShowPortingLOAConfiguration
    • ShowPortingOrder
    • ShowPortingOrdersActivationJob
    • ShowPortingOrdersComment
    • ShowPortingPhoneNumber
    • ShowPortingPhoneNumberBlock
    • ShowPortingPhoneNumberExtension
    • ShowPortingReport
    • ShowPortoutEventResponse
    • ShowPortoutReport
    • SimCardActionCollectionResponse
    • SimCardDataUsageNotificationCollectionResponse
    • SimCardGroupActionCollectionResponse
    • SinglePhoneNumberCampaign
    • SiprecConnectorResponseBody
    • List Phone Numbers Response
    • SpecificCountryResponse
    • Sub Number Order Response
    • SubNumberOrdersReportResponse
    • SubRequestByPortingOrder
    • Telephony Credential Response
    • Texml Application Response
    • TexmlCreateCallRecordingResponse
    • TexmlCreateCallStreamingResponse
    • TexmlCreateSiprecSessionResponse
    • TexmlGetCallRecordingResponse
    • TexmlGetCallRecordingsResponse
    • Recording Transcription Response
    • List Recording Transcriptions Response
    • TexmlUpdateCallStreamingResponse
    • TexmlUpdateSiprecSessionResponse
    • UnauthenticatedResponse
    • UnauthorizedErrorResponse
    • UnauthorizedRequestErrorResponse
    • UnexpectedErrorResponse
    • UnprocessableEntity
    • UnprocessableEntityErrorResponse
    • UnprocessableManagedAccountEntity
    • UpdateManagedAccountGlobalChannelLimitResponse
    • UpdatePortingLOAConfiguration
    • UpdatePortingOrderResponse
    • UpdateSimCardDataUsageNotificationResponse
    • UpdateSimCardGroupResponse
    • UpdateSimCardResponse
    • TeXML REST Command Response
    • UserAddressResponse
    • UserBalanceResponse
    • Validate address action response
    • Retrieve Messaging Hosted Number Response
    • VerifyPortingVerificationCodes
    • VirtualCrossConnectCoverageListResponse
    • VirtualCrossConnectListResponse
    • VirtualCrossConnectResponse
    • VoicemailResponse
    • WireguardInterfaceListResponse
    • WireguardInterfaceResponse
    • WireguardPeerListResponse
    • WireguardPeerResponse
    • WirelessConnectivityLogCollectionResponse
    • listCommentsResponse
    • listDynamicEmergencyAddresses
    • listDynamicEmergencyEndpoints
    • listRegulatoryRequirements
    • listRegulatoryRequirementsPhoneNumbers
  • RequestBodies
    • CreateCustomerServiceRecord
    • CreatePortingAdditionalDocuments
    • CreatePortingLOAConfiguration
    • CreatePortingPhoneNumberBlock
    • CreatePortingPhoneNumberConfigurations
    • CreatePortingPhoneNumberExtension
    • CreatePortingReport
    • CreatePortoutReport
    • DeleteRecordingsRequest
    • SendPortingVerificationCodes
    • SharePortingOrder
    • UpdatePortingOrdersActivationJob
    • VerifyCustomerServiceRecordPhoneNumberCoverage
    • VerifyPortingVerificationCodes

Copy Page

HandoffTool(HandoffTool)

The handoff tool allows the assistant to hand off control of the conversation to another AI assistant. By default, this will happen transparently to the end user.

{
    "handoff": {
        "ai_assistants": [
            {
                "id": "assistant-1234567890abcdef",
                "name": "Scheduling Specialist"
            }
        ]
    },
    "type": "handoff"
}