TeXML Verbs Reference

📄️ Dial

The ` verb transfers an existing call to another destination. ` will end this new call if: the called party does not answer, the number does not exist, or Telnyx receives a busy signal.

📄️ Say

The `` verb speaks the text specified back to the caller, enabling text-to-speech for any application.

📄️ Play

The `` verb plays an MP3 or WAV audio file, which Telnyx fetches back to the caller from the URL you configure.

📄️ Gather

The ` verb collects DTMF tones during a call. can be nested within ` to create an interactive IVR with text-to-speech.

📄️ AIGather

The ` verb collects specific information from call participants leveraging AI. It requires the child node ` to be provided with a JSON Schema object that describes the parameters to be gathered.

📄️ AIAssistant

The `` verb allows you to start a voice assistant on the call.

The `` verb creates an audio file with the call audio. If a recordingStatusCallback, Telnyx will deliver the URL for the recording to that address once the call has ended. Recording URLs are valid for 10 minutes after the call has ended. All recordings are also available via the Telnyx Mission Control Portal

📄️ Conference

The ` verb's noun allows you to connect to a conference room. Much like how the noun allows you to connect to another phone number, the ` noun allows you to connect to a named conference room and talk with the other callers who have also connected to that room. Conference is commonly used as a container for calls when implementing hold, transfer, and barge. If the specified conference name does not exist, a new conference will be created.

📄️ Enqueue

The `` verb enqueues the current call in a call queue.

📄️ Hangup

Ends the call

📄️ Pause

The ` verb waits silently for a specified number of seconds or one second by default. No nouns can be nested within `, and a self-closing tag must be used.

📄️ Redirect

The ` verb transfers control of a call to the TeXML document to another TeXML application. This is useful to create a tree structure of TeXML files for different applications. No nouns can be nested within `

📄️ Reject

The ` verb rejects a call to your Telnyx number. It is effectively an exit statement from the current document, as there is no way to return to any instructions listed after the verb. If placed as the very first verb in an incoming call, will prevent the call from being answered and will incur no cost. If placed elsewhere in the call, the call will hang up but will be charged up to that point.You can't nest any verbs within and you can't nest ` in any other verbs.

📄️ Stream

The `` instruction starts streaming the media from a call to a specific WebSocket address in near-real-time. Audio will be delivered as base64-encoded RTP payloads (no headers), wrapped in JSON payloads.

📄️ Connect

The `` verb starts the service defined in the nested noun in synchronous mode. The following instructions will be executed when the service is stopped.

📄️ HttpRequest

The ` verb sends a request to the external servers. It consists of 2 child nodes and `

📄️ Leave

The ` verb removes a call from the queue and continues with the next verb after the original . The ` verb doesn't support any attributes.

📄️ Refer

The ` verb in Telnyx allows you to transfer a phone call to another SIP infrastructure during a TeXML call. You can initiate it at any point during the call. When you use the ` verb, Telnyx will replace the original call with a new call to the external system you specify, effectively transferring the call to that system.