<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
| ATTRIBUTE | DESCRIPTION | OPTIONS | DEFAULT |
|---|---|---|---|
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, POST | POST |
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 - 14400 | 3600 |
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, dual | dual |
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, POST | POST |
transcription | Enables automatic transcription of the recorded audio. When set to ‘true’, a transcription will be generated and delivered to the transcriptionCallback URL. | true, false | false |
transcriptionCallback | The URL where Telnyx will send the transcription result once available. | - | |
transcriptionEngine | Specifies the engine to use for transcription. | A, B | A |
Examples
Example 1Expected callbacks
Ifaction or statusCallback is set, recording status callbacks are sent:
| Event | Callback Reference |
|---|---|
in-progress | Recording In Progress |
completed | Recording Completed |
transcribe is enabled, a transcription callback is sent to transcribeCallback:
See Transcription Callback for the full payload reference.