Sends a message from the agent to a user.
The user must be RCS enabled and reachable by the RBM platform in order for the agent to successfully send a message. When the message has been successfully sent, the call returns with no error. Otherwise, the agent receives an error code.
If the user is online, the RBM platform delivers the message right away. Otherwise, the RBM platform queues the message and delivered it when the user is next online.
The RBM platform ignores any agent message sent with an ID that was used by an earlier message or event sent from the same agent.
Agent messages can be revoked between the time that they are sent and the time that they are delivered.
HTTP request
POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentMessages
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters | |
|---|---|
parent |
"phones/{E.164}", where {E.164} is the user's phone number in E.164 format. For example, with the US phone number +1-222-333-4444, the value would be phones/+12223334444, and the resulting endpoint would be https://rcsbusinessmessaging.googleapis.com/v1/phones/+12223334444/agentMessages. |
Query parameters
| Parameters | |
|---|---|
messageId |
The unique ID of the message, assigned by the agent. This must be a UUID, as defined in https://tools.ietf.org/html/rfc4122. The RBM platform ignores any agent message sent with an ID that was used by an earlier message or event sent from the same agent. |
agentId |
Required. The agent's unique identifier. |
Request body
The request body contains an instance of AgentMessage.
Response body
If successful, the response body contains a newly created instance of AgentMessage.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/rcsbusinessmessaging
For more information, see the OAuth 2.0 Overview.