Class CallCommand

Namespace

Vonage.Voice

Assembly

Vonage.dll

Represents a request to create an outbound voice call via the Voice API.

public class CallCommand

Inheritance

object

CallCommand

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AdvancedMachineDetection

Configures advanced machine detection behavior. Overrides MachineDetection if both are set. When enabled, Vonage detects whether a human or machine answered and reports the result via webhook.

[JsonProperty("advanced_machine_detection", Order = 8)]
public AdvancedMachineDetectionProperties AdvancedMachineDetection { get; set; }

Property Value

AdvancedMachineDetectionProperties

AnswerMethod

The HTTP method used to fetch the NCCO from AnswerUrl. Default is "GET". Possible values: "GET" or "POST".

[JsonProperty("answer_method", Order = 4)]
public string AnswerMethod { get; set; }

Property Value

string

AnswerUrl

The webhook endpoint where you provide the NCCO that governs this call. Vonage requests this URL as soon as the call is answered. Mutually exclusive with Ncco.

[JsonProperty("answer_url", Order = 3)]
public string[] AnswerUrl { get; set; }

Property Value

string[]

EventMethod

The HTTP method used to send event information to EventUrl. Default is "POST". Possible values: "GET" or "POST".

[JsonProperty("event_method", Order = 6)]
public string EventMethod { get; set; }

Property Value

string

EventUrl

The webhook endpoint where call progress events are sent asynchronously when the call status changes. Required unless configured at the application level.

[JsonProperty("event_url", Order = 5)]
public string[] EventUrl { get; set; }

Property Value

string[]

From

The phone endpoint to use as the caller ID. Mutually exclusive with RandomFromNumber.

[JsonProperty(Required = Required.Always, PropertyName = "from", Order = 1)]
public PhoneEndpoint From { get; set; }

Property Value

PhoneEndpoint

LengthTimer

The number of seconds that elapse before Vonage hangs up after the call state changes to "answered". Range: 1-86400. Default is 7200 (two hours).

[JsonProperty("length_timer", Order = 9)]
public uint? LengthTimer { get; set; }

Property Value

uint?

MachineDetection

Configures behavior when Vonage detects an answering machine. Set to "continue" to receive a machine event via webhook, or "hangup" to end the call. Overridden by AdvancedMachineDetection if both are set.

[JsonProperty("machine_detection", Order = 7)]
public string MachineDetection { get; set; }

Property Value

string

Ncco

An inline NCCO to execute when the call is answered. Mutually exclusive with AnswerUrl.

[JsonProperty("ncco", Order = 2)]
public Ncco Ncco { get; set; }

Property Value

Ncco

RandomFromNumber

Set to true to use a random phone number from your application's assigned numbers as the caller ID. Mutually exclusive with From.

[JsonProperty("random_from_number", Order = 11)]
public bool? RandomFromNumber { get; set; }

Property Value

bool?

RingingTimer

The number of seconds that elapse before Vonage hangs up after the call state changes to "ringing". Range: 1-120. Default is 60.

[JsonProperty("ringing_timer", Order = 10)]
public uint? RingingTimer { get; set; }

Property Value

uint?

To

The destination endpoints to call. Supports phone numbers, SIP URIs, WebSocket endpoints, app users, and VBC extensions.

[JsonProperty(Required = Required.Always, PropertyName = "to", Order = 0)]
public Endpoint[] To { get; set; }

Property Value

Endpoint[]