UserMessage

Сообщение, отправленное пользователем агенту.

UserMessage появляется в поле data объекта message , которое получают агенты. Поле data представляет собой строки в кодировке Base64, которые агенты должны преобразовать в байты и проанализировать с помощью буфера протокола UserMessage .

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 ( Timestamp format)

Время отправки сообщения.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

dialogflowResponse

object ( DialogflowResponse )

Ответ Dialogflow.

payload Union Field. Полезная нагрузка пользовательского сообщения. payload может быть только одной из следующих:
message

object ( Message )

Содержание сообщения.

receipts

object ( Receipts )

Содержание квитанций.

userStatus

object ( UserStatus )

Содержимое статуса пользователя.

surveyResponse

object ( SurveyResponse )

Ответ на опрос.

suggestionResponse

object ( SuggestionResponse )

Ответ на предложение.

authenticationResponse

object ( AuthenticationResponse )

Ответ аутентификации.

Статус пользователя

Статус пользователя.

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.
}
Поля
createTime

string ( Timestamp format)

Время изменения статуса пользователя.

Временная метка в формате RFC3339 UTC «Зулу» с наносекундным разрешением и до девяти дробных цифр. Примеры: "2014-10-02T15:01:23Z" и "2014-10-02T15:01:23.045123456Z" .

status поля объединения.

status может быть только одним из следующих:

isTyping

boolean

Вводит ли пользователь текст.

requestedLiveAgent

boolean

Запрашивал ли пользователь активный агент.