Skip to content

Latest commit

 

History

History
44 lines (35 loc) · 3.93 KB

MachineDetectionConfiguration.md

File metadata and controls

44 lines (35 loc) · 3.93 KB

MachineDetectionConfiguration

The machine detection request used to perform machine detection on the call. Currently, there is an issue where decimal values are not getting processed correctly. Please use whole number values. We are working to resolve this issue. Please contact Bandwidth Support if you need more information.

Properties

Name Type Description Notes
mode MachineDetectionModeEnum [optional] [default to MachineDetectionModeEnum.ASYNC]
detection_timeout float The timeout used for the whole operation, in seconds. If no result is determined in this period, a callback with a `timeout` result is sent. [optional] [default to 15]
silence_timeout float If no speech is detected in this period, a callback with a 'silence' result is sent. [optional] [default to 10]
speech_threshold float When speech has ended and a result couldn't be determined based on the audio content itself, this value is used to determine if the speaker is a machine based on the speech duration. If the length of the speech detected is greater than or equal to this threshold, the result will be 'answering-machine'. If the length of speech detected is below this threshold, the result will be 'human'. [optional] [default to 10]
speech_end_threshold float Amount of silence (in seconds) before assuming the callee has finished speaking. [optional] [default to 5]
machine_speech_end_threshold float When an answering machine is detected, the amount of silence (in seconds) before assuming the message has finished playing. If not provided it will default to the speechEndThreshold value. [optional]
delay_result bool If set to 'true' and if an answering machine is detected, the 'answering-machine' callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the 'detectionTimeout' is exceeded. If false, the 'answering-machine' result is sent immediately. [optional] [default to False]
callback_url str The URL to send the 'machineDetectionComplete' webhook when the detection is completed. Only for 'async' mode. [optional]
callback_method CallbackMethodEnum [optional] [default to CallbackMethodEnum.POST]
username str Basic auth username. [optional]
password str Basic auth password. [optional]
fallback_url str A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond [optional]
fallback_method CallbackMethodEnum [optional] [default to CallbackMethodEnum.POST]
fallback_username str Basic auth username. [optional]
fallback_password str Basic auth password. [optional]

Example

from bandwidth.models.machine_detection_configuration import MachineDetectionConfiguration

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

# convert the object into a dict
machine_detection_configuration_dict = machine_detection_configuration_instance.to_dict()
# create an instance of MachineDetectionConfiguration from a dict
machine_detection_configuration_from_dict = MachineDetectionConfiguration.from_dict(machine_detection_configuration_dict)

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