Class SipClient

Namespace

Vonage.Video.Sip

Assembly

Vonage.dll

Represents a client for handling SIP calls.

public class SipClient

Inheritance

object

SipClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

InitiateCallAsync(Result<InitiateCallRequest>)

Connects your SIP platform to an Vonage Video session.

public Task<Result<InitiateCallResponse>> InitiateCallAsync(Result<InitiateCallRequest> request)

Parameters

request Result<InitiateCallRequest>

The request.

Returns

Task<Result<InitiateCallResponse>>

Success with the response if the operation succeeds, Failure it if fails.

Examples

var request = InitiateCallRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithToken(token)
    .WithSipUri(new Uri("sip:user@sip.example.com"))
    .Create();
var result = await client.VideoClient.SipClient.InitiateCallAsync(request);

PlayToneIntoCallAsync(Result<PlayToneIntoCallRequest>)

Sends DTMF digits to all participants in an Vonage Video call.

public Task<Result<Unit>> PlayToneIntoCallAsync(Result<PlayToneIntoCallRequest> request)

Parameters

request Result<PlayToneIntoCallRequest>

The request.

Returns

Task<Result<Unit>>

Success if the operation succeeds, Failure it if fails.

Examples

var request = PlayToneIntoCallRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithDigits("1234")
    .Create();
var result = await client.VideoClient.SipClient.PlayToneIntoCallAsync(request);

PlayToneIntoConnectionAsync(Result<PlayToneIntoConnectionRequest>)

Sends DTMF digits to a single participant in an Vonage Video call.

public Task<Result<Unit>> PlayToneIntoConnectionAsync(Result<PlayToneIntoConnectionRequest> request)

Parameters

request Result<PlayToneIntoConnectionRequest>

The request.

Returns

Task<Result<Unit>>

Success if the operation succeeds, Failure it if fails.

Examples

var request = PlayToneIntoConnectionRequest.Build()
    .WithApplicationId(applicationId)
    .WithSessionId(sessionId)
    .WithConnectionId(connectionId)
    .WithDigits("1234")
    .Create();
var result = await client.VideoClient.SipClient.PlayToneIntoConnectionAsync(request);