record_call
Record call in the background.
Parameters
Name | Type | Description |
---|---|---|
control_id | string | Optional identifier for this recording, to use with stop_call_record . Default is generated and saved to record_control_id variable. |
stereo | boolean | Whether to record in stereo mode. Optional. Default false . |
format | string | Optional format ("wav" or "mp3" ). Default "wav" . |
direction | string | Optional direction of the audio to record: "speak" for what party says, "listen" for what party hears, "both" for what the party hears and says. Default "both" . |
terminators | string | Optional string of digits that will stop the recording when pressed. Default is unset. |
beep | boolean | Whether to play a beep before recording. Optional. Default false . |
input_sensitivity | number | How sensitive the recording voice activity detector is to background noise. A larger value is more sensitive. Allowed values from 0.0 to 100.0 . Optional. Default 44.0 . |
initial_timeout | number | How long, in seconds, to wait for speech to start. Optional. Default 0. |
end_silence_timeout | number | How much silence, in seconds, will end the recording. Optional. Default 0. |
Variables
Set by the method:
- record_call_url: (out) the URL of the newly started recording.
- record_call_result: (out)
success
|failed
. - record_control_id: (out) control ID of this recording.
Examples
Start an MP3 recording of the call
- YAML
- JSON
version: 1.0.0
sections:
main:
- record_call:
format: mp3
{
"version": "1.0.0",
"sections": {
"main": [{ "record_call": { "format": "mp3" } }]
}
}