|API Documentation

⌘K

The Record Element

The Record element records a call or conference and posts the URL of the recording to an action URL.

Attributes

Attribute	Description
`action` string Callback-retry configurable	A URL to which the parameters are sent. The parameters sent to the action URL are described below. This is a required attribute. Allowed values: A fully qualified URL
`method` string Callback-retry configurable	The method used to send the result of the recording to the action URL. Allowed values: GET, POST Defaults to POST.
`fileFormat` string	Specifies the file format of the recording. Allowed values: mp3, wav Defaults to mp3.
`redirect` boolean	If set to true, the action URL will not be fetched; instead, the XML response will be retrieved and executed after the recording is done. If set to false, the action URL will be fetched and the response will be executed without even retrieving the XML response. Allowed values: true, false Defaults to false.
`timeout` integer	The maximum time in seconds to record. When this time is reached, the recording ends. The timeout does not set a duration limit on the recording (no time limit is set). For recordings that are ended due to a timeout, the RecordingEndReason parameter sent to the action URL has a value of RecordingTimeout. Allowed values: integer > 0 Defaults to 60.
`maxLength` integer	The maximum length of the recording in seconds. Once this time is reached, the recording ends. For recordings that end due to the maxLength limit, the RecordingEndReason sent to the action URL has a value of maxLength. Allowed values: integer > 0 Defaults to 60.
`playBeep` boolean	If set to true, a beep will be played before the recording begins. Allowed values: true, false Defaults to true.
`finishOnKey` string	When this key is pressed, the recording will stop. For recordings that end due to this attribute, the RecordingEndReason sent to the action URL has a value of FinishedOnKey. Allowed values: Any digit, #, * Defaults to 1234567890*#.
`recordSession` boolean	If set to true, the entire session will be recorded, including multiple plays or speak elements. The recording will end when the call is hung up. For recordings that end due to recordSession being set to true, the RecordingEndReason sent to the action URL has a value of HungUp. Allowed values: true, false Defaults to false.
`startOnDialAnswer` boolean	If set to true, the recording will start when the call is answered. This is used for outbound calls, where the record element is embedded in the Dial element. Allowed values: true, false Defaults to false.
`transcriptionType` string	Specifies the type of transcription service to use. Allowed values: auto, hybrid Defaults to auto. Note: Transcription is available at an additional cost. Please refer to the pricing page for more details. auto: The recording is transcribed using the default Vobiz transcription service. hybrid: The recording will be transcribed using the Vobiz transcription service for the most common languages and a third-party provider for all other languages.
`transcriptionUrl` string Callback-retry configurable	A URL to which the transcription is sent. Allowed values: A fully qualified URL
`transcriptionMethod` string Callback-retry configurable	Specifies the HTTP method to use when requesting the transcriptionUrl. Allowed values: GET, POST Defaults to POST.
`callbackUrl` string Callback-retry configurable	A URL to which parameters are sent when the recording ends. This is similar to the action URL, but the recording URL will be ready by the time the callback is made. The parameters sent to the callback URL are the same as those sent to the action URL. Allowed values: A fully qualified URL
`callbackMethod` string Callback-retry configurable	Specifies the HTTP method to use when requesting the callbackUrl. Allowed values: GET, POST Defaults to POST.

Parameters sent to the action URL

Parameter	Description
`RecordUrl` string	The URL of the recording file. When you receive this parameter, you may need to wait a few seconds for the file to be ready for download. Alternatively, you can use the callbackUrl attribute to receive a notification once the file is ready.
`RecordingDuration` integer	The duration of the recording in seconds.
`RecordingDurationMs` integer	The duration of the recording in milliseconds.
`RecordingStartMs` integer	The timestamp when the recording started, in milliseconds.
`RecordingEndMs` integer	The timestamp when the recording ended, in milliseconds.
`RecordingID` string	A unique identifier for the recording.
`RecordingEndReason` string	The reason the recording ended. Possible values are: RecordingTimeout: Recording ended due to timeout maxLength: Recording reached the maxLength limit FinishedOnKey: Recording ended when the finishOnKey was pressed HungUp: Recording ended when the call was hung up

Parameters sent to the callback URL

The parameters sent to the callback URL are the same as those sent to the action URL.

Parameters sent to the transcription URL

Parameter	Description
`transcription` string	The text of the transcription.
`transcription_id` string	A unique identifier for the transcription.
`transcription_url` string	The URL of the transcription file.
`recording_id` string	A unique identifier for the recording.

On this page