RCS Message Revocation
When sending a RCS message via the Vonage Messages API, you can subsequently request for that message to be revoked (i.e. not delivered to the recipient's device by the downstream network).
RCS message revocation is initiated by a PATCH request to the Messages API endpoint on the message object that was created by the initial POST request to send the message. The message object is identified by its UUID (this is returned in the response to the POST request that create the message object).
The PATCH request should contain a JSON body which sets the value of status to `revoked.
You can see further details of the Messages API PATCH endpoint in the Messages API specification and view a code example for the PATCH request in the Messages API code snippets
Choosing the Right Endpoint
To send an RCS Message Revocation request to the Messages API PATCH endpoint, you will need to use the correct geo-located server for the request. This will depend on the country in which the RCS Agent has been launched. Please consult the table below as a guide for which server to use.
| Region | Server | Example Countries |
|---|---|---|
| EMEA (Europe Middle East, and Africa) | api-eu.nexmo.com | France, Spain, Portugal, South Africa, Nigeria, Norway, Sweden, Netherlands, Austria, Germany, UK, Italy |
| NA + LATAM (North America and South America) | api-us.nexmo.com | Mexico, Brazil, Canada |
| APAC (Asia-Pacific) | api-ap.nexmo.com |
Things to Note
- Making a revocation request does not guarantee that a message will be revoked (i.e. not delivered). For example, the message may already have been delivered or it may not otherwise be possibly to revoke it.
- A revocation request can only occur within 24 hours of the original message object being created.