Skip to content

Latest commit

 

History

History
49 lines (42 loc) · 3.77 KB

MachineDetectionConfiguration.md

File metadata and controls

49 lines (42 loc) · 3.77 KB

MachineDetectionConfiguration

The machine detection request used to perform <a href='/docs/voice/guides/machineDetection'>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 undefined]
detectionTimeout number 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]
silenceTimeout number If no speech is detected in this period, a callback with a &#39;silence&#39; result is sent. [optional] [default to 10]
speechThreshold number When speech has ended and a result couldn&#39;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 &#39;answering-machine&#39;. If the length of speech detected is below this threshold, the result will be &#39;human&#39;. [optional] [default to 10]
speechEndThreshold number Amount of silence (in seconds) before assuming the callee has finished speaking. [optional] [default to 5]
machineSpeechEndThreshold number 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] [default to undefined]
delayResult boolean If set to &#39;true&#39; and if an answering machine is detected, the &#39;answering-machine&#39; callback will be delayed until the machine is done speaking, or an end of message tone is detected, or until the &#39;detectionTimeout&#39; is exceeded. If false, the &#39;answering-machine&#39; result is sent immediately. [optional] [default to false]
callbackUrl string The URL to send the &#39;machineDetectionComplete&#39; webhook when the detection is completed. Only for &#39;async&#39; mode. [optional] [default to undefined]
callbackMethod CallbackMethodEnum [optional] [default to undefined]
username string Basic auth username. [optional] [default to undefined]
password string Basic auth password. [optional] [default to undefined]
fallbackUrl string A fallback URL which, if provided, will be used to retry the machine detection complete webhook delivery in case `callbackUrl` fails to respond [optional] [default to undefined]
fallbackMethod CallbackMethodEnum [optional] [default to undefined]
fallbackUsername string Basic auth username. [optional] [default to undefined]
fallbackPassword string Basic auth password. [optional] [default to undefined]

Example

import { MachineDetectionConfiguration } from 'bandwidth-sdk';

const instance: MachineDetectionConfiguration = {
    mode,
    detectionTimeout,
    silenceTimeout,
    speechThreshold,
    speechEndThreshold,
    machineSpeechEndThreshold,
    delayResult,
    callbackUrl,
    callbackMethod,
    username,
    password,
    fallbackUrl,
    fallbackMethod,
    fallbackUsername,
    fallbackPassword,
};

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