Updates: Check the release notes for new features and product updates.

Method: phones.agentEvents.create

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).

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.

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.