The StartRecording verb allows a segment of a call or conference to be recorded while other verbs are executing.
When used on a call, all audio on both sides of the call will be recorded. When used on a conference, all members who are not on mute or hold will be recorded, as well as all audio clips played. The recording will continue until the call or conference ends, the
<StopRecording> verb is used, or the
<PauseRecording> verb is used.
- For use cases like voice mail system and conference member introduction, you might want to take a look at Record.
- For a more detailed view of Recording, check the Recording Guide.
There is no text content available to be set for the
|recordingAvailableUrl||(optional) URL to send the Recording Available event (or Conference Recording Available event if recording a conference) to once it has been processed. Does not accept BXML. May be a relative URL.|
|recordingAvailableMethod||(optional) The HTTP method to use for the request to |
|transcribe||(optional) A boolean value to indicate that recording should be transcribed. Transcription can succeed only for recordings of length greater than 500 milliseconds and less than 4 hours. Default is |
Note: conferences may not be transcribed. This option will be silently ignored if set on a conference recording, and no callback will be sent.
|transcriptionAvailableUrl||(optional) URL to send the Transcription Available event to once it has been processed. Does not accept BXML. May be a relative URL.|
|transcriptionAvailableMethod||(optional) The HTTP method to use for the request to |
|username||(optional) The username to send in the HTTP request to |
|password||(optional) The password to send in the HTTP request to |
|tag||(optional) A custom string that will be sent with this and all future callbacks unless overwritten by a future |
May be cleared by setting
Max length 256 characters.
Note: this option will be silently ignored if set on a conference recording, and the tag associated with the conference (if any) will be sent.
|fileFormat||(optional) The audio format that the recording will be saved as: |
|multiChannel||(optional) A boolean value indicating whether or not the recording file should separate each side of the call into its own audio channel. Default value is |
Note: this option will be silently ignored if set on a conference recording; only single-channel recordings are allowed on conferences.
recordingAvailableUrl attribute is specified, then the Recording Available or Conference Recording Available event is sent to the URL once the recording is available for download, indicating the
mediaUrl and if there was any issue processing the recording. BXML returned in response to this callback will be ignored.
transcriptionAvailableUrl attribute is specified for a call recording, then the Transcription Available event is sent to the URL once the transcription is available for download. BXML returned in response to this callback will be ignored. Note that this attribute will be silently ignored if recording a conference.
multiChannel attribute is
true on a call recording, then the resulting recording will have 2 audio channels. Note that this option is ignored on conference recordings.
The caller/called party will be recorded in channel 0 (left channel) while
<SpeakSentence> will be recorded in channel 1 (right channel).
<Transfer> the A-leg will be recorded in channel 0 (left channel) while the B-leg will be recorded in channel 1 (right channel).
Only one <StartRecording> verb may be active at a time. If a second <StartRecording> verb is used without first using a <StopRecording> verb, the second <StartRecording> will be ignored.
|Webhooks||Can reply with more BXML|
|Conference Recording Available||No|