UserMessage

A message sent from a user to an agent.

UserMessage appears in data field of the message object that agents receive. The data field is a base64-encoded strings that agents must convert to bytes and parse with the UserMessage protocol buffer.

JSON representation 
 { 
 "requestId" 
 : 
 string 
 , 
 "conversationId" 
 : 
 string 
 , 
 "customAgentId" 
 : 
 string 
 , 
 "agent" 
 : 
 string 
 , 
 "context" 
 : 
 { 
 object (  Context 
 
) 
 } 
 , 
 "sendTime" 
 : 
 string 
 , 
 "dialogflowResponse" 
 : 
 { 
 object (  DialogflowResponse 
 
) 
 } 
 , 
 // Union field payload 
can be only one of the following: 
 "message" 
 : 
 { 
 object (  Message 
 
) 
 } 
 , 
 "receipts" 
 : 
 { 
 object (  Receipts 
 
) 
 } 
 , 
 "userStatus" 
 : 
 { 
 object (  UserStatus 
 
) 
 } 
 , 
 "surveyResponse" 
 : 
 { 
 object (  SurveyResponse 
 
) 
 } 
 , 
 "suggestionResponse" 
 : 
 { 
 object (  SuggestionResponse 
 
) 
 } 
 , 
 "authenticationResponse" 
 : 
 { 
 object (  AuthenticationResponse 
 
) 
 } 
 // End of list of possible types for union field payload 
. 
 }
Fields
requestId

string

The unique identifier of the user message. Use this field to de-duplicate incoming messages.

conversationId

string

The unique identifier of the conversation.

customAgentId

string

A custom identifier for the agent. Defined by the partner during agent registration.

agent

string

Identifier for the agent. Set during agent creation.

context

object ( Context )

Contextual data associated to the message.

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" .

dialogflowResponse

object ( DialogflowResponse )

The Dialogflow response.

Union field payload . The payload of the user message. payload can be only one of the following:
message

object ( Message )

The content of the message.

receipts

object ( Receipts )

The content of the receipts.

userStatus

object ( UserStatus )

The content of the user status.

surveyResponse

object ( SurveyResponse )

The survey response.

suggestionResponse

object ( SuggestionResponse )

The suggestion response.

authenticationResponse

object ( AuthenticationResponse )

The authentication response.

UserStatus

A user status.

JSON representation 
 { 
 "createTime" 
 : 
 string 
 , 
 // Union field status 
can be only one of the following: 
 "isTyping" 
 : 
 boolean 
 , 
 "requestedLiveAgent" 
 : 
 boolean 
 // End of list of possible types for union field status 
. 
 }
Fields
createTime

string ( Timestamp format)

The time that the user status changed.

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" .

Union field status .

status can be only one of the following:

isTyping

boolean

Whether user is typing.

requestedLiveAgent

boolean

Whether user requested a live agent.