Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

TwiML™ Voice: <Record>


The <Record> verb records the caller's voice and returns to you the URL of a file containing the audio recording. You can optionally generate text transcriptions of recorded calls by setting the transcribe attribute of the <Record> verb to true.

(warning)

Warning


Verb Attributes

attributes page anchor

The <Record> verb supports the following attributes that modify its behavior:

Attribute NameAllowed ValuesDefault Value
actionRelative or absolute URLcurrent document URL
methodGET, POSTPOST
timeoutPositive integer5
finishOnKeyAny digit, #, *1234567890*#
maxLengthInteger greater than 1 and less than or equal to 14400 (4 hours) or 86400 (24 hours). The maximum depends on your account's maximum call duration settings. See below for more information3600 (1 hour)
playBeeptrue, falsetrue
trimtrim-silence, do-not-trimtrim-silence
recordingStatusCallbackrelative or absolute URLNone
recordingStatusCallbackMethodGET, POSTPOST
recordingStatusCallbackEventin-progress, completed, absentcompleted
transcribetrue, falsefalse
transcribeCallbackRelative or absolute URLNone

Use one or more of these attributes in a <Record> verb like so:

Using attributes in a Record verb

using-attributes-in-a-record-verb page anchor
Node.js
Python
C#
Java
PHP
Ruby

_10
const VoiceResponse = require('twilio').twiml.VoiceResponse;
_10
_10
_10
const response = new VoiceResponse();
_10
response.record({
_10
timeout: 10,
_10
transcribe: true
_10
});
_10
_10
console.log(response.toString());

Output

_10
<?xml version="1.0" encoding="UTF-8"?>
_10
<Response>
_10
<Record timeout="10" transcribe="true" />
_10
</Response>

action

attributes-action page anchor

The action attribute takes a relative or absolute URL as a value. When recording is finished, Twilio will make a GET or POST request to this URL including the parameters below. If no action is provided, <Record> will request the current document's URL.

After making this request, Twilio will continue the current call using the TwiML received in your response. Keep in mind that by default Twilio will re-request the current document's URL. This can lead to unwanted looping behavior if you're not careful. Any TwiML verbs occurring after a <Record> are unreachable.

(information)

Info

By default, silent recordings are saved by Twilio. If you do not need to retain silent recordings, reach out to Twilio Support(link takes you to an external page).

(warning)

Warning

When modifying a live call to redirect to a <Record> verb an action URL must be provided. Failure to provide an action URL will result in an 11100 error.

(warning)

Warning

If you started or updated a call with a twiml parameter, the action URLs for <Record>, <Gather>, and <Pay> must be absolute.

The Call Resource API Docs have language-specific examples of creating and updating Calls with TwiML:

  • See "Create a Call resource with TwiML" under Create a Call Resource to see examples of creating a call with a twiml parameter.
  • See "Update a Call resource with TwiML" under Update a Call Resource to see examples of updating a call with a twiml parameter.

Twilio will pass the following parameters in addition to the standard TwiML Voice request parameters with its request to the action URL:

ParameterDescription
RecordingUrlThe URL of the recorded audio. The recording file may not yet be accessible when the action callback is sent. Use recordingStatusCallback for reliable notification on when the recording is available for access.
RecordingDurationThe duration of the recorded audio (in seconds). To get a final accurate recording duration after any trimming of silence, use recordingStatusCallback.
DigitsThe key (if any) pressed to end the recording, or hangup if the caller hung up.

A request to the RecordingUrl will return a recording in binary WAV audio format by default. To request the recording in MP3 format, append ".mp3" to the RecordingUrl value.

The method attribute takes the value GET or POST. This tells Twilio whether to request the action URL via HTTP GET or POST. This attribute is modeled after the HTML form method attribute. POST is the default value.

The timeout attribute tells Twilio to end the recording after a number of seconds of silence has passed. To disable this feature, set timeout to 0. The default is 5 seconds.

(warning)

Warning

The timeout value applies for a period in which audio is received, but it is silent. For a period in which no RTP audio data are received at all, the recording is essentially unaware of silent periods and proceeds to record just as usual.

The finishOnKey attribute lets you choose a set of digits that, when entered, end the recording. For example, if you set finishOnKey to # and the caller presses the # key, Twilio will immediately stop recording and submit RecordingUrl, RecordingDuration, and # as parameters in a request to the action URL. The allowed values are the digits 0-9, # and *. The default is 1234567890*# — ie. any key will end the recording. Unlike <Gather>, you may specify more than one character as a finishOnKey value.

(warning)

Warning

In some instances, when using the finishOnKey attribute, the last part of the audio (approximately the one second before the key is pressed) may not be recorded.

The maxLength attribute lets you set the maximum length for the recording in seconds. If you set maxLength to 30, the recording will automatically end after 30 seconds of recorded time has elapsed. The defaults are 3600 seconds (one hour) for a normal recording, and 120 seconds (two minutes) for a transcribed recording. Twilio Client calls using <Record> are limited to 600 seconds (ten minutes).

The maximum value of the maxLength attribute is limited by the maximum length set for your Voice Calls. The default maximum Call length is 4 hours (14400 seconds), and the maximum possible length is 24 hours (86400 seconds). You can update the maximum Call length to 24 hours in the Twilio Console in the Voice Settings page(link takes you to an external page) under "24-Hour Maximum Call Duration".

The playBeep attribute allows you to toggle between playing a sound before the start of a recording. If you set the value to false, no beep sound will be played.

The trim attribute lets you specify whether to trim leading and trailing silence from your audio files. The default is trim-silence, which removes any silence at the beginning and end of your recording. This may cause the duration of the recording to be slightly less than the duration of the call.

The recordingStatusCallback attribute takes a relative or absolute URL as an argument. If a recordingStatusCallback URL is given, Twilio will make a GET or POST request to the specified URL when the recording is available to access.

Twilio will pass the following parameters with its request to the recordingStatusCallback URL:

ParameterDescription
AccountSidThe unique identifier of the Account responsible for this recording.
CallSidA unique identifier for the call associated with the recording.
RecordingSidThe unique identifier for the recording.
RecordingUrlThe URL of the recorded audio.
RecordingStatusThe status of the recording. Possible values are: completed, failed.
RecordingDurationThe length of the recording, in seconds.
RecordingChannelsThe number of channels in the final recording file as an integer. Only one channel is supported for the <Record> verb.
RecordingSourceThe initiation method used to create this recording. RecordVerb is returned for recordings initiated via the <Record> verb.

This attribute indicates which HTTP method to use when requesting recordingStatusCallback. It defaults to POST.

The recordingStatusCallbackEvent allows you to specify which recording status changes should generate a webhook to the URL specified in the recordingStatusCallback attribute. The available values are:

  • in-progress : the recording has started.
  • completed : the recording is complete and available.
  • absent : the recording is absent and inaccessible.

To specify more than one value, separate each with a space. The default value is completed.

The transcribe attribute tells Twilio that you would like a text representation of the audio of the recording. Twilio will pass this recording to our speech-to-text engine and attempt to convert the audio to human readable text. The transcribe option is not enabled by default. If you do not wish to perform transcription, simply do not include the transcribe attribute.

(warning)

Warning

Notes

  1. Transcription is a paid feature. If you include a transcribe or transcribeCallback attribute on your Record verb, your account will be charged. See the pricing(link takes you to an external page) page for our transcription prices.
  2. Transcription is only supported in American English.

Additionally, transcription is currently limited to recordings initiated via the TwiML <Record> verb with a duration greater than two seconds and less than 120 seconds. If you request a transcription for a recording outside these duration limits, Twilio will write a warning to your debug log rather than transcribe the recording.

The transcribeCallback attribute is used in conjunction with the transcribe attribute. It allows you to specify a URL to which Twilio will make an asynchronous POST request when the transcription is complete. This is not a request for TwiML and the response will not change call flow, but the request will contain the standard TwiML request parameters as well as transcription specific ones.

If transcribeCallback is specified, then there is no need to specify transcribe=true; it is implied. If you specify transcribe=true without a transcribeCallback, the completed transcription will be stored for you to retrieve later (see the REST API Transcriptions section), but Twilio will not asynchronously notify your application.

Twilio will not make a request to the provided transcribeCallback URL if the voice recording is missing or absent(link takes you to an external page).

(warning)

Warning

The transcribeCallback URL attribute is considered Not PII.

Twilio will pass the following parameters with its request to the transcribeCallback URL:

ParameterDescription
TranscriptionSidThe unique 34-character ID of the transcription.
TranscriptionTextThe text of the transcription.
TranscriptionStatusThe status of the transcription attempt: either completed or failed.
TranscriptionUrlThe URL for the transcription's REST API resource.
RecordingSidThe unique 34-character ID of the recording from which the transcription was generated.
RecordingUrlThe URL for the transcription's source recording resource.
CallSidA unique identifier for this call, generated by Twilio.
AccountSidYour Twilio account ID. It is 34 characters long, and always starts with the letters AC.
FromThe phone number or client identifier of the party that initiated the call. Phone numbers are formatted with a + and country code, eg. +16175551212 ([E.164][e164] format). Client identifiers begin with the client: URI scheme; for example, for a call from a client named tommy, the From parameter will be client:tommy.
ToThe phone number or client identifier of the called party. Phone numbers are formatted with a + and country code, eg. +16175551212 ([E.164][e164] format). Client identifiers begin with the client: URI scheme; for example, for a call to a client named joey, the To parameter will be client:joey.
CallStatusA descriptive status for the call. The value is one of queued, ringing, in-progress, completed, busy, failed, or no-answer. See the CallStatus section for more details.
ApiVersionThe version of the Twilio API used to handle this call. For incoming calls, this is determined by the API version set on the called number. For outgoing calls, this is the API version used by the outgoing call's REST API request.
DirectionA string describing the direction of the call: inbound for inbound calls, outbound-api for calls initiated via the REST API, or outbound-dial for calls initiated by a <Dial> verb.
ForwardedFromThis parameter is set only when Twilio receives a forwarded call, but its value depends on the caller's carrier including information when forwarding. Not all carriers support passing this information.

You can't nest any verbs within <Record> and you can't nest <Record> within any other verbs.



Example 1: Simple Record

examples-1 page anchor

Twilio will execute the <Record> verb causing the caller to hear a beep and the recording to start. If the caller is silent for more than five seconds, hits the # key, or the recording maxlength time is hit, Twilio will make an HTTP POST request to the default action URL (ie. the current document URL) with the parameters RecordingUrl and RecordingDuration.

Node.js
Python
C#
Java
PHP
Ruby

_10
const VoiceResponse = require('twilio').twiml.VoiceResponse;
_10
_10
_10
const response = new VoiceResponse();
_10
response.record();
_10
_10
console.log(response.toString());

Output

_10
<?xml version="1.0" encoding="UTF-8"?>
_10
<!-- page located at http://example.com/simple_record.xml -->
_10
<Response>
_10
<Record/>
_10
</Response>

Example 2: Record a voicemail

examples-2 page anchor

This example shows a simple voicemail prompt. The caller is asked to leave a message at the beep. The <Record> verb beeps and begins recording up to 20 seconds of audio.

Node.js
Python
C#
Java
PHP
Ruby

_14
const VoiceResponse = require('twilio').twiml.VoiceResponse;
_14
_14
_14
const response = new VoiceResponse();
_14
response.say('Please leave a message at the beep.\nPress the star key when finished.');
_14
response.record({
_14
action: 'http://foo.edu/handleRecording.php',
_14
method: 'GET',
_14
maxLength: 20,
_14
finishOnKey: '*'
_14
});
_14
response.say('I did not receive a recording');
_14
_14
console.log(response.toString());

Output

_15
<?xml version="1.0" encoding="UTF-8"?>
_15
<!-- page located at http://example.com/voicemail_record.xml -->
_15
<Response>
_15
<Say>
_15
Please leave a message at the beep.
_15
Press the star key when finished.
_15
</Say>
_15
<Record
_15
action="http://foo.edu/handleRecording.php"
_15
method="GET"
_15
maxLength="20"
_15
finishOnKey="*"
_15
/>
_15
<Say>I did not receive a recording</Say>
_15
</Response>

  • If the caller speaks for less than 20 seconds and is then silent for five seconds, Twilio makes a GET request to the action URL. The <Say> verb is never reached.
  • If the caller speaks for the full 20 seconds, Twilio makes a GET request to the action URL. The <Say> verb is never reached.

Example 3: Transcribe a recording

examples-3 page anchor

Twilio will record the caller. When the recording is complete, Twilio will transcribe the recording and make an HTTP POST request to the transcribeCallback URL with a parameter containing a transcription of the recording.

Node.js
Python
C#
Java
PHP
Ruby

_10
const VoiceResponse = require('twilio').twiml.VoiceResponse;
_10
_10
_10
const response = new VoiceResponse();
_10
response.record({
_10
transcribe: true,
_10
transcribeCallback: '/handle_transcribe.php'
_10
});
_10
_10
console.log(response.toString());

Output

_10
<?xml version="1.0" encoding="UTF-8"?>
_10
<!-- page located at http://example.com/record_and_transcribe.xml -->
_10
<Response>
_10
<Record transcribe="true" transcribeCallback="/handle_transcribe.php"/>
_10
</Response>


Hints and advanced uses

hints page anchor

The recording duration may be shorter than the time a caller spends recording. The duration difference can be due to:

  • Twilio trimming leading and trailing silence from your audio files
  • No RTP (Real-time Transport Protocol) audio data being received during recording

Rate this page: