Какую информация edna Chat Center передает чат-боту

В этой статье представлено описание основной информации, которую edna Chat Center передает чат-боту с помощью веб-хуков. Более подробную информацию об этих и других веб-хуках с детальными примерами и возможными ответами вы можете найти здесь.

Событие загрузки чата

При инициализации чата edna отправляет чат-боту веб-хук INIT_CHAT, сообщая о том, что чат был инициализирован.

В веб-хуке передается следующая информация о клиенте:

• action – всегда INIT_CHAT
• threadsClientId – внутренний ID клиента в edna
• channelInfo.channelType – канал, в котором был инициализирован чат
• channelInfo.authorized – авторизован ли клиент (true/false)
• platform – только для каналов с типом Mobile (iOS/Android)
• sender – информация об отправителе, всегда ThreadsAPI
• clientData – тут передаются дополнительные поля с информацией о клиенте

Отправка сообщения клиентом

Когда клиент пишет в тред, смаршрутизированный на чат-бота, edna отправляет вебхук MESSAGE cо следующей информацией:

• action – всегда MESSAGE
• text – текст сообщения клиента
• clientId – ID клиента во внешней системе (для авторизованных клиентов)
• threadsClientId – внутренний ID клиента в edna
• sessionId – ID треда в edna
• questionId – ID сообщения в БД edna
• questionIndex – номер сообщения в треде
• channelInfo.channelType – канал, в котором был инициализирован чат
• channelInfo.authorized – авторизован ли клиент (true/false)
• platform – только для каналов с типом Mobile (iOS/Android)
• clientData – тут передаются дополнительные поля с информацией о клиенте
• segmentationInfo – объект, содержащий дополнительную информацию для маршрутизации треда (кастомный параметр сегментации) после бота
  • key – имя параметра сегментации
  • value – значение параметра сегментации
• receivedAt – время, когда было получено сообщение
• attachments – массив с объектами вложений
  • attachments.url – ссылка на вложение
  • attachments.name – имя файла вложения
  • attachments.type – тип файла вложения
  • attachments.size – размер вложения
• sender – информация об отправителе, всегда ThreadsAPI
• settings.blockInput – параметр, отвечающий за блокировку поля ввода сообщения (true/false) при использовании быстрых ответов
• settings.masked – параметр, отвечающий за маскирование цифр в сообщении клиента (true/false)