Udostępnij za pośrednictwem

OptOutsClient.CheckAsync Method

  • Reference

Definition

Namespace:
Azure.Communication.Sms
Assembly:
Azure.Communication.Sms.dll
Package:
Azure.Communication.Sms v1.1.0-beta.2
Source:
OptOutsClient.cs

Checks if to phone numbers are opted out from from phone number.

public virtual System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Communication.Sms.Models.OptOutResponseItem>>> CheckAsync (string from, System.Collections.Generic.IEnumerable<string> to, System.Threading.CancellationToken cancellationToken = default);
abstract member CheckAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Communication.Sms.Models.OptOutResponseItem>>>
override this.CheckAsync : string * seq<string> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<System.Collections.Generic.IReadOnlyList<Azure.Communication.Sms.Models.OptOutResponseItem>>>
Public Overridable Function CheckAsync (from As String, to As IEnumerable(Of String), Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of IReadOnlyList(Of OptOutResponseItem)))

Parameters

from
String

The sender's phone number that is owned by the authenticated account.

to
IEnumerable<String>

The recipient's phone number.

cancellationToken
CancellationToken

The cancellation token for the task.

Returns

Task<Response<IReadOnlyList<OptOutResponseItem>>>

Exceptions

RequestFailedException

The server returned an error. See Message for details returned from the server.

ArgumentNullException

to is null.

Applies to