Struct SipElement
- Namespace
- Vonage.Video.Sip.InitiateCall
- Assembly
- Vonage.dll
Represents a SIP element.
public readonly struct SipElement- Inherited Members
Properties
Authentication
Contains the username and password to be used in the the SIP INVITE request for HTTP digest authentication, if it is required by your SIP platform.
[JsonPropertyOrder(0)]
[JsonPropertyName("auth")]
[JsonConverter(typeof(MaybeJsonConverter<SipElement.SipAuthentication>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<SipElement.SipAuthentication> Authentication { get; }Property Value
From
The number or string that will be sent to the final SIP number as the caller. It must be a string in the form of from@example.com, where from can be a string or a number. If from is set to a number (for example, "14155550101@example.com"), it will show up as the incoming number on PSTN phones. If from is undefined or set to a string (for example, "joe@example.com"), +00000000 will show up as the incoming number on PSTN phones.
[JsonPropertyOrder(1)]
[JsonConverter(typeof(MaybeJsonConverter<string>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<string> From { get; }Property Value
HasEncryptedMedia
Indicates whether the media must be transmitted encrypted. The default value is false.
[JsonPropertyOrder(4)]
[JsonPropertyName("secure")]
public bool HasEncryptedMedia { get; }Property Value
HasForceMute
Indicates whether the SIP end point observes force mute moderation. Also, with observeForceMute set to true, the caller can press"*6" to unmute and mute the published audio. For the "*6" mute toggle to work, the SIP caller must negotiate RFC2833 DTMFs (RFC2833/RFC4733 digits). The mute toggle is not supported with SIP INFO or in-band DTMFs. A message (in English) is played to the caller when the caller mutes and unmutes, or when the SIP client is muted through a force mute action. The default is false.
[JsonPropertyOrder(3)]
[JsonPropertyName("observeForceMute")]
public bool HasForceMute { get; }Property Value
HasVideo
Indicates whether the SIP call will include video. With video included, the SIP client's video is included in the Vonage Video stream that is sent to the Vonage Video session. The SIP client will receive a single composed video of the published streams in the Vonage Video session. The default value is false.
[JsonPropertyOrder(5)]
[JsonPropertyName("video")]
public bool HasVideo { get; }Property Value
Headers
Defines custom headers to be added to the SIP INVITE request initiated from Vonage Video to your SIP platform.
[JsonPropertyOrder(2)]
[JsonConverter(typeof(MaybeJsonConverter<Dictionary<string, string>>))]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingDefault)]
public Maybe<Dictionary<string, string>> Headers { get; }Property Value
Uri
The SIP URI to be used as destination of the SIP call initiated from Vonage Video to your SIP platform. If the SIP uri contains a transport=tls header, the negotiation between Vonage and the SIP endpoint will be done securely. Note that this will only apply to the negotiation itself,and not to the transmission of audio. If you also audio transmission to be encrypted, set the secure property to true.
[JsonPropertyOrder(6)]
public Uri Uri { get; }