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

UserMessage

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 Cloud 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 content can be only one of the following:
  "text": string,
  "userFile": {
    object (UserFile)
  },
  "location": {
    object (LatLng)
  },
  "suggestionResponse": {
    object (SuggestionResponse)
  }
  // End of list of possible types for union field content.
}
Fields
senderPhoneNumber

string

Phone number (in E.164 format) of the user that sent the message.

messageId

string

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

sendTime

string (Timestamp format)

Time at which the message was sent.

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.

Union field content. Content of the message content can be only one of the following:
text

string

Text, specifically a string created through organic user typing and not a suggested reply.

userFile

object (UserFile)

Media file.

location

object (LatLng)

Location. Note that this is not necessarily the user's location. A user is able to send arbitrary locations to an agent.

suggestionResponse

object (SuggestionResponse)

Response generated by a user tapping a suggested reply or action.