Перейти к основному содержимому

Описание Bot API

edna может отправлять чат-боту 4 вида вебхуков. Администратор может создавать и менять эти вебхуки для каждого чат-бота в АРМ.

  1. Вебхук INIT_CHAT предназначен для чатов, которые инициирует чат-бот (например, в сценарии с проактивным приветствием со стороны бота). Этот вебхук отправляется, когда клиент открывает чат. Этот вебхук применяется только для приложений чата, основанных на SDK edna. Вебхук INIT_CHAT можно использовать для проактивных приветствий со стороны бота. Бот отправляет приветственное сообщение в edna через эндпоинт. Для этого боту потребуется вызвать метод api/v1/chatbot/greet.

  2. Вебхук MESSAGE используется, когда получено новое сообщение от клиента и его необходимо отправить чат-боту. После того как тред проходит сегментацию, он может быть направлен на внешнего бота. Все сообщения клиентов отправляются чат-боту через вебхук MESSAGE. Бот их обрабатывает или синхронно, отвечая на входящее сообщение, или асинхронно, отправляя ответ через эндпоинт api/v1/chatbot.

  3. Вебхук TRAINING используется, когда включены подсказки от бота. В этом случае система отправляет треды боту для обучения, чтобы бот мог создать на их основе подсказки для агентов. Система отправляет боту все сообщения - и клиентские, и агентские, - используя вебхук TRAINING. Бот их обрабатывает и отправляет ответ через эндпоинт api/v1/chatbot/hints.

  4. Вебхук CONTACT используется для уведомления бота о получении данных клиента. Бот может отправить запрос на получение данных клиента (доступно только в канале TELEGRAM). Запрос на получение данных можно выполнить если передать в сообщении быстрый ответ с типом CONTACT:

Interaction diagram

Main