Method: phones.agentEvents.create

  • Agent events are used to signal that an agent has read a user's message or is currently typing, adding a human touch to the interaction.

  • Agent events cannot be revoked once sent, unlike agent messages, which means they are a permanent record of the interaction.

  • To send an agent event, use a POST request to the specified URL, including the user's E.164 formatted phone number in the path.

  • The eventId and agentId are required as query parameters when sending an event, and eventId needs to be a UUID according to RFC4122 standards.

  • Successful agent event requests will return a new instance of the sent AgentEvent in the response body.

Sends an event from the agent to a user.

Agent events can be used to indicate that the agent has read a message from the user or that the agent is in the process of typing (which adds a human element to the RBM experience). If RBM can't reach the user, the RBM platform returns 404 NOT_FOUND.

Unlike agent messages, agent events cannot be revoked after sending.

HTTP request

POST https://rcsbusinessmessaging.googleapis.com/v1/{parent=phones/*}/agentEvents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

"phones/{E.164}", where {E.164} is the user's phone number in E.164 format. For example, for a user 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/agentEvents.

Query parameters

Parameters
eventId

string

The ID of the event, 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

string

Required. The agent's unique identifier.

Request body

The request body contains an instance of AgentEvent.

Response body

If successful, the response body contains a newly created instance of AgentEvent.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/rcsbusinessmessaging

For more information, see the OAuth 2.0 Overview.