Class PhoneEndpoint

Namespace

Vonage.Voice.Nccos.Endpoints

Assembly

Vonage.dll

Represents a phone (PSTN) endpoint for connecting a call to a phone number.

public class PhoneEndpoint : Endpoint

Inheritance

object

Endpoint

PhoneEndpoint

Inherited Members

Endpoint.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PhoneEndpoint()

Initializes a new PhoneEndpoint with the endpoint type set to Phone.

public PhoneEndpoint()

Properties

DtmfAnswer

Set the digits that are sent to the user as soon as the Call is answered. The * and # digits are respected. You create pauses using p. Each pause is 500ms.

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

Property Value

string

Number

The phone number to connect to in E.164 format.

[JsonProperty("number", Order = 0)]
public string Number { get; set; }

Property Value

string

OnAnswer

An object containing a required url key. The URL serves an NCCO to execute in the number being connected to, before that call is joined to your existing conversation. Optionally, the ringbackTone key can be specified with a URL value that points to a ringbackTone to be played back on repeat to the caller, so they do not hear just silence. The ringbackTone will automatically stop playing when the call is fully connected. Example: {"url":"https://example.com/answer", "ringbackTone":"http://example.com/ringbackTone.wav" }. Please note, the key ringback is still supported.

[JsonProperty("onAnswer", Order = 2)]
public PhoneEndpoint.Answer OnAnswer { get; set; }

Property Value

PhoneEndpoint.Answer

Shaken

For Vonage customers who are required by the FCC to sign their own calls to the USA, we allow you to place Voice API calls with your own signature. This feature is available by request only. Please be aware calls with an invalid signature will be rejected. For more information please contact us. In this option, you must place the STIR/SHAKEN Identity Header content that Vonage must use for this call. Expected format is composed of the JWT with the header, payload and signature, an info parameter with a link for the certificate, the algorithm (alg) parameter indicating which encryption type was used and the passport type (ppt) which should be shaken.

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

Property Value

string