Technical Details
Opt-Out Assist is a built-in keyword management service offered by Vonage. By enabling Opt-Out Assist, you can elect to have Vonage manage mandatory HELP and STOP keywords, as well as reply messages and block-list management.
Opt-Out Assist can be enabled for SMS messages (sent via the SMS API or Messages API) and for MMS messages (sent via the Messages API).
Opt-Out Assist is currently supported in the following regions:
- USA
- Canada
Message Workflow
There are three types of messages that can be managed as part of the Opt-Out Assist message flow:
- Opt-Out request message
- Re-opt in message
- Help message
Opt-Out Request Message
When an opt-out request message is received by a Vonage number that is enabled for Opt-Out Assist, Vonage will:
- Send an auto-reply message to the sender
- Add the sender's number to a block list for the Vonage number that received the message
- The initial opt-out request message will also be sent to the inbound message webhook that you have configured for the channel
Note: The STOP management applies only to the number the end user texts STOP to. If you are sending from a pool of numbers, you will need to manage any additional blocks or allow lists related to other numbers in the pool.
Re-opt in Message
When an opt-in message is received by a Vonage number that is enabled for Opt-Out Assist, Vonage will:
- Send an auto-reply message to the sender
- Remove the sender's number to a block list for the Vonage number that received the message
- The initial opt-in request message will also be sent to the inbound message webhook that you have configured for the channel
Help Message
When a help message is received by a Vonage number that is enabled for Opt-Out Assist, Vonage will:
- Send an auto-reply message to the sender
- The initial help message will also be sent to the inbound message webhook that you have configured for the channel
Learn More
Learn more about working with Opt-Out Assist by visiting the guides below.
- Enabling Opt-Out Assist: Learn how to enable Opt-Out Assist for different account and number types.
- Keyword Set-up: Learn more about Opt-Out Assist keywords and how to set them up.
- Messaging Opted-out Numbers: Learn about API responses when messaging opted out numbers.