AI-generated Key Takeaways
-
A ServerEvent is a server-side event related to a conversation between an agent and a user, such as a timed-out bot message.
-
ServerEvents appear in the "data" field of the "message" object agents receive via Pub/Sub, which is a base64-encoded string needing decoding.
-
The ServerEvent structure includes fields like
phoneNumber
,agentId
,messageId
,eventType
,eventId
, andsendTime
.
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 ( |
Fields | |
---|---|
phoneNumber |
Phone number (in E.164 format) of the user involved in the event. |
agentId |
The agent's unique identifier. Set by RCS for Business. |
messageId |
The RCS message ID of the message that is associated with the event. |
eventType |
Type of the event. |
eventId |
A unique event ID assigned for the event instance. |
sendTime |
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: |