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

UserEvent

An event that occurred on the user's RCS client and was related to a conversation with the agent.

For instance, an event can indicate that the user is typing or that an earlier message from the agent was read by the user.

The UserEvent appears in the "data" field of the "message" object that the agent receives from its Google Cloud Pub/Sub subscription. The "data" field is a base64-encoded string that the agent must decode to match the UserEvent structure.

JSON representation
{
  "senderPhoneNumber": string,
  "eventType": enum (EventType),
  "eventId": string,
  "messageId": string,
  "sendTime": string,
  "agentId": string
}
Fields
senderPhoneNumber

string

Phone number (in E.164 format) of the user involved in the event.

eventType

enum (EventType)

Type of the event.

eventId

string

A unique event ID, assigned by the sending user's RCS client. Agents should treat events with the same (eventId, senderPhoneNumber) pair as unintended duplicates.

messageId

string

The ID of the message that is associated with the event. For example, a message that was delivered to the user's RCS client or read by the user. This field is populated for DELIVERED and READ events.

sendTime

string (Timestamp format)

Time at which RCS client sends the event.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

agentId

string

The agent's unique identifier. Set by RCS Business Messaging.