Suggestions

close search

Add Messaging, Voice, and Authentication to your apps with Vonage Communications APIs

Visit the Vonage API Developer Portal

OpenTokSDK.DialOptions

Used to define options for the the OpenTok.Dial method. These are custom headers to be added to the SIP ​INVITE​ request initiated from OpenTok to your SIP platform. More...

Properties

Dictionary< string, object > Headers [get, set]
 A dictionary of custom headers to be added to the SIP ​INVITE​ request initiated from OpenTok to your SIP platform. More...
DialAuth Auth [get, set]
 Contains the username and password to be used in the the SIP INVITE​ request. More...
bool? Secure [get, set]
 Indicates whether the media must be transmitted encrypted (​true​) or not (​false​, the default). More...
string From [get, set]
 The number or string that will be sent to the final SIP number as the caller. More...
bool? Video [get, set]
 Whether the SIP call will include video (​true​) or not (​false​, the default). More...
bool? ObserveForceMute [get, set]
 Whether the SIP endpoint observes force mute moderation (true) or not (false, the default). More...

Detailed Description

Used to define options for the the OpenTok.Dial method. These are custom headers to be added to the SIP ​INVITE​ request initiated from OpenTok to your SIP platform.

Property Documentation

◆ Auth

DialAuth OpenTokSDK.DialOptions.Auth

Contains the username and password to be used in the the SIP INVITE​ request.

◆ From

string OpenTokSDK.DialOptions.From

The number or string that will be sent to the final SIP number as the caller.

This must be a string in the form of "from@example.com", where from can be a string or a number. If it is set to a number (for example, "14155550101@example.com"), it will show up as the incoming number on PSTN phones. If it is undefined or set to a string (for example, "joe@example.com"), +00000000 will show up as the incoming number on PSTN phones.

◆ Headers

Dictionary<string, object> OpenTokSDK.DialOptions.Headers

A dictionary of custom headers to be added to the SIP ​INVITE​ request initiated from OpenTok to your SIP platform.

◆ ObserveForceMute

bool? OpenTokSDK.DialOptions.ObserveForceMute

Whether the SIP endpoint observes force mute moderation (true) or not (false, the default).

◆ Secure

bool? OpenTokSDK.DialOptions.Secure

Indicates whether the media must be transmitted encrypted (​true​) or not (​false​, the default).

◆ Video

bool? OpenTokSDK.DialOptions.Video

Whether the SIP call will include video (​true​) or not (​false​, the default).

With video included, the SIP client's video is included in the OpenTok stream that is sent to the Vonage Video API session. The SIP client will receive a single composed video of the published streams in the Vonage Video API session.