Telnyx Call Commands API is one of 169 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.2.0, at version 2.0.0.
Requests are made against a single base URL, https://api.telnyx.com/v2.
The identity and technical contract details declared by the specification.
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
CheckAvailabilityToolParams
object
2 properties
2 required
TransferCallRequest
object
38 properties
1 required
call-control_Error
object
5 properties
2 required
ToolMessage
object
4 properties
3 required
TelnyxVoiceSettings
object
2 properties
1 required
StartForkingRequest
object
5 properties
TranscriptionLanguage
string
Language code for transcription. Note: Not all languages are supported by all transcription engines (google, telnyx, deepgram). See engine-specific documentati…
StreamBidirectionalMode
string
Configures method of bidirectional streaming (mp3, rtp).
StartSiprecRequest
object
7 properties
ToolCall
object
A call to a function tool created by the model.
3 properties
3 required
DeveloperMessage
object
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
3 properties
2 required
CallRequest
object
60 properties
3 required
AWSVoiceSettings
object
1 property
1 required
InworldVoiceSettings
object
1 property
1 required
CallControlCommandResultWithConversationId
object
2 properties
SpeakRequest
object
11 properties
2 required
StopGatherRequest
object
2 properties
RimeVoiceSettings
object
2 properties
1 required
ResumeRecordingRequest
object
3 properties
PlaybackStopRequest
object
4 properties
DeepgramNova3TranscriptionLanguage
string
Language to use for speech recognition with nova-3 model
ResembleVoiceSettings
object
4 properties
1 required
DeepgramNova2Config
object
6 properties
2 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.
BookAppointmentToolParams
object
4 properties
2 required
AIAssistantStartRequest
object
11 properties
NoiseSuppressionEngineConfig
object
Configuration parameters for noise suppression engines. Different engines support different parameters.
8 properties
StopSiprecRequest
object
2 properties
CallWithRecordingId
object
10 properties
5 required
TranscriptionEngineDeepgramConfig
CallControlTransferToolParams
object
2 properties
2 required
DeepgramNova2TranscriptionLanguage
string
Language to use for speech recognition with nova-2 model
TranscriptionEngineAConfig
object
11 properties
DeepgramNova3Config
object
6 properties
2 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…
SwitchSupervisorRoleRequest
object
1 property
1 required
ReferRequest
object
7 properties
1 required
TranscriptionEngineGoogleConfig
object
11 properties
XaiTranscriptionLanguage
string
Language to use for speech recognition
AIAssistantStopRequest
object
2 properties
GatherUsingSpeakRequest
object
16 properties
2 required
StopForkingRequest
object
3 properties
TranscriptionStopRequest
object
2 properties
AssistantMessage
object
Messages sent by the model in response to user messages.
4 properties
1 required
SendDTMFRequest
object
4 properties
1 required
StreamBidirectionalSamplingRate
integer
Audio sampling rate.
AIAssistantAddMessagesRequest
object
3 properties
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
HangupTool
object
2 properties
2 required
TranscriptionEngineXaiConfig
object
4 properties
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…
Assistant
object
Assistant configuration including choice of LLM, custom instructions, and tools.
4 properties
EnqueueRequest
object
6 properties
1 required
TranscriptionEngineTelnyxConfig
object
3 properties
LeaveQueueRequest
object
2 properties
StartRecordingRequest
object
17 properties
2 required
AzureTranscriptionLanguage
string
Language to use for speech recognition
BookAppointmentTool
object
2 properties
2 required
TranscriptionEngineAssemblyaiConfig
object
3 properties
GatherUsingAudioRequest
object
13 properties
StopStreamingRequest
object
3 properties
ClientStateUpdateRequest
object
1 property
1 required
StreamBidirectionalCodec
string
Indicates codec for bidirectional streaming RTP payloads. Used only with streambidirectionalmode=rtp. Case sensitive.
CallControlWebhookToolParams
object
8 properties
3 required
PauseRecordingRequest
object
3 properties
PlayAudioUrlRequest
object
11 properties
AzureVoiceSettings
object
6 properties
1 required
GoogleTranscriptionLanguage
string
Language to use for speech recognition
StartStreamingRequest
object
13 properties
MessageMetadata
object
Metadata to add to the message
InterruptionSettings
object
Settings for handling user interruptions during assistant speech
1 property
GatherUsingAIRequest
object
15 properties
1 required
BridgeRequest
object
20 properties
1 required
StreamBidirectionalTargetLegs
string
Specifies which call legs should receive the bidirectional stream audio.
TransferTool
object
2 properties
2 required
DialogflowConfig
object
2 properties
CallControlRetrievalTool
object
2 properties
2 required
RejectRequest
object
3 properties
1 required
HangupRequest
object
3 properties
MinimaxVoiceSettings
object
5 properties
1 required
SoundModifications
object
Use this field to modify sound effects, for example adjust the pitch.
4 properties
AnswerRequest
object
31 properties
ResembleSampleRate
string
Audio sample rate in Hz.
CustomSipHeader
object
2 properties
2 required
TranscriptionEngineAzureConfig
object
4 properties
2 required
XAIVoiceSettings
object
2 properties
1 required
CallControlBucketIds
object
2 properties
1 required
SipHeader
object
2 properties
2 required
CallControlCommandResultWithRecordingId
object
2 properties
TranscriptionStartRequest
object
5 properties
NoiseSuppressionDirection
string
The direction of the audio stream to be noise suppressed.
NoiseSuppressionStop
object
2 properties
SystemMessage
object
Developer-provided instructions that the model should follow, regardless of messages sent by the user.
3 properties
2 required
AIAssistantJoinRequest
object
4 properties
2 required
WebhookTool
object
2 properties
2 required
HangupToolParams
object
1 property
SendSIPInfoRequest
object
4 properties
2 required
GatherRequest
object
10 properties
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
ElevenLabsVoiceSettings
object
2 properties
1 required
TranscriptionEngineBConfig
object
3 properties
TelnyxTranscriptionLanguage
string
Language to use for speech recognition
NoiseSuppressionStart
object
5 properties
UserMessage
object
Messages sent by an end user
3 properties
2 required
CallControlCommandResult
object
1 property
AzureTranscriptionRegion
string
Azure region to use for speech recognition
StopRecordingRequest
object
3 properties
AIAssistantJoinParticipant
object
4 properties
2 required
call-control_Errors
object
1 property
CheckAvailabilityTool
object
2 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Telnyx publishes across the network.
