The Record Element

The Record element is used to record a call and returns the URL of the recording file.

Attributes

action string

Submit the result of the record to this URL. See the action Request Parameters table below for more information.

Allowed values - a fully qualified URL.

method string

Method used to send HTTP request to the action URL.

Allowed values - GET, POST. Defaults to POST.

fileFormat string

The format of the recording.

Allowed values - mp3, wav. Defaults to mp3.

redirect boolean

If false, don't redirect to action url, only request the url and continue to next element.

Allowed values - true, false. Defaults to true.

timeout integer

Seconds of silence before considering the recording complete. Only used when recordSession and startOnDialAnswer are false.

Allowed values - positive integer. Defaults to 15.

maxLength integer

Maximum number of seconds to record.

Allowed values - integer greater than 1. Defaults to 60.

playBeep boolean

Play a beep before recording. Only used when recordSession and startOnDialAnswer is false.

Allowed values - true, false. Defaults to true.

finishOnKey string

Stop recording on this key. Only used when recordSession and startOnDialAnswer are false.

Allowed values - any digit, #, *. Defaults to 1234567890*#

recordSession boolean

Record current call session in background. No beep will be played.

Allowed values - true, false. Defaults to false.

startOnDialAnswer boolean

Record call when called party answers in a Dial. No beep will be played.

Allowed values - true, false. Defaults to false.

transcriptionType string

The type of transcription required. Default is auto.

  • auto

    Transcription is completely automated; turnaround time is about 5 minutes.

  • hybrid

    Transcription is a combination of automated and human verification processes; turnaround time is about 10-15 minutes.

Note: Our transcription service is primarily for the voice mail use case (limited to recorded files lasting for up to 2 minutes). Currently the service is available only in English and you will be charged for the usage. Please check out the price details.
transcriptionUrl string

The URL where the transcription will be sent from Plivo.

Allowed values - a fully qualified URL. No default value.

transcriptionMethod string

The HTTP method used to invoke transcriptionUrl.

Allowed values - GET, POST. Defaults to POST.

callbackUrl string

If set, this URL is fired in background when the recorded file is ready to be used. See the callbackUrl Request Parameters table below for more information.

Allowed values - a fully qualified URL

callbackMethod string

The HTTP method used to notify the callbackUrl.

Allowed values - GET, POST. Defaults to POST.

Note: "Note the following points regarding the Record element attributes:"

  • If recordSession is set to true, recording will start in the background and will continue until the call has hung up or maxLength has been reached.

  • If startOnDialAnswer is set to true, it will record the complete conversation between both the parties during the next Dial and will end when Dial is done or maxLength reached. This may not be legal in some countries.

  • timeout, finishOnKey, playBeep attributes have no effect when recordSession or startOnDialAnswer is set to true.

  • The default recording time is 60 seconds if maxLength is not set.

Parameters sent to the answer URL

RecordUrl

Complete path to the recorded file URL.

Digits

If set, the digits pressed to stop the record.

RecordingDuration

Duration of recording in seconds.

RecordingDurationMs

Duration of recording in milliseconds.

RecordingStartMs

When the recording started (epoch time UTC) in milliseconds.

RecordingEndMs

When the recording ended (epoch time UTC) in milliseconds.

RecordingID

Recording ID of the file.

Note: "Note the following points regarding the action request parameters:"

  • If startOnDialAnswer is set to true, an initial request is made to the action URL as soon as the recording has started.

  • Because of this RecordingDuration, RecordingDurationMs, RecordingStartMs, and RecordingEndMs will all be -1.

  • When the recording is finished, another request will be made to the action URL to report the actual values.

Parameters sent to the callbackUrl

RecordUrl

Complete path to the recorded file URL.

RecordingDuration

Duration of recording in seconds.

RecordingDurationMs

Duration of recording in milliseconds.

RecordingStartMs

When the recording started (epoch time UTC) in milliseconds.

RecordingEndMs

When the recording ended (epoch time UTC) in milliseconds.

RecordingID

Recording ID of the file.

Parameters sent to the transcriptionUrl

transcription_charge

The credit deducted for the transcription.

transcription

The transcribed text of the recording.

duration

The duration in seconds of the recording.

call_uuid

The call UUID of the call which was transcribed.

transcription_rate

The rate of the transcription per minute.

recording_id

Recording ID of the recording which was transcribed.