Class SipEndpoint

Namespace

Vonage.Voice.Nccos.Endpoints

Assembly

Vonage.dll

Represents a SIP endpoint for connecting a call to a SIP URI or SIP trunk.

public class SipEndpoint : Endpoint

Inheritance

object

Endpoint

SipEndpoint

Inherited Members

Endpoint.Type

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

SipEndpoint()

public SipEndpoint()

Properties

Domain

The identifier for a trunk created using the dashboard. This must be a successfully provisioned domain using the SIP Trunking dashboard or the Programmable SIP API. The URIs provisioned in the trunk will be used along the user property to create the full SIP URI. So for example, if the URI in the trunk is: sip.example.com and user is example_user, Vonage will send the call to example_user@sip.example.com. If you set this property, you must leave uri unset. Note that this property refers to the domain name, not the domain URI.

[JsonProperty("domain")]
public string Domain { get; set; }

Property Value

string

Headers

key => value string pairs containing any metadata you need e.g. { "location": "New York City", "occupation": "developer" }

[JsonProperty("headers")]
public object Headers { get; set; }

Property Value

object

StandardHeaders

Standard SIP INVITE headers. Unlike the headers property, these are not prepended with X-.

[JsonProperty("standard_headers")]
public SipEndpoint.StandardHeader StandardHeaders { get; set; }

Property Value

SipEndpoint.StandardHeader

Uri

the SIP URI to the endpoint you are connecting to in the format sip:rebekka@sip.example.com.

[JsonProperty("uri")]
public string Uri { get; set; }

Property Value

string

User

The user component of the URI. It will be used along the domain property to create the full SIP URI. If you set this property, you must also set domain and leave uri unset.

[JsonProperty("user")]
public string User { get; set; }

Property Value

string