​

Telnyx Calling: TeXML — Documentation Index

TeXML documentation within the Calling section of the Telnyx developer docs (https://developers.telnyx.com). Root index: https://developers.telnyx.com/llms.txt · Calling index: https://developers.telnyx.com/development/llms/calling-llms-txt.md · Full content for this subsection: https://developers.telnyx.com/development/llms/calling-texml-llms-full-txt.md

​

Guides

• TeXML Fundamentals: Learn how TeXML, an XML-based markup language, defines call control and processing instructions for programmable voice applications on Telnyx.
• Instruction Fetching: How Telnyx fetches TeXML instructions for inbound and outbound calls
• TeXML Interpreter: TeXML is an XML based data structure used by Telnyx to build quick applications
• TeXML TwiML Compatibility: Side-by-side comparison of TeXML and TwiML verb and noun support, helping you migrate Twilio call control instructions to Telnyx with minimal changes.
• Dynamic TeXML Bins: Generate dynamic TeXML responses with Telnyx TeXML Bins. Inject runtime variables into TwiML-compatible call flows without standing up a backend.
• Sending HTTP Requests: Send outbound HTTP requests from TeXML on Telnyx Programmable Voice. Use HttpRequest verbs to call your APIs mid-conversation with code samples.
• TeXML Answering Machine: Learn how to enable and configure Answering Machine Detection (AMD)

​

Markup Language

• Dial
• Say
• Play
• Gather
• AIGather
• AIAssistant
• Record
• Conference
• Enqueue
• Hangup
• Pause
• Redirect
• Reject
• Stream
• ConversationRelay
• Connect
• HttpRequest
• Leave
• Refer
• Siprec
• Start
• Stop
• Suppression
• Transcription

​

API Reference

• Applications: Manage TeXML applications for handling inbound and outbound calls.
• Calls: Initiate outbound calls and manage individual call legs programmatically through the Telnyx TeXML REST API, including state, metadata, and lifecycle.
• Conferences: Create, modify, and end multi-participant audio conferences with the Telnyx TeXML REST API, including participant management and recording controls.
• Conference participants: Add, mute, hold, and remove individual call legs from TeXML conferences using the Telnyx Conference Participants REST API for fine-grained control.
• Recordings: List, retrieve, and manage audio recordings produced from TeXML calls and conferences, including metadata like format, duration, and storage URLs.
• Transcripts: Retrieve and manage transcription results produced from TeXML calls when the Transcription verb is executed or transcription is enabled on a call.
• SIPREC: Start and manage SIPREC media recording sessions for TeXML calls, delivering call audio to external SIP recording servers for compliance use cases.
• Streams: Start, stop, and manage media streaming sessions over WebSockets for TeXML calls to deliver real-time audio to external transcription or AI systems.
• Queues: Create and manage Telnyx TeXML queues to hold waiting callers in FIFO order before connecting them to agents, with hold music and announcement support.
• TeXML application secrets: Securely store, manage, and retrieve credentials, API keys, and tokens used by TeXML applications via the Telnyx TeXML Secrets REST API.

​

API Reference (TeXML)

​

TeXML Applications

• List all TeXML Applications: Returns a list of your TeXML Applications.
• Creates a TeXML Application: Creates a TeXML Application.
• Retrieve a TeXML Application: Retrieves the details of an existing TeXML Application.
• Update a TeXML Application: Updates settings of an existing TeXML Application.
• Deletes a TeXML Application: Deletes a TeXML Application.

​

TeXML REST Commands

• Fetch multiple call resources: Returns multiple call resouces for an account. This endpoint is eventually consistent.
• Initiate an outbound call: Initiate an outbound TeXML call. Telnyx will request TeXML from the XML Request URL configured for the connection in the Mission Control Portal.
• Fetch a call: Returns an individual call identified by its CallSid. This endpoint is eventually consistent.
• Update call: Update TeXML call. Please note that the keys present in the payload MUST BE formatted in CamelCase as specified in the example.
• Initiate an outbound AI call: Initiate an outbound AI call with warm-up support. Validates parameters, builds an internal TeXML with an AI Assistant configuration, encodes instructions into…
• List conference resources: Lists conference resources.
• Fetch a conference resource: Returns a conference resource.
• Update a conference resource: Updates a conference resource.
• List conference participants: Lists conference participants
• Dial a new conference participant: Dials a new conference participant
• Get conference participant resource: Gets conference participant resource
• Update a conference participant: Updates a conference participant
• Delete a conference participant: Deletes a conference participant
• Fetch multiple recording resources: Returns multiple recording resources for an account.
• Fetch recording resource: Returns recording resource identified by recording id.
• Delete recording resource: Deletes recording resource identified by recording id.
• Fetch recordings for a call: Returns recordings for a call identified by call_sid.
• Request recording for a call: Starts recording with specified parameters for call idientified by call_sid.
• Update recording on a call: Updates recording resource for particular call.
• List conference recordings: Lists conference recordings
• Fetch recordings for a conference: Returns recordings for a conference identified by conference_sid.
• List recording transcriptions: Returns multiple recording transcription resources for an account.
• Fetch a recording transcription resource: Returns the recording transcription resource identified by its ID.
• Delete a recording transcription: Permanently deletes a recording transcription.
• Request siprec session for a call: Starts siprec session with specified parameters for call idientified by call_sid.
• Updates siprec session for a call: Updates siprec session identified by siprec_sid.
• Start streaming media from a call.: Starts streaming media from a call to a specific WebSocket address.
• Update streaming on a call: Updates streaming resource for particular call.
• List queue resources: Lists queue resources.
• Create a new queue: Creates a new queue resource.
• Fetch a queue resource: Returns a queue resource.
• Update a queue resource: Updates a queue resource.
• Delete a queue resource: Delete a queue resource.
• Create a TeXML secret: Create a TeXML secret which can be later used as a Dynamic Parameter for TeXML when using Mustache Templates in your TeXML. In your TeXML you will be able to u…

​

Callbacks

• TeXML AI Gather: Webhook sent when AI Gather completes with transcription results.
• TeXML Call AMD: Webhook sent when Answering Machine Detection (AMD) completes during a TeXML call.
• TeXML Call Answered: Webhook sent when a TeXML call is answered.
• TeXML Call Completed: Webhook sent when a TeXML call is completed.
• TeXML Call DTMF: Webhook sent when a DTMF digit is received during a TeXML call.
• TeXML Call Initiated: Webhook sent when a TeXML call is initiated.
• TeXML Call Ringing: Webhook sent when a TeXML call is ringing.
• TeXML Gather: Webhook sent when a Gather command completes (sent to the action URL).
• TeXML HTTP Request: Webhook sent as response to an HTTP Request instruction.
• TeXML Refer Status: Webhook sent for SIP REFER status updates.
• TeXML Conference End: Webhook sent when a TeXML conference ends.
• TeXML Conference Join: Webhook sent when a participant joins a TeXML conference.
• TeXML Conference Leave: Webhook sent when a participant leaves a TeXML conference.
• TeXML Conference Speaker: Webhook sent when a participant starts or stops speaking in a TeXML conference.
• TeXML Conference Start: Webhook sent when a TeXML conference starts.
• TeXML Recording Completed: Webhook sent when a recording is completed during a TeXML call (triggered by recordingStatusCallbackEvent).
• TeXML Recording In-Progress: Webhook sent when a recording starts during a TeXML call (triggered by recordingStatusCallbackEvent).
• TeXML Transcription: Webhook sent when a recording transcription is completed.
• TeXML SIPREC: Webhook sent for SIPREC session status updates.
• TeXML Stream: Webhook sent for media streaming status updates.
• TeXML Queue: Webhook sent for queue status events (triggered by Enqueue command waitUrl).