Package com.vonage.client.voice

Class AdvancedMachineDetection.Builder

java.lang.Object

com.vonage.client.voice.AdvancedMachineDetection.Builder

Enclosing class:

AdvancedMachineDetection

public static class AdvancedMachineDetection.Builder
extends Object

Builder for specifying the Advanced Machine Detection properties.

Method Summary

Modifier and Type	Method	Description
AdvancedMachineDetection.Builder	beepTimeout(int beepTimeout)	Maximum time in seconds Vonage should wait for a machine beep to be detected.
AdvancedMachineDetection.Builder	behavior(MachineDetection behavior)	Define how the system responds when a machine is detected.
AdvancedMachineDetection	build()	Constructs the AdvancedMachineDetection object.
AdvancedMachineDetection.Builder	mode(AdvancedMachineDetection.Mode mode)	Detect if machine answered and sends a human or machine status in the webhook payload.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

behavior

public AdvancedMachineDetection.Builder behavior(MachineDetection behavior)

Define 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.

Parameters:

behavior - The machine detection behaviour as an enum.

Returns:

This builder.

mode

public AdvancedMachineDetection.Builder mode(AdvancedMachineDetection.Mode mode)

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.

Parameters:

mode - The machine detection mode enum.

Returns:

This builder.

beepTimeout

public AdvancedMachineDetection.Builder beepTimeout(int beepTimeout)

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.

Parameters:

beepTimeout - The beep timeout in seconds as an integer.

Returns:

This builder.

build

public AdvancedMachineDetection build()

Constructs the AdvancedMachineDetection object.

Returns:

A new AdvancedMachineDetection instance with this builder's properties.