Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 2.35 KB

File metadata and controls

36 lines (27 loc) · 2.35 KB

RecordUtterance

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.

Properties

Name Type Description Notes
action_url str URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing.
silence_timeout_ms int Interval of silence that should elapse before ending the recording. [optional]
finish_on_key str Key that triggers the end of the recording. any digit, '#', or '*' [optional]
max_length_sec int Maximum length for the command execution in seconds. [optional]
play_beep bool Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. [optional]
auto_start bool 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]
privacy_mode bool Parameter `privacyMode` will not log the `text` as required by PCI compliance. [optional]

Example

from freeclimb.models.record_utterance import RecordUtterance

# TODO update the JSON string below
json = "{}"
# create an instance of RecordUtterance from a JSON string
record_utterance_instance = RecordUtterance.from_json(json)
# print the JSON string representation of the object
print(RecordUtterance.to_json())

# convert the object into a dict
record_utterance_dict = record_utterance_instance.to_dict()
# create an instance of RecordUtterance from a dict
record_utterance_from_dict = RecordUtterance.from_dict(record_utterance_dict)

[Back to Model list] [Back to API list] [Back to README]