ServerEvent

  • ServerEvents are notifications about occurrences related to conversations between agents and users, such as when a bot message's TTL expires.

  • These events are delivered within the "data" field of a "message" object in a Pub/Sub subscription, requiring base64 decoding by the agent.

  • Each ServerEvent contains fields such as phoneNumber, agentId, messageId, eventType, eventId, and sendTime to provide specific context.

  • The eventType field specifies the type of the event, while sendTime indicates the server's event dispatch time in RFC 3339 format.

  • The information is structured in a JSON format that contains information regarding the server event and it's corresponding data.

An event that occurred server side that is related to a conversation between an agent and a user.

For example, if the bot sets a TTL for the message and the TTL expires, this event will be fired to notify the partner that the bot message timed out.

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

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

string

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

string

The agent's unique identifier. Set by RCS for Business.
messageId

string

The RCS message ID of the message that is associated with the event.
eventType

enum (ServerEvent.EventType)

Type of the event.
eventId

string

A unique event ID assigned for the event instance.
sendTime

string (Timestamp format)

Time at which the server sends the event.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".