Class ConnectAction

Namespace

Vonage.Voice.Nccos

Assembly

Vonage.dll

Represents an NCCO Connect action that connects the call to another endpoint (phone, SIP, WebSocket, app user, or VBC extension).

public class ConnectAction : NccoAction

Inheritance

object

NccoAction

ConnectAction

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

Action

The type of NCCO action to execute.

public override NccoAction.ActionType Action { get; }

Property Value

NccoAction.ActionType

AdvancedMachineDetection

Configure the behavior of Vonage's advanced machine detection. Overrides machineDetection if both are set.

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

Property Value

AdvancedMachineDetectionProperties

Endpoint

Connect to a single endpoint.

[JsonProperty("endpoint", Order = 0)]
public Endpoint[] Endpoint { get; set; }

Property Value

Endpoint[]

EventMethod

The HTTP method Vonage uses to make the request to eventUrl. The default value is POST.

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

Property Value

string

EventType

Set to synchronous to: make the connect action synchronous enable eventUrl to return an NCCO that overrides the current NCCO when a call moves to specific states.

[JsonProperty("eventType", Order = 2)]
public string EventType { get; set; }

Property Value

string

EventUrl

Set the webhook endpoint that Vonage calls asynchronously on each of the possible Call States. If eventType is set to synchronous the eventUrl can return an NCCO that overrides the current NCCO when a timeout occurs.

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

Property Value

string[]

From

A number in E.164 format that identifies the caller. This must be one of your Vonage virtual numbers, another value will result in the caller ID being unknown. If the caller is an app user, this option should be omitted.

[JsonProperty("from", Order = 1)]
public string From { get; set; }

Property Value

string

Limit

Maximum length of the call in seconds. The default value is 7200 seconds (2 hours).

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

Property Value

string

MachineDetection

Configure the behavior when Vonage detects that a destination is an answerphone. Set to either: continue - Vonage sends an HTTP request to event_url with the Call event machine hangup - end the Call

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

Property Value

string

RingbackTone

A URL value that points to a ringbackTone to be played back on repeat to the caller, so they don't hear silence. The ringbackTone will automatically stop playing when the call is fully connected. It's not recommended to use this parameter when connecting to a phone endpoint, as the carrier will supply their own ringbackTone. Example: "ringbackTone": "http://example.com/ringbackTone.wav".

[JsonProperty("ringbackTone", Order = 8)]
public string RingbackTone { get; set; }

Property Value

string

Timeout

If the call is unanswered, set the number in seconds before Vonage stops ringing endpoint. The default value is 60.

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

Property Value

string