Package com.vonage.client.voice

Class AdvancedMachineDetection

java.lang.Object

com.vonage.client.JsonableBaseObject

com.vonage.client.voice.AdvancedMachineDetection

All Implemented Interfaces:

Jsonable

public class AdvancedMachineDetection
extends JsonableBaseObject

Configure the behavior of Vonage's advanced machine detection. See the documentation for details.

Since:

7.4.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AdvancedMachineDetection.Builder	Builder for specifying the Advanced Machine Detection properties.
static enum	AdvancedMachineDetection.Mode	Represents the beep detection mode.

Method Summary

Modifier and Type	Method	Description
static AdvancedMachineDetection.Builder	builder()	Entry point for constructing an instance of this class.
Integer	getBeepTimeout()	Maximum time in seconds Vonage should wait for a machine beep to be detected.
MachineDetection	getBehavior()	Defines how the system responds when a machine is detected.
AdvancedMachineDetection.Mode	getMode()	Detect if machine answered and sends a human or machine status in the webhook payload.

Methods inherited from class com.vonage.client.JsonableBaseObject

createJsonObjectMapper, equals, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.vonage.client.Jsonable

toJson, updateFromJson

Method Details

getBehavior

public MachineDetection getBehavior()

Defines how the system responds when a machine is detected. When MachineDetection.HANGUP is used, the call will be terminated if a machine is detected. When MachineDetection.CONTINUE is used, the call will continue even if a machine is detected.

Returns:

The machine detection behaviour as an enum.

getMode

public AdvancedMachineDetection.Mode getMode()

Detect if machine answered and sends a human or machine status in the webhook payload. When set to AdvancedMachineDetection.Mode.DETECT_BEEP, the system also attempts to detect voice mail beep and sends an additional parameter sub_state in the webhook with the value beep_start.

Returns:

The machine detection mode.

getBeepTimeout

public Integer getBeepTimeout()

Maximum time in seconds Vonage should wait for a machine beep to be detected. A machine event with sub_state set to beep_timeout will be sent if the timeout is exceeded.

Returns:

The maximum wait time in seconds for machine detection, or null if unset.

builder

public static AdvancedMachineDetection.Builder builder()

Entry point for constructing an instance of this class.

Returns:

A new builder.