NumberVerification.VerifyWithCodeAsync Method

Definition

Namespace:

Azure.Communication.ProgrammableConnectivity

Assembly:

Azure.Communication.ProgrammableConnectivity.dll

Package:

Azure.Communication.ProgrammableConnectivity v1.0.0-beta.1

Overloads

VerifyWithCodeAsync(String, NumberVerificationWithCodeContent, CancellationToken)	Verifies the phone number (MSISDN) associated with a device.
VerifyWithCodeAsync(String, RequestContent, RequestContext)	[Protocol Method] Verifies the phone number (MSISDN) associated with a device. This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. Please try the simpler VerifyWithCodeAsync(String, NumberVerificationWithCodeContent, CancellationToken) convenience overload with strongly typed models first.

VerifyWithCodeAsync(String, NumberVerificationWithCodeContent, CancellationToken)

Source:

NumberVerification.cs

Verifies the phone number (MSISDN) associated with a device.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Communication.ProgrammableConnectivity.NumberVerificationResult>> VerifyWithCodeAsync (string apcGatewayId, Azure.Communication.ProgrammableConnectivity.NumberVerificationWithCodeContent numberVerificationWithCodeContent, System.Threading.CancellationToken cancellationToken = default);

abstract member VerifyWithCodeAsync : string * Azure.Communication.ProgrammableConnectivity.NumberVerificationWithCodeContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.ProgrammableConnectivity.NumberVerificationResult>>
override this.VerifyWithCodeAsync : string * Azure.Communication.ProgrammableConnectivity.NumberVerificationWithCodeContent * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Communication.ProgrammableConnectivity.NumberVerificationResult>>

Public Overridable Function VerifyWithCodeAsync (apcGatewayId As String, numberVerificationWithCodeContent As NumberVerificationWithCodeContent, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of NumberVerificationResult))

Parameters

apcGatewayId

String

The identifier of the APC Gateway resource which should handle this request.

numberVerificationWithCodeContent

NumberVerificationWithCodeContent

Request to verify number of device - second call.

cancellationToken

CancellationToken

The cancellation token to use.

Returns

Task<Response<NumberVerificationResult>>

Exceptions

ArgumentNullException

apcGatewayId or numberVerificationWithCodeContent is null.

Examples

This sample shows how to call VerifyWithCodeAsync.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
NumberVerification client = new ProgrammableConnectivityClient(endpoint, credential).GetNumberVerificationClient(apiVersion: "2024-02-09-preview");

NumberVerificationWithCodeContent numberVerificationWithCodeContent = new NumberVerificationWithCodeContent("<apcCode>");
Response<NumberVerificationResult> response = await client.VerifyWithCodeAsync("<apcGatewayId>", numberVerificationWithCodeContent);

This sample shows how to call VerifyWithCodeAsync with all parameters.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
NumberVerification client = new ProgrammableConnectivityClient(endpoint, credential).GetNumberVerificationClient(apiVersion: "2024-02-09-preview");

NumberVerificationWithCodeContent numberVerificationWithCodeContent = new NumberVerificationWithCodeContent("<apcCode>");
Response<NumberVerificationResult> response = await client.VerifyWithCodeAsync("<apcGatewayId>", numberVerificationWithCodeContent);

VerifyWithCodeAsync(String, RequestContent, RequestContext)

Source:

NumberVerification.cs

[Protocol Method] Verifies the phone number (MSISDN) associated with a device.

• This protocol method allows explicit creation of the request and processing of the response for advanced scenarios.
• Please try the simpler VerifyWithCodeAsync(String, NumberVerificationWithCodeContent, CancellationToken) convenience overload with strongly typed models first.

public virtual System.Threading.Tasks.Task<Azure.Response> VerifyWithCodeAsync (string apcGatewayId, Azure.Core.RequestContent content, Azure.RequestContext context = default);

abstract member VerifyWithCodeAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>
override this.VerifyWithCodeAsync : string * Azure.Core.RequestContent * Azure.RequestContext -> System.Threading.Tasks.Task<Azure.Response>

Public Overridable Function VerifyWithCodeAsync (apcGatewayId As String, content As RequestContent, Optional context As RequestContext = Nothing) As Task(Of Response)

Parameters

apcGatewayId

String

The identifier of the APC Gateway resource which should handle this request.

content

RequestContent

The content to send as the body of the request.

context

RequestContext

The request context, which can override default behaviors of the client pipeline on a per-call basis.

Returns

Task<Response>

The response returned from the service.

Exceptions

ArgumentNullException

apcGatewayId or content is null.

RequestFailedException

Service returned a non-success status code.

Examples

This sample shows how to call VerifyWithCodeAsync and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
NumberVerification client = new ProgrammableConnectivityClient(endpoint, credential).GetNumberVerificationClient(apiVersion: "2024-02-09-preview");

using RequestContent content = RequestContent.Create(new
{
    apcCode = "<apcCode>",
});
Response response = await client.VerifyWithCodeAsync("<apcGatewayId>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("verificationResult").ToString());

This sample shows how to call VerifyWithCodeAsync with all parameters and request content and parse the result.

Uri endpoint = new Uri("<https://my-service.azure.com>");
TokenCredential credential = new DefaultAzureCredential();
NumberVerification client = new ProgrammableConnectivityClient(endpoint, credential).GetNumberVerificationClient(apiVersion: "2024-02-09-preview");

using RequestContent content = RequestContent.Create(new
{
    apcCode = "<apcCode>",
});
Response response = await client.VerifyWithCodeAsync("<apcGatewayId>", content);

JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement;
Console.WriteLine(result.GetProperty("verificationResult").ToString());