Telnyx Call Commands API
Call Control command operations
Telnyx Call Commands API is one of 168 APIs that Telnyx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Call Commands. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 39 operations across 39 paths, and defines 111 schemas. It is described by OpenAPI 3.1.0, at version 2.0.0.
Requests are made against a single base URL, https://api.telnyx.com/v2.
39 operations
39 paths
111 schemas
38 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 6
Telnyx Call Commands API declares
6 security schemes
for authenticating requests.
It accepts HTTP bearer tokens (bearerAuth).
It accepts HTTP bearer tokens (branded-calling_bearerAuth).
It supports OAuth 2.0 (oauthClientAuth) using the authorizationCode and clientCredentials flows, exposing 1 scope.
It accepts HTTP bearer tokens (JWT) (outbound-voice-profiles_bearerAuth).
It accepts HTTP bearer tokens (pronunciation-dicts_bearerAuth).
It accepts HTTP bearer tokens (JWT) (stored-payment-transactions_bearerAuth).
By default, every request must be authenticated.
branded-calling_bearerAuth— API key passed as a Bearer token in the Authorization headeroauthClientAuth— OAuth 2.0 authentication for Telnyx API and MCP integrationspronunciation-dicts_bearerAuth— Telnyx API v2 key. Obtain from https://portal.telnyx.com
Paths & Operations 39
Across 39 paths, the API surfaces 39 operations — 38 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Call Commands 39
Call Control command operations
POST
/calls
Dial
POST
/calls/{call_control_id}/actions/ai_assistant_add_messages
Add messages to AI Assistant
POST
/calls/{call_control_id}/actions/ai_assistant_join
Join AI Assistant Conversation
POST
/calls/{call_control_id}/actions/ai_assistant_start
Start AI Assistant
POST
/calls/{call_control_id}/actions/ai_assistant_stop
Stop AI Assistant
POST
/calls/{call_control_id}/actions/answer
Answer call
POST
/calls/{call_control_id}/actions/bridge
Bridge calls
PUT
/calls/{call_control_id}/actions/client_state_update
Update client state
POST
/calls/{call_control_id}/actions/enqueue
Enqueue call
POST
/calls/{call_control_id}/actions/fork_start
Forking start
POST
/calls/{call_control_id}/actions/fork_stop
Forking stop
POST
/calls/{call_control_id}/actions/gather
Gather
POST
/calls/{call_control_id}/actions/gather_stop
Gather stop
POST
/calls/{call_control_id}/actions/gather_using_ai
Gather using AI
POST
/calls/{call_control_id}/actions/gather_using_audio
Gather using audio
POST
/calls/{call_control_id}/actions/gather_using_speak
Gather using speak
POST
/calls/{call_control_id}/actions/hangup
Hangup call
POST
/calls/{call_control_id}/actions/leave_queue
Remove call from a queue
POST
/calls/{call_control_id}/actions/playback_start
Play audio URL
POST
/calls/{call_control_id}/actions/playback_stop
Stop audio playback
POST
/calls/{call_control_id}/actions/record_pause
Record pause
POST
/calls/{call_control_id}/actions/record_resume
Record resume
POST
/calls/{call_control_id}/actions/record_start
Recording start
POST
/calls/{call_control_id}/actions/record_stop
Recording stop
POST
/calls/{call_control_id}/actions/refer
SIP Refer a call
POST
/calls/{call_control_id}/actions/reject
Reject a call
POST
/calls/{call_control_id}/actions/send_dtmf
Send DTMF
POST
/calls/{call_control_id}/actions/send_sip_info
Send SIP info
POST
/calls/{call_control_id}/actions/siprec_start
SIPREC start
POST
/calls/{call_control_id}/actions/siprec_stop
SIPREC stop
POST
/calls/{call_control_id}/actions/speak
Speak text
POST
/calls/{call_control_id}/actions/streaming_start
Streaming start
POST
/calls/{call_control_id}/actions/streaming_stop
Streaming stop
POST
/calls/{call_control_id}/actions/suppression_start
Noise Suppression Start (BETA)
POST
/calls/{call_control_id}/actions/suppression_stop
Noise Suppression Stop (BETA)
POST
/calls/{call_control_id}/actions/switch_supervisor_role
Switch supervisor role
POST
/calls/{call_control_id}/actions/transcription_start
Transcription start
POST
/calls/{call_control_id}/actions/transcription_stop
Transcription stop
POST
/calls/{call_control_id}/actions/transfer
Transfer call
Schemas 111
The contract defines 111 schemas that model the data the API accepts and returns. The most detailed are CallRequest (60 properties), TransferCallRequest (38 properties), AnswerRequest (31 properties), BridgeRequest (20 properties). Each schema is shown below with its type and property counts.
Assistant
object
Assistant configuration including choice of LLM, custom instructions, and tools.
4 properties
StartSiprecRequest
object
7 properties
TranscriptionEngineXaiConfig
object
4 properties
DeepgramNova3Config
object
6 properties
2 required
NoiseSuppressionStart
object
5 properties
PauseRecordingRequest
object
3 properties
AnswerRequest
object
31 properties
DeepgramNova2Config
object
6 properties
2 required
ElevenLabsVoiceSettings
object
2 properties
1 required
AWSVoiceSettings
object
1 property
1 required
MessageMetadata
object
Metadata to add to the message
TranscriptionEngineBConfig
object
3 properties
TransferTool
object
2 properties
2 required
TranscriptionStartRequest
object
5 properties
CallWithRecordingId
object
10 properties
5 required
StreamCodec
string
Specifies the codec to be used for the streamed audio. When set to 'default' or when transcoding is not possible, the codec from the call will be used.
call-control_Error
object
5 properties
2 required
ToolCall
object
A call to a function tool created by the model.
3 properties
3 required
VoiceConfig
string
The voice to be used by the voice assistant. Currently we support ElevenLabs, Telnyx and AWS voices. Supported Providers: - AWS: Use AWS.Polly. (e.g., AWS.Poll…
CallControlRetrievalTool
object
2 properties
2 required
WebhookTool
object
2 properties
2 required
LeaveQueueRequest
object
2 properties
PlaybackStopRequest
object
4 properties
UserMessage
object
Messages sent by an end user
3 properties
2 required
CallRequest
object
60 properties
3 required
AzureTranscriptionRegion
string
Azure region to use for speech recognition
SwitchSupervisorRoleRequest
object
1 property
1 required
PlayAudioUrlRequest
object
11 properties
CallControlBucketIds
object
2 properties
1 required
CheckAvailabilityTool
object
2 properties
2 required
NoiseSuppressionEngine
string
The engine to use for noise suppression. For backward compatibility, engines A, B, C, and D are also supported, but are deprecated: A - Denoiser B - DeepFilter…
CustomSipHeader
object
2 properties
2 required
AIAssistantAddMessagesRequest
object
3 properties
SendSIPInfoRequest
object
4 properties
2 required
SpeakRequest
object
11 properties
2 required
AzureVoiceSettings
object
6 properties
1 required
InterruptionSettings
object
Settings for handling user interruptions during assistant speech
1 property
Loopcount
TranscriptionEngineDeepgramConfig
TransferCallRequest
object
38 properties
1 required
TranscriptionEngineAzureConfig
object
4 properties
2 required
RejectRequest
object
3 properties
1 required
TranscriptionEngineGoogleConfig
object
11 properties
HangupTool
object
2 properties
2 required
SipHeader
object
2 properties
2 required
TranscriptionConfig
object
The settings associated with speech to text for the voice assistant. This is only relevant if the assistant uses a text-to-text language model. Any assistant u…
2 properties
ResembleSampleRate
string
Audio sample rate in Hz.
TranscriptionStopRequest
object
2 properties
XAIVoiceSettings
object
2 properties
1 required
AIAssistantJoinParticipant
object
4 properties
2 required
StartForkingRequest
object
5 properties
DeveloperMessage
object
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
3 properties
2 required
CallControlCommandResultWithRecordingId
object
2 properties
GatherRequest
object
10 properties
HangupToolParams
object
1 property
DialogflowConfig
object
2 properties
CallControlCommandResult
object
1 property
BookAppointmentToolParams
object
4 properties
2 required
CallAssistantRequest
object
AI Assistant configuration. All fields except id are optional — the assistant's stored configuration will be used as fallback for any omitted fields.
13 properties
1 required
ClientStateUpdateRequest
object
1 property
1 required
ToolMessage
object
4 properties
3 required
CallControlCommandResultWithConversationId
object
2 properties
AssistantMessage
object
Messages sent by the model in response to user messages.
4 properties
1 required
call-control_Errors
object
1 property
TranscriptionEngineAssemblyaiConfig
object
3 properties
SoundModifications
object
Use this field to modify sound effects, for example adjust the pitch.
4 properties
ResembleVoiceSettings
object
4 properties
1 required
TranscriptionEngineAConfig
object
11 properties
NoiseSuppressionDirection
string
The direction of the audio stream to be noise suppressed.
StartStreamingRequest
object
13 properties
BookAppointmentTool
object
2 properties
2 required
StartRecordingRequest
object
17 properties
2 required
CheckAvailabilityToolParams
object
2 properties
2 required
StopGatherRequest
object
2 properties
TelnyxVoiceSettings
object
2 properties
1 required
CallControlTransferToolParams
object
2 properties
2 required
SendDTMFRequest
object
4 properties
1 required
RimeVoiceSettings
object
2 properties
1 required
SystemMessage
object
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
3 properties
2 required
TranscriptionEngineTelnyxConfig
object
3 properties
AIAssistantStartRequest
object
11 properties
AIAssistantJoinRequest
object
4 properties
2 required
TelnyxTranscriptionLanguage
string
Language to use for speech recognition
StreamBidirectionalSamplingRate
integer
Audio sampling rate.
InworldVoiceSettings
object
1 property
1 required
ReferRequest
object
7 properties
1 required
GatherUsingAudioRequest
object
13 properties
BridgeRequest
object
20 properties
1 required
StreamBidirectionalMode
string
Configures method of bidirectional streaming (mp3, rtp).
GatherUsingAIRequest
object
15 properties
1 required
NoiseSuppressionEngineConfig
object
Configuration parameters for noise suppression engines. Different engines support different parameters.
8 properties
DeepgramNova3TranscriptionLanguage
string
Language to use for speech recognition with nova-3 model
MinimaxVoiceSettings
object
5 properties
1 required
AzureTranscriptionLanguage
string
Language to use for speech recognition
CallControlWebhookToolParams
object
8 properties
3 required
HangupRequest
object
3 properties
StreamBidirectionalCodec
string
Indicates codec for bidirectional streaming RTP payloads. Used only with streambidirectionalmode=rtp. Case sensitive.
StreamBidirectionalTargetLegs
string
Specifies which call legs should receive the bidirectional stream audio.
AIAssistantStopRequest
object
2 properties
StopSiprecRequest
object
2 properties
EnqueueRequest
object
6 properties
1 required
ResumeRecordingRequest
object
3 properties
TranscriptionLanguage
string
Language code for transcription. Note: Not all languages are supported by all transcription engines (google, telnyx, deepgram). See engine-specific documentati…
StopForkingRequest
object
3 properties
DeepgramNova2TranscriptionLanguage
string
Language to use for speech recognition with nova-2 model
GoogleTranscriptionLanguage
string
Language to use for speech recognition
StopRecordingRequest
object
3 properties
StopStreamingRequest
object
3 properties
NoiseSuppressionStop
object
2 properties
GatherUsingSpeakRequest
object
16 properties
2 required
XaiTranscriptionLanguage
string
Language to use for speech recognition
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Telnyx 12
Other APIs Telnyx publishes across the network.
Telnyx Access Tokens API
Telnyx Addresses API
Telnyx Advanced Number Orders API
Telnyx Assistants API
Telnyx Audio API
Telnyx Audit Logs API
Telnyx Authentication Providers API
Telnyx AutoRechargePreferences API
Telnyx Billing API
Telnyx Billing Groups API
Telnyx Brands API
Telnyx Bucket SSL Certificate API
#Call Commands