AI-generated Key Takeaways
-
A UserMessage is a message sent by a user to an agent.
-
The UserMessage is found in the
data
field of themessage
object received from a Google Pub/Sub subscription. -
The
data
field is a base64-encoded string that needs to be decoded to match the UserMessage structure. -
The UserMessage contains fields such as
senderPhoneNumber
,messageId
,sendTime
,agentId
, and a union fieldcontent
which can be text, a user file, a location, or a suggestion response.
A message that a user sent to the agent.
The UserMessage appears in the "data" field of the "message" object that the agent receives from its Google Pub/Sub subscription. The "data" field is a base64-encoded string that the agent must decode to match the UserMessage structure.
JSON representation |
---|
{ "senderPhoneNumber": string, "messageId": string, "sendTime": string, "agentId": string, // Union field |
Fields | |
---|---|
senderPhoneNumber |
Phone number (in E.164 format) of the user that sent the message. |
messageId |
A unique message ID, assigned by the sending user's RCS client. |
sendTime |
Time at which the message was sent. 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: |
agentId |
The agent's unique identifier. Set by RCS for Business. |
Union field content . Content of the message content can be only one of the following: |
|
text |
Text, specifically a string created through organic user typing and not a suggested reply. |
userFile |
Media file. |
location |
Location. Note that this is not necessarily the user's location. A user is able to send arbitrary locations to an agent. |
suggestionResponse |
Response generated by a user tapping a suggested reply or action. |