AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Accepts a phone number and indicates whether the phone holder has opted out of receiving SMS messages from your Amazon Web Services account. You cannot send SMS messages to a number that is opted out.

To resume sending messages, you can opt in the number by using the OptInPhoneNumber action.

Note:

For .NET Core this operation is only available in asynchronous form. Please refer to CheckIfPhoneNumberIsOptedOutAsync.

Namespace: Amazon.SimpleNotificationService
Assembly: AWSSDK.SimpleNotificationService.dll
Version: 3.x.y.z

Syntax

C#
public virtual CheckIfPhoneNumberIsOptedOutResponse CheckIfPhoneNumberIsOptedOut(
         CheckIfPhoneNumberIsOptedOutRequest request
)

Parameters

request
Type: Amazon.SimpleNotificationService.Model.CheckIfPhoneNumberIsOptedOutRequest

Container for the necessary parameters to execute the CheckIfPhoneNumberIsOptedOut service method.

Return Value


The response from the CheckIfPhoneNumberIsOptedOut service method, as returned by SimpleNotificationService.

Exceptions

ExceptionCondition
AuthorizationErrorException Indicates that the user has been denied access to the requested resource.
InternalErrorException Indicates an internal service error.
InvalidParameterException Indicates that a request parameter does not comply with the associated constraints.
ThrottledException Indicates that the rate at which requests have been submitted for this action exceeds the limit for your Amazon Web Services account.

Version Information

.NET Framework:
Supported in: 4.5 and newer, 3.5

See Also