Struct CancelRequest

Namespace

Vonage.VerifyV2.Cancel

Assembly

Vonage.dll

Represents a request to cancel an in-progress verification. Cancellation is only possible 30 seconds after the request started and before the second delivery event has occurred.

public readonly struct CancelRequest : IVonageRequest

Implements

IVonageRequest

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Properties

RequestId

The unique identifier (UUID) of the verification request to cancel.

public Guid RequestId { get; }

Property Value

Guid

Methods

BuildRequestMessage()

Converts the request to a HttpRequest.

public HttpRequestMessage BuildRequestMessage()

Returns

HttpRequestMessage

The Http request.

Parse(Guid)

Creates a new cancellation request.

public static Result<CancelRequest> Parse(Guid requestId)

Parameters

requestId Guid

The UUID of the verification request to cancel (obtained from StartVerificationResponse.RequestId).

Returns

Result<CancelRequest>

A Result<T> containing the request if successful, or validation errors if the ID is empty.

Examples

var request = CancelRequest.Parse(Guid.Parse("c11236f4-00bf-4b89-84ba-88b25df97315"));
var response = await client.CancelAsync(request);

See Also

More examples in the snippets repository