The RecordUtterance
command records the caller's voice and returns the URL of a file containing the audio recording. RecordUtterance
is blocking and is a terminal command. As such, the actionUrl
property is required, and control of the Call picks up using the PerCL returned in response to the actionUrl
. Recording information is returned in the actionUrl
request.
Name | Type | Description | Notes |
---|---|---|---|
actionUrl | URI | URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing. | |
silenceTimeoutMs | Integer | Interval of silence that should elapse before ending the recording. | [optional] |
finishOnKey | String | Key that triggers the end of the recording. any digit, '#', or '*' | [optional] |
maxLengthSec | Integer | Maximum length for the command execution in seconds. | [optional] |
playBeep | Boolean | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional] |
autoStart | Boolean | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional] |
privacyMode | Boolean | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |