Esta página foi traduzida pela API Cloud Translation.

UserMessage

Mensagem enviada de um usuário para um agente.

O UserMessage aparece no campo data do objeto message que os agentes recebem. O campo data é uma string codificada em base64 que os agentes precisam converter em bytes e analisar com o buffer de protocolo UserMessage.

Representação JSON

Representação JSON
{ "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`. }

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

Campos
`requestId`	`string` O identificador exclusivo da mensagem do usuário. Use este campo para eliminar a duplicação de mensagens recebidas.
`conversationId`	`string` O identificador exclusivo da conversa.
`customAgentId`	`string` Um identificador personalizado para o agente. Definida pelo parceiro durante o registro do agente.
`agent`	`string` Identificador do agente. Definido durante a criação do agente.
`context`	`object (Context)` Dados contextuais associados à mensagem.
`sendTime`	`string (Timestamp format)` Hora em que a mensagem foi enviada. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: `"2014-10-02T15:01:23Z"` e `"2014-10-02T15:01:23.045123456Z"`.
`dialogflowResponse`	`object (DialogflowResponse)` A resposta do Dialogflow.
Campo de união `payload`. O payload da mensagem do usuário. `payload` pode ser apenas de um dos tipos a seguir:
`message`	`object (Message)` O conteúdo da mensagem.
`receipts`	`object (Receipts)` O conteúdo dos comprovantes.
`userStatus`	`object (UserStatus)` O conteúdo do status do usuário.
`surveyResponse`	`object (SurveyResponse)` A resposta da pesquisa.
`suggestionResponse`	`object (SuggestionResponse)` A resposta da sugestão.
`authenticationResponse`	`object (AuthenticationResponse)` A resposta de autenticação.

UserStatus

Um status de usuário.

Representação JSON
{ "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`. }

Campos
`createTime`	`string (Timestamp format)` A hora em que o status do usuário mudou. Um carimbo de data/hora no formato UTC "Zulu" RFC3339, com resolução de nanossegundos e até nove dígitos fracionários. Exemplos: `"2014-10-02T15:01:23Z"` e `"2014-10-02T15:01:23.045123456Z"`.
Campo de união `status`. `status` pode ser apenas de um dos tipos a seguir:
`isTyping`	`boolean` Se o usuário está digitando.
`requestedLiveAgent`	`boolean` Se o usuário solicitou um agente ao vivo.