Telnyx TeXML REST 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 header
oauthClientAuth — OAuth 2.0 authentication for Telnyx API and MCP integrations
pronunciation-dicts_bearerAuth — Telnyx API v2 key. Obtain from https://portal.telnyx.com
Paths & Operations 34
Across 22 paths, the API surfaces 34 operations — 4 DELETE, 15 GET, 15 POST. Each is listed below with its method, path, parameters, and response codes.
The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are DialConferenceParticipantRequest (48 properties), InitiateCallRequest (44 properties), InitiateAICallRequest (39 properties), CallResource (18 properties). Each schema is shown below with its type and property counts.
DialConferenceParticipantRequest
object
48 properties
call-scripting_UpdateConferenceParticipantRequest
object
11 properties
ConferenceRecordingResourceIndex
object
9 properties
UpdateCallRequest
object
8 properties
call-scripting_UpdateConferenceRequest
object
3 properties
TexmlErrorCode
stringnull
SendRecordingUrl
boolean
Whether to send RecordingUrl in webhooks.
TexmlUpdateCallStreamingResponseBody
object
6 properties
DateTimeRFC2822
string
ParticipantResource
object
15 properties
ConferenceSid
stringnull
TexmlStatusCallbackMethod
string
HTTP method used to send status callbacks.
AccountSid
string
ConferenceRecordingResource
object
15 properties
TexmlStatusCallback
string
Url where status callbacks will be sent.
call-scripting_UpdateQueueRequest
object
1 property
ConferenceResource
object
12 properties
RecordingStatusCallbackEvent
string
The changes to the recording's state that should generate a call to RecoridngStatusCallback. Can be: in-progress, completed and absent. Separate multiple value…
TexmlRecordingDuration
stringnull
The duration of this recording, given in seconds.
TexmlCreateCallStreamingRequestBody
object
7 properties
CreateTeXMLSecretRequest
object
2 properties2 required
InitiateCallRequest
object
44 properties3 required
QueueResourceIndex
object
8 properties
TexmlStreamUrl
string
The destination WebSocket address where the stream is going to be delivered.
call-scripting_CreateQueueRequest
object
2 properties
StreamName
string
The user specified name of Stream.
CreateTeXMLSecretResult
object
2 properties
TexmlRecordingChannels
string
When dual, final audio file has the first leg on channel A, and the rest on channel B. single mixes both tracks into a single channel.
TexmlCreateCallRecordingResponseBody
object
15 properties
TexmlUpdateCallRecordingRequestBody
object
1 property
TexmlGetCallRecordingResponseBody
object
15 properties
TexmlRecordingSubresourcesUris
object
Subresources details for a recording if available.
1 property
TexmlCreateCallRecordingRequestBody
object
7 properties
TexmlBidirectionalStreamMode
string
Configures method of bidirectional streaming (mp3, rtp).
TexmlRecordingTranscription
object
11 properties
InitiateAICallRequest
object
39 properties3 required
TexmlBidirectionalStreamCodec
string
Indicates codec for bidirectional streaming RTP payloads. Used only with streambidirectionalmode=rtp. Case sensitive.
ParticipantResourceIndex
object
8 properties
ErrorResponse
object
1 property
TexmlUpdateCallStreamingRequestBody
object
1 property
RecordingSource
string
Defines how the recording was created.
NewParticipantResource
object
10 properties
InitiateCallResult
object
3 properties
TexmlCreateCallStreamingResponseBody
object
7 properties
TexmlUpdateSiprecSessionResponseBody
object
7 properties
TexmlRecordingMediaUrl
string
TexmlGetCallRecordingsResponseBody
object
9 properties
RecordingTrack
string
The audio track to record for the call. The default is both.
call-scripting_ResourceNotFoundError
object
1 property
TexmlPriceUnit
stringnull
The unit in which the price is given.
TexmlUpdateSiprecSessionRequestBody
object
1 property
TexmlCreateSiprecSessionRequestBody
object
9 properties
CallControlId
string
StreamStatus
string
The status of the Stream you wish to update.
TexmlRecordingStatus
string
TwimlRecordingChannels
integer
ConferenceResourceIndex
object
8 properties
CallResourceIndex
object
8 properties
PlayBeep
boolean
Whether to play a beep when recording is started.
TexmlCreateSiprecSessionResponseBody
object
10 properties
InitiateAICallResult
object
4 properties
StreamTrack
string
Tracks to be included in the stream
QueueResource
object
9 properties
TexmlSid
string
Identifier of a resource.
CallResource
object
18 properties
TexmlRecordingPrice
stringnull
The price of this recording, the currency is specified in the priceunit field.
Specification
The full machine-readable OpenAPI contract behind this narrative.
