XML: <Record>

The Record verb allows a segment of audio to be recorded during a call. At the end of the recording, a Record Complete event is generated.

Attributes

Attribute Description
recordCompleteUrl (optional) URL to send the Record Complete event to once it has ended. Accepts BXML.
recordCompleteMethod (optional) The HTTP method to use for the request to recordCompleteUrl. GET or POST. Default value is POST.
recordingAvailableUrl (optional) URL to send the Recording Available event to once it has been processed. Does not accept BXML.
recordingAvailableMethod (optional) The HTTP method to use for the request to recordingAvailableUrl. GET or POST. Default value is POST.
username (optional) The username to send in the HTTP request to recordCompleteUrl or recordingAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
password (optional) The password to send in the HTTP request to recordCompleteUrl or recordingAvailableUrl. If specified, the URLs must be TLS-encrypted (i.e., https).
tag (optional) A custom string that will be sent with this and all future callbacks unless overwritten by a future tag attribute or cleared.

May be cleared by setting tag=""

Max length 256 characters.
terminatingDigits (optional) When pressed, this digit will terminate the recording. Default value is “#”.
maxDuration (optional) Maximum length of recording (in seconds). Max 10800 (3 hours). Default value is 60.
fileFormat (optional) The audio format that the recording will be saved as: mp3 or wav. Default value is wav.

The caller can press one of the terminatingDigits to stop the recording.

A maxDuration can be specified to stop recording after a specified period of time.

If the recordCompleteUrl attribute is specified, then the Recording Complete event is sent to the recordCompleteUrl and the BXML returned by that callback is executed next and all verbs following the <Record> tag will be ignored. If no recordCompleteUrl is specified, execution of verbs following the <Record> tag continues. The recording will still be available on the server.

If the recordingAvailableUrl attribute is specified, then the Recording Available event is sent to the URL once the recording is available for download. BXML returned in response to this callback will be ignored.

Callbacks Received

Callbacks Can reply with more BXML
Record Complete Yes
Recording Available No

Example 1 of 1: Record Verb

This shows how to use Bandwidth XML to record a phone call.

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <SpeakSentence voice="bridget">Please leave your message after the beep</SpeakSentence>
    <PlayAudio>http://audio.url/beep.wav</PlayAudio>
    <Record recordCompleteUrl="https://myapp.com/nextBXML" maxDuration="10"/>
    <!-- Any verbs after this point would be replaced by those returned by the recordCompleteUrl -->
</Response>

//coming soon
;
#coming soon
# coming soon

results matching ""

    No results matching ""