Struct PlayToneIntoConnectionRequest

Namespace

Vonage.Video.Sip.PlayToneIntoConnection

Assembly

Vonage.dll

Represents a request to play a tone for a specific participant of a session.

[Builder(new string[] { })]
public readonly struct PlayToneIntoConnectionRequest : IVonageRequest, IHasApplicationId, IHasSessionId, IHasConnectionId

Implements

IVonageRequest

IHasApplicationId

IHasSessionId

IHasConnectionId

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

ApplicationId

The Vonage Application UUID.

[JsonIgnore]
[Mandatory(0)]
public Guid ApplicationId { get; }

Property Value

Guid

ConnectionId

The connection Id.

[JsonIgnore]
[Mandatory(2)]
public string ConnectionId { get; }

Property Value

string

Digits

Sets the string of DTMF digits to send. This can include 0-9, '*', '#', and 'p'. A 'p' indicates a pause of 500ms (if you need to add a delay in sending the digits).

[Mandatory(3)]
public string Digits { get; }

Property Value

string

Examples

.WithDigits("1234#")

SessionId

The session Id.

[JsonIgnore]
[Mandatory(1)]
public string SessionId { get; }

Property Value

string

Methods

Build()

public static IBuilderForApplicationId Build()

Returns

IBuilderForApplicationId

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.