AWS Code Sample
Catalog

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

CheckOptOut.java

CheckOptOut.java demonstrates how to determine whether the user of the phone number has selected to no longer receive future text messages.

/* * Copyright 2010-2019 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.example.sns; import software.amazon.awssdk.regions.Region; import software.amazon.awssdk.services.sns.SnsClient; import software.amazon.awssdk.services.sns.model.CheckIfPhoneNumberIsOptedOutRequest; import software.amazon.awssdk.services.sns.model.CheckIfPhoneNumberIsOptedOutResponse; public class CheckOptOut { public static void main(String[] args) { final String USAGE = "\n" + "CheckOptOut - look if phone number owner has opted out of receiving SMS messages\n" + "Usage: CheckOptOut <phoneNumber>\n\n" + "Where:\n" + " phoneNumber - phone number to look up. Example: +1XXX5550100\n\n"; if (args.length < 1) { System.out.println(USAGE); System.exit(1); } String phoneNumber = args[0]; SnsClient snsClient = SnsClient.builder().region(Region.US_EAST_1).build(); CheckIfPhoneNumberIsOptedOutRequest request = CheckIfPhoneNumberIsOptedOutRequest.builder() .phoneNumber(phoneNumber) .build(); CheckIfPhoneNumberIsOptedOutResponse result = snsClient.checkIfPhoneNumberIsOptedOut(request); System.out.println(result.isOptedOut() + "Phone Number " + phoneNumber + " has Opted Out of receiving sns messages." + "\n\nStatus was " + result.sdkHttpResponse().statusCode()); } }

Sample Details

Service: sns

Last tested: 2019-07-20

Author: jschwarzwalder AWS

Type: full-example

On this page: