Skip to main content


Record the call audio in the foreground. Use this, for example, to record voicemails.


stereobooleanWhether to record in stereo mode. Optional. Default false.
formatstringOptional format ("wav" or "mp3"). Default "wav".
directionstringOptional direction of the audio to record: "speak" for what party says, "listen" for what party hears. Default "speak".
terminatorsstringOptional string of digits that will stop the recording when pressed. Default "#".
beepbooleanWhether to play a beep before recording. Optional. Default false.
input_sensitivitynumberHow 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_timeoutnumberHow long, in seconds, to wait for speech to start. Optional. Default 4.0.
end_silence_timeoutnumberHow much silence, in seconds, will end the recording. Optional. Default 5.0.


Set by the method:

  • record_url: (out) the URL of the newly created recording.
  • record_result: (out) success | failed.


Record some audio and play it back

version: 1.0.0
- record:
end_silence_timeout: 5
- play: "%{record_url}"