new_releases Updates: Check the
release notes for new features and product updates.
Method: phones.agentMessages.delete
Stay organized with collections
Save and categorize content based on your preferences.
Revokes an agent message that has been sent but not yet delivered.
If the RBM platform successfully revokes a message, then the message is deleted from the user’s message queue and is never delivered.
This method immediately returns 200 OK, whether or not the message was successfully revoked.
There is a small chance that the agent may initiate a revocation while the RBM platform is in the process of delivering the message. In these rare cases, the agent receives a DELIVERED user event for the message shortly after initiating the revocation request.
HTTP request
DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
name |
string
"phones/{E.164}/agentMessages/{messageId}", where {E.164} is the user's phone number in E.164 format and {messageId} is the agent-assigned ID of the agent message that should be revoked. For example, with the US phone number +1-222-333-4444 and an agent message with the ID "12345xyz", the resulting endpoint would be https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz.
|
Query parameters
| Parameters |
agentId |
string
Required. The agent's unique identifier.
|
Request body
The request body must be empty.
Response body
If successful, the response body is an empty JSON object.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/rcsbusinessmessaging
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-27 UTC.
[null,null,["Last updated 2025-04-27 UTC."],[[["\u003cp\u003eThis function allows agents to revoke an undelivered message, removing it from the user's message queue.\u003c/p\u003e\n"],["\u003cp\u003eA successful message revocation results in the message being deleted and never delivered to the user, but a 200 OK response is always returned regardless of success.\u003c/p\u003e\n"],["\u003cp\u003eIn rare cases, a message revocation might be initiated while the message is being delivered, possibly leading to the agent receiving a DELIVERED event shortly after.\u003c/p\u003e\n"],["\u003cp\u003eThe revocation is performed via a DELETE request to a specific URL endpoint, which requires the user's phone number in E.164 format and the agent-assigned ID of the message.\u003c/p\u003e\n"],["\u003cp\u003eThe request requires the agent's unique identifier as a query parameter and must use the specified OAuth scope for authorization.\u003c/p\u003e\n"]]],[],null,["# Method: phones.agentMessages.delete\n\nRevokes an agent message that has been sent but not yet delivered.\n\nIf the RBM platform successfully revokes a message, then the message is deleted from the user's message queue and is never delivered.\n\nThis method immediately returns 200 OK, whether or not the message was successfully revoked.\n\nThere is a small chance that the agent may initiate a revocation while the RBM platform is in the process of delivering the message. In these rare cases, the agent receives a DELIVERED user event for the message shortly after initiating the revocation request.\n\n### HTTP request\n\n`DELETE https://rcsbusinessmessaging.googleapis.com/v1/{name=phones/*/agentMessages/*}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|--------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` \"phones/{E.164}/agentMessages/{messageId}\", where {E.164} is the user's phone number in E.164 format and {messageId} is the agent-assigned ID of the agent message that should be revoked. For example, with the US phone number +1-222-333-4444 and an agent message with the ID \"12345xyz\", the resulting endpoint would be \u003chttps://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages/12345xyz\u003e. |\n\n### Query parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------|\n| `agentId` | `string` Required. The agent's unique identifier. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body is an empty JSON object.\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/rcsbusinessmessaging`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]