Class AdvancedMachineDetectionProperties

Namespace

Vonage.Voice

Assembly

Vonage.dll

Represents the properties for Advanced Machine Detection.

public record AdvancedMachineDetectionProperties : IEquatable<AdvancedMachineDetectionProperties>

Inheritance

object

AdvancedMachineDetectionProperties

Implements

IEquatable<AdvancedMachineDetectionProperties>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

AdvancedMachineDetectionProperties(MachineDetectionBehavior, MachineDetectionMode, int)

Constructor for AdvancedMachineDetectionProperties.

public AdvancedMachineDetectionProperties(AdvancedMachineDetectionProperties.MachineDetectionBehavior behavior, AdvancedMachineDetectionProperties.MachineDetectionMode mode, int beepTimeout)

Parameters

behavior AdvancedMachineDetectionProperties.MachineDetectionBehavior

When hangup is used, the call will be terminated if a machine is detected. When continue is used, the call will continue even if a machine is detected.

mode AdvancedMachineDetectionProperties.MachineDetectionMode

Detect if machine answered and sends a human or machine status in the webhook payload. When set to 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.

beepTimeout int

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.

Exceptions

VonageException

When Beep Timeout is lower than 45, or higher than 120.

Properties

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.

[JsonProperty("beep_timeout", Order = 2)]
public int BeepTimeout { get; }

Property Value

int

Behavior

When hangup is used, the call will be terminated if a machine is detected. When continue is used, the call will continue even if a machine is detected.

[JsonProperty("behavior", Order = 0, DefaultValueHandling = DefaultValueHandling.Include)]
[JsonConverter(typeof(StringEnumConverter))]
public AdvancedMachineDetectionProperties.MachineDetectionBehavior Behavior { get; }

Property Value

AdvancedMachineDetectionProperties.MachineDetectionBehavior

Mode

Detect if machine answered and sends a human or machine status in the webhook payload. When set to 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.

[JsonProperty("mode", Order = 1, DefaultValueHandling = DefaultValueHandling.Include)]
[JsonConverter(typeof(StringEnumConverter))]
public AdvancedMachineDetectionProperties.MachineDetectionMode Mode { get; }

Property Value

AdvancedMachineDetectionProperties.MachineDetectionMode