Revoke an RCS message

Revoke a message that has been sent to a mobile device, if the message has not already been delivered.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Your unique customer key.

string
required

Target device's phone number in E.164 format.

string
required

The alphanumeric 36-character UUID identifying the message.

Query Params
string
required

Alphanumeric string identifying your agent. To get your agentId, speak to your Vibes business rep.

Responses
200

The request was successful. Note that this does not mean the message has been revoked. A webhook will be sent to the agent if the message was revoked.

403

Forbidden agent. The agentId is either not valid, or it has not deployed on the provider.

422

Unprocessable entity. Specific data errors have occurred in the request. Additional details will be available in the content of the error.

Example - Invalid Phone Number. The phone number is not a valid mobile number, or is on a unsupported carrier.

429

Quota exceeded. You've either exceeded the number of calls allowed, or a downstream server is busy. Please try your request again later.

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here!