RCS Opt-out Assist

RCS Opt-out Assist is a feature that helps brands comply with regional regulations requiring users to be able to stop receiving marketing messages or to request contact information for the brand. It enables the RCS channel to use the same Opt-out Assist service already available for SMS. With Opt-out Assist, you can easily opt out of receiving RCS messages from a brand by sending specific keywords (such as STOP).

Purpose of Opt-out Assist

Many countries enforce strict regulations around user consent and data privacy for business messaging. These rules often require that:

• Users can opt out of receiving messages at any time.
• Brands must acknowledge the opt-out (for example, with an automatic confirmation message).
• Users can request brand contact information or other support details.

By integrating with Opt-out Assist, RCS messaging via the Channel Manager API ensures compliance with these requirements.

How Opt-out assist works for RCS

When an RCS user sends a message that matches a configured opt-out keyword (for example, STOP), the Opt-out Assist service automatically processes the request. Depending on your configuration, the system can:

• Detect opt-out messages based on defined keywords.
• Send an automatic reply confirming the opt-out (e.g., “You have opted out.”).
• Update the opt-out status for the user in the system.

These behaviors are controlled through the Channel Manager API.

Managing Opt-out configuration

You can retrieve or update the opt-out settings for your RCS Agent using the Channel Manager API:

Retrieve current Opt-out settings

Make a GET request to the following endpoint, replacing CHANNEL_MANAGER_RCS_AGENT_SENDER_ID with the sender ID of the RCS agent for which opt-out information is being updated:

https://api.nexmo.com/v1/channel-manager/rcs/opt-out/:CHANNEL_MANAGER_RCS_AGENT_SENDER_ID

This returns the current configuration, including enabled actions, opt-out keywords, and auto-reply messages.

Update Opt-out settings

Make a POST request to:

https://api.nexmo.com/v1/channel-manager/rcs/opt-out/:CHANNEL_MANAGER_RCS_AGENT_SENDER_ID

with a JSON body defining the opt-out rules.

For example:

{
  "actions": [
    {
      "keywords": ["STOP"],
      "auto-reply": "You have opted out.",
      "action": "STOP"
    }
  ]
}

A successful response confirms the configuration is active:

{
  "actions": [
    {
      "keywords": ["STOP"],
      "auto-reply": "You have opted out.",
      "action": "STOP"
    }
  ],
  "enabled": true
}