# Opt-out lists in AWS End User Messaging SMS Opt-Out lists An *opt-out list* is list of destination phone numbers that should not have messages sent to them. When you send SMS messages, destination identities are automatically added to the opt-out list if they reply to your originator phone number with the keyword STOP (unless you enable the self-managed opt-out option). If you attempt to send a message to a destination number that is on an opt-out list, and the opt-out list is associated with the phone number used to send the message, AWS End User Messaging SMS doesn't attempt to send the message. If a phone number is in the opt-out list then the message is not sent, regardless if there is an [override to allow](protect-rule-override.md#protect-rule-override.title) the phone number to receive messages. The phone number has to be removed from the opt-out list for it start receiving messages again. By default, opt-outs are managed by AWS automatically. You can choose to disable this automatic opt-out handling by enabling self-managed opt-outs. Your account can contain both numbers for which opt-outs are managed by AWS, and numbers for which you manage opt-outs yourself. **Topics** + [Required opt-out list keywords](opt-out-list-keywords.md) + [ # Self managed opt-outs ](opt-out-list-self-managed.md) + [Set up self managed opt-outs](opt-out-list-managed.md) + [Create an opt-out list](opt-out-list-create.md) + [View origination identities](opt-out-list-originators.md) + [View the details of an opt-out list](opt-out-list-view.md) + [Add a destination phone number to an opt-out list](opt-out-list-add-phone-number.md) + [Search for a destination phone number](opt-out-list-search.md) + [Remove a destination phone number](opt-out-list-remove-phone-number.md) + [Delete an opt-out list](opt-out-list-delete.md) + [Manage tags for an opt-out list](opt-out-list-tags.md) + [List shared opt-out lists](opt-out-list-shared.md) # Required AWS End User Messaging SMS opt-out list keywords Required opt-out list keywords Where required by local laws and regulations (such as in the US and Canada), SMS and MMS recipients can use their devices to opt out by replying to the message with any of the following: + ARRET + CANCEL + END + OPT-OUT + OPTOUT + QUIT + REMOVE + STOP + TD + UNSUBSCRIBE To opt out, the recipient must reply to the same long code or short code that AWS End User Messaging SMS used to deliver the message. After opting out, the recipient no longer receives SMS or MMS messages from your AWS account. **Note** For US toll-free numbers, opt-outs are managed at the carrier level. The only supported opt-out keyword for a US toll-free number is STOP. You can't add additional opt-out keywords, or change the response message that your recipients get when they opt-out. # Self managed opt-outs By default, when a customer sends a message that begins with *HELP* or *STOP* to one of your dedicated numbers, AWS End User Messaging SMS automatically replies with a customizable message. In the case of incoming STOP messages, AWS End User Messaging SMS also opts the customer out of receiving future SMS messages. If you prefer to manage HELP and STOP responses by using a service other than AWS End User Messaging SMS, you can enable self-managed opt-outs. When you enable this feature, there are three changes to the way that AWS End User Messaging SMS handles incoming messages that your customers sends. First, it stops sending automatic responses to incoming HELP and STOP messages. Second, AWS End User Messaging SMS stops automatically opting your customers out of receiving future SMS and MMS messages when they send a STOP message. And finally, it routes incoming HELP and STOP messages to the Amazon SNS topic that you use to receive two-way SMS messages, rather than responding to the sender automatically. If you enable this feature, you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. **Important** Many countries, regions, and jurisdictions impose severe penalties for sending unwanted SMS messages. If you enable this feature, make sure you have systems and processes in place for capturing and managing opt-out requests. **Note** To enable self-managed opt-outs for a pool or phone number, you must first enable two-way SMS messaging. Self-managed opt-outs are not supported when using Amazon Connect for two-way SMS. For more information on using Amazon Connect with two-way SMS messaging, see [Set up SMS messaging](https://docs.aws.amazon.com/connect/latest/adminguide/setup-sms-messaging.html) in the *Amazon Connect administrator guide*. # Set up self managed opt-outs for a phone pool or phone number in AWS End User Messaging SMS Set up self managed opt-outs If you enable this feature, you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests. ------ #### [ Turn on self managed opt-outs for a phone pool (Console) ] 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Phone pools**. 1. On the **Phone Pools** page, choose the pool. 1. On the **Opt-out list** tab, choose **Edit settings**. 1. On the **Opt-out management** page, choose **Enable self-managed opt-out** and then **Save changes**. ------ #### [ Turn on self managed opt-outs for a phone number (Console) ] 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Phone numbers**. 1. On the **Numbers** page, choose the phone number. 1. On the **Opt-out list** tab, choose the **Edit settings** button. 1. On the **Opt-out management** page, choose **Enable self-managed opt-out** and then **Save changes**. ------ # Create an opt-out list in AWS End User Messaging SMS Create an opt-out list Use the AWS End User Messaging SMS console or AWS CLI to create an opt-out list. ------ #### [ Create opt-out list (Console) ] To create an opt-out list using the AWS End User Messaging SMS console, follow these steps: 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out lists**. 1. On the **Opt-out lists** page, choose an opt-out list and then choose **Edit**. 1. On the **List details** page enter a **List name**. 1. Choose **Create list**. ------ #### [ Create opt-out list (AWS CLI) ] At the command line, enter the following command: ``` $ aws pinpoint-sms-voice-v2 create-opt-out-list \ > --opt-out-list-name optOutListName ``` In the preceding example, replace *optOutListName* with a name that makes the opt-out list easy to identify. ------ # View all origination identities associated with an opt-out list in AWS End User Messaging SMS View origination identities You can view all of the origination identities that are linked to the opt-out list using the AWS End User Messaging SMS console, follow these steps: 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out lists**. 1. On the **Opt-out lists** page, choose an opt-out list. 1. Choose **Linked origination numbers** to view all origination identities. # View the details of an opt-out list in AWS End User Messaging SMS View the details of an opt-out list Use the AWS End User Messaging SMS console or AWS CLI to manage your opt-out lists. ------ #### [ View opt-out list (Console) ] To view an opt-out list using the AWS End User Messaging SMS console, follow these steps: 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out lists**. 1. On the **Opt-out lists** page, choose an opt-out list and view the **Opt-out list details**. ------ #### [ Describe opt-out lists (AWS CLI) ] You can use the [describe-opt-out-lists](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-opt-out-lists.html) command to view information about the opt-out lists in your AWS End User Messaging SMS account. **To view information about all of your opt-out lists using the AWS CLI** + At the command line, enter the following command: ``` $ aws pinpoint-sms-voice-v2 describe-opt-out-lists ``` You can also view information about specific opt-out lists by using the `OptOutListNames` parameter. **To view information about specific opt-out lists using the AWS CLI** + At the command line, enter the following command: ``` $ aws pinpoint-sms-voice-v2 describe-opt-out-lists \ > --opt-out-list-names optOutListName ``` In the preceding command, replace *optOutListName* with the name or Amazon Resource Name (ARN) of the opt-out list that you want to find more information about. You can also specify multiple opt-out lists by separating each list name with a space. The AWS CLI returns the following information about all of the opt-out lists in your account. ------ # Add a destination phone number to an opt-out list in AWS End User Messaging SMS Add a destination phone number to an opt-out list Use the AWS End User Messaging SMS console or AWS CLI to add a destination phone number to an opt-out list. When you add a phone number to an opt-out list that phone number will no longer receive messages sent from an origination identity that is linked to the opt-out list. ------ #### [ Add a destination number (Console) ] 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out lists**. 1. On the **Opt-out lists** page, choose an opt-out list. 1. On the **Opted-out numbers** tab, choose **Add number**. 1. On the **Add opt-out number** page, for **Destination number** enter in the phone number to add to the opt-out list. The phone number must be in E.164 format, for example \$112065550150. 1. Choose **Add number** ------ #### [ Add a destination number (AWS CLI) ] You can use the [put-opted-out-number](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/put-opted-out-number.html) command add a phone number to an opt-out list. At the command line, enter the following command: ``` $ aws pinpoint-sms-voice-v2 put-opted-out-number \ > --opt-out-list-name optOutListName \ > --opted-out-number +12065550123 ``` In the preceding example, make the following changes: + Replace *optOutListName* with the name or Amazon Resource Name (ARN) of the opt-out list that you want to add the destination identity to. + Replace *\$112065550123* with phone number that you want to add to the opt-out list. The phone number must be formatted in E.164 format. ------ # Search an opt-out list for a destination phone number in AWS End User Messaging SMS Search for a destination phone number Use the AWS End User Messaging SMS console to search an opt-out list to see if it contains a destination number. 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out lists**. 1. On the **Opt-out lists** page, choose an opt-out list. 1. On the **Opted-out numbers** tab enter a phone number into the search field. The phone number must be in E.164 format, for example **\$112065550149**. 1. Choose **Search**. # Remove a destination phone number from an opt-out list in AWS End User Messaging SMS Remove a destination phone number Use the AWS End User Messaging SMS console or AWS CLI to remove destination phone numbers from an opt-out list. When you remove a phone number that phone number will receive messages sent from an origination identity that is linked to the opt-out list. ------ #### [ Remove a destination number (Console) ] 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out lists**. 1. On the **Opt-out lists** page, choose an opt-out list. 1. On the **Opted-out numbers** tab enter the phone number to remove and then **Search**. 1. If the phone number is found use it can be removed from the opt-out list by using **Remove number**. 1. In the **Remove opted-out number** window enter **release** and then **Remove number**. ------ #### [ Remove a destination number (AWS CLI) ] You can use the [delete-opted-out-number](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/delete-opted-out-number.html) command remove a phone number to an opt-out list. At the command line, enter the following command: ``` $ aws pinpoint-sms-voice-v2 delete-opted-out-number \ > --opt-out-list-name optOutListName \ > --opted-out-number +12065550123 ``` In the preceding example, make the following changes: + Replace *optOutListName* with the name or Amazon Resource Name (ARN) of the opt-out list that you want to add the destination identity to. + Replace *\$112065550123* with phone number that you want to add to the opt-out list. The phone number must be formatted in E.164 format. ------ # Delete an opt-out list in AWS End User Messaging SMS Delete an opt-out list Use the AWS End User Messaging SMS console or AWS CLI to delete an opt-out list. ------ #### [ Delete opt-out list (Console) ] To delete an opt-out list using the AWS End User Messaging SMS console, follow these steps: 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out lists**. 1. On the **Opt-out lists** page, choose an opt-out list, choose **Delete**. ------ #### [ Delete opt-out list (AWS CLI) ] You can use the [delete-opt-out-list](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/delete-opt-out-list.html) command to delete an opt-out list At the command line, enter the following command: ``` $ aws pinpoint-sms-voice-v2 delete-opt-out-list \ > --opt-out-list-name optOutListName ``` In the preceding example, replace *optOutListName* with a name that makes the opt-out list easy to identify. ------ # Manage tags for an opt-out list in AWS End User Messaging SMS Manage tags for an opt-out list Tags are pairs of keys and values that you can optionally apply to your AWS resources to control access or usage. Adding a tag to a resource can help you categorize and manage resources in different ways, such as by purpose, owner, environment, or other criteria. You can use tags to easily find existing resources, or to control which users can access specific resources. ------ #### [ Manage tags (Console) ] Use the AWS End User Messaging SMS console to add or edit a Tag in your pool. **Manage tags (Console)** 1. Open the AWS End User Messaging SMS console at [https://console.aws.amazon.com/sms-voice/](https://console.aws.amazon.com/sms-voice/). 1. In the navigation pane, under **Configurations**, choose **Opt-out list**. 1. On the **Opt-out lists** page, choose the opt-out list to add a tag to. 1. On the **Tags** tab, choose **Manage tags**. + **Add a tag** – In **Manage tags**, choose **Add new tag** to create a new blank key/value pair. + **Delete a tag** – In **Manage tags**, choose **Remove** next to the key/value pair. + **Edit a tag** – In **Manage tags**, choose the **Key** or **Value** and edit the text. 1. Choose **Save changes**. ------ #### [ Manage tags (AWS CLI) ] Use the AWS CLI to add or edit a Tag. ``` $ aws pinpoint-sms-voice-v2 tag-resource \ --resource-arn resource-arn \ --tags tags={key1=value1,key2=value2} ``` In the preceding example, do the following: + Replace *resource-arn* with the Amazon Resource Name (ARN) that you want to add the tags to. + Replace *key1* and *key2* with the keys of the tags that you want to add to the resource. + Replace *value1* and *value2* with the values of the tags that you want to add for the respective keys. Use the AWS CLI to delete a Tag. ``` $ aws pinpoint-sms-voice-v2 untag-resource \ --resource-arn resource-arn \ --tag-keys tags={key1=value1,key2=value2} ``` In the preceding example, do the following: + Replace *resource-arn* with the Amazon Resource Name (ARN) that you want to remove the tag from. + Replace *key1* and *key2* with the keys of the tags that you want to remove. + Replace *value1* and *value2* with the values of the tags that you want to remove. ------ # List shared opt-out lists with the AWS CLI List shared opt-out lists You can use the [describe-opt-out-lists](https://docs.aws.amazon.com/cli/latest/reference/pinpoint-sms-voice-v2/describe-opt-out-lists.html) to view opt-out lists shared with your account. For more information about shared resources, see [Working with shared resources in AWS End User Messaging SMS](shared-resources.md). **To list all opt-out lists shared with your account using the AWS CLI** + At the command line, enter the following command: ``` $ aws pinpoint-sms-voice-v2 describe-opt-out-lists --owner SHARED ``` In the preceding command, replace *SHARED* with *SELF* to list the opt-out lists owned by your account.