Se usó la API de Cloud Translation para traducir esta página.

UserMessage

Un mensaje enviado de un usuario a un agente.

UserMessage aparece en el campo data del objeto message que reciben los agentes. El campo data es una string codificada en base64 que los agentes deben convertir en bytes y analizar con el búfer de protocolo UserMessage.

Representación JSON

Representación 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` El identificador único del mensaje del usuario. Usa este campo para anular la duplicación de mensajes entrantes.
`conversationId`	`string` El identificador único de la conversación.
`customAgentId`	`string` Un identificador personalizado para el agente. El socio lo define durante el registro del agente.
`agent`	`string` Es el identificador del agente. Se establece durante la creación del agente.
`context`	`object (Context)` Datos contextuales asociados con el mensaje.
`sendTime`	`string (Timestamp format)` Hora a la que se envió el mensaje Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: `"2014-10-02T15:01:23Z"` y `"2014-10-02T15:01:23.045123456Z"`.
`dialogflowResponse`	`object (DialogflowResponse)` La respuesta de Dialogflow.
Campo de unión `payload`. Es la carga útil del mensaje del usuario. Las direcciones (`payload`) solo pueden ser una de las siguientes opciones:
`message`	`object (Message)` Indica el contenido del mensaje.
`receipts`	`object (Receipts)` El contenido de los recibos
`userStatus`	`object (UserStatus)` Es el contenido del estado del usuario.
`surveyResponse`	`object (SurveyResponse)` La respuesta de la encuesta
`suggestionResponse`	`object (SuggestionResponse)` Es la respuesta de la sugerencia.
`authenticationResponse`	`object (AuthenticationResponse)` La respuesta de autenticación.

UserStatus

Un estado de usuario.

Representación 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)` La hora a la que cambió el estado del usuario. Una marca de tiempo en formato RFC3339 UTC "Zulú", con resolución de nanosegundos y hasta nueve dígitos fraccionarios. Ejemplos: `"2014-10-02T15:01:23Z"` y `"2014-10-02T15:01:23.045123456Z"`.
Campo de unión `status`. `status` puede ser una de las siguientes opciones:
`isTyping`	`boolean` Indica si el usuario está escribiendo.
`requestedLiveAgent`	`boolean` Indica si el usuario solicitó un agente humano.