Skip to main content
The <Record> 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 Note In addition to recording, the <Record> verb supports automatic transcription by setting transcription="true" and providing a transcriptionCallback URL. The transcription result will be sent via webhook.

​
Attributes

ATTRIBUTEDESCRIPTIONOPTIONSDEFAULT
action Optional URL where TeXML will make a request when the <Record> ends to retrieve a new set of TeXML instructions to continue the call flow sent with additional request parameters. -
method HTTP request type used to retrieve the next set of instructions. GET, POSTPOST
finishOnKey Set of digits specified together, any one of which will end the recording. Supported characters values: Any digit, #, *. 1234567890*#
timeout The number of seconds that Telnyx will wait for the recording to be stopped if silence is detected. The timer only starts when the speech is detected. Please note that the transcription is used to detect silence and the related charge will be applied. 0 for infinite. 0
maxLength Defines the maximum length for the recording in seconds. 0 for infinite. 0 - 144003600
playBeep Whether or not a sound is played before the start of a recording. true
trim Will remove silence from the beginning and end of the recording when set to trim-silence. trim-silence-
channels When using dual channels, the final audio file will be stereo recorded with the first leg on channel A, and the rest on channel B. single, dualdual
recordingStatusCallback Optional URL that tells Telnyx where to make its GET or POST request when the recording is available. -
recordingStatusCallbackMethod HTTP request type used for recordingStatusCallback. GET, POSTPOST
transcription Enables automatic transcription of the recorded audio. When set to ‘true’, a transcription will be generated and delivered to the transcriptionCallback URL. true, falsefalse
transcriptionCallback The URL where Telnyx will send the transcription result once available. -
transcriptionEngine Specifies the engine to use for transcription. A uses Google (default) and B uses Telnyx. Set to Deepgram to transcribe the recording with Deepgram, optionally pairing it with transcriptionModel to choose a specific Deepgram model. A, B, Deepgram, deepgramA
transcriptionModel Optional model to use with the specified transcriptionEngine. Format is vendor/model-name — e.g. deepgram/nova-2 or deepgram/nova-3. The vendor must match transcriptionEngine. If not specified, the engine’s default model will be used. On Deepgram, defaults to deepgram/nova-3. See transcription models in transcription_engine_config. -
transcriptionLanguage Language to use for transcription when transcription is enabled. Use a BCP-47 language tag such as en-US. The set of supported languages depends on the transcriptionEngine and transcriptionModel — see languages in transcription_engine_config. en-US
format The format of the recording file. mp3, wavmp3
recordingStatusCallbackEvent The recording events for which Telnyx should send a webhook to the recordingStatusCallback URL. Multiple events are separated by a space. in-progress, completedcompleted

​
Examples

Example 1 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Record action="https://example.com/recording-complete" 
            maxLength="30" 
            playBeep="true"/>
</Response>
Example 2 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Say voice="Telnyx.KokoroTTS.af">This call will be recorded and transcribed for quality purposes.</Say>
  <Record 
    action="https://example.com/recording-complete" 
    method="POST"
    maxLength="60"
    timeout="5"
    transcription="true"
    transcriptionEngine="A"
    transcriptionCallback="https://example.com/transcription-result" />
</Response>
Example 3 Transcribe the recording with Deepgram and select a specific model: 
<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Say voice="Telnyx.KokoroTTS.af">This call will be recorded and transcribed for quality purposes.</Say>
  <Record 
    action="https://example.com/recording-complete" 
    method="POST"
    maxLength="60"
    transcription="true"
    transcriptionEngine="Deepgram"
    transcriptionModel="deepgram/nova-3"
    transcriptionLanguage="en-US"
    transcriptionCallback="https://example.com/transcription-result" />
</Response>

​
Expected callbacks

If action or statusCallback is set, recording status callbacks are sent:
EventCallback Reference
in-progressRecording In Progress
completedRecording Completed
If transcribe is enabled, a transcription callback is sent to transcribeCallback: See Transcription Callback for the full payload reference.