Update opt-out assist information

Use this endpoint to update opt-out information for RCS using Channel Manager API.

Example

Find the description for all variables used in each code snippet below:

KeyDescription
VONAGE_API_KEY

Your Vonage API key (see it on your dashboard).

VONAGE_API_SECRET

Your Vonage API secret (also available on your dashboard).

CHANNEL_MANAGER_RCS_AGENT_SENDER_ID

A unique sender identifier for the RCS Agent on the Vonage platform.

Prerequisites

If you do not have an application you can create one. Make sure you also configure your webhooks.

Write the code

Add the following to update-opt-out-information.sh:

curl -X POST https://api.nexmo.com/v1/channel-manager/rcs/opt-out/${CHANNEL_MANAGER_RCS_AGENT_SENDER_ID} \
  -u "${VONAGE_API_KEY}:${VONAGE_API_SECRET}" \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d $'{
   "actions": [
      {
         "keywords": [
            "STOP"
         ],
         "auto-reply": "You have opted out.",
         "action": "STOP"
      }
   ]
}'

View full source

Run your code

Save this file to your machine and run it:

bash update-opt-out-information.sh