Что может сделать чат-бот с помощью edna API

В этой статье описаны функции, которые edna с помощью API позволяет выполнить чат-боту.

Проактивное приветствие 

После инициализации чата чат-бот может первым отправить приветствие и вовлечь клиента в диалог не дожидаясь его сообщения. За это отвечает метод Greet.

  • text – текст сообщения чат-бота
  • clientId — ID клиента во внешней системе (для авторизованных клиентов)
  • threadsClientId — внутренний ID клиента в edna
  • receivedAt — время, когда было получено сообщение
  • quickReplies — массив объектов с быстрыми ответами
    • quickReplies.type — в данный момент поддерживается только TEXT
    • quickReplies.text — текст ответа
    • quickReplies.shown_text – необязательный параметр, текст, который будет показан клиенту в случае нажатия на кнопку быстрого ответа (вместо quickReplies.text)
    • quickReplies.callback_data – функция, которую виджет чата передаст в API в случае нажатия на кнопку. При наличии этого атрибута будет вызван метод JS SDK API ThreadsWidget.on.
    • quickReplies.imageUrl – ссылка иконки для кнопки
    • quickReplies.url – ссылка на файл в кнопке
  • settings.blockInput — параметр, отвечающий за блокировку поля ввода сообщения (true/false) при использовании быстрых ответов

Отправка сообщений, перевод на оператора

После назначения чата на чат-бота, чат-бот может отвечать на сообщения клиента. За это отвечает метод Post answers.

  • text – текст ответа чат-бота на сообщение клиента
  • receivedAt — время, когда было получено сообщение
  • answerId – ID ответа чат-бота
  • formattedText — текст ответа чат-бота, который может содержать markdown-разметку для корректного отображения форматированного ответа в интерфейсах клиента и оператора
  • clientId — ID клиента во внешней системе (для авторизованных клиентов)
  • threadsClientId — внутренний ID клиента в edna
  • sessionId — ID треда в edna
  • questionId – ID сообщения в БД edna
  • questionIndex — номер сообщения в треде
  • segmentationInfo — объект, содержащий дополнительную информацию для маршрутизации треда (кастомный параметр сегментации) после чат-бота
    • key — имя параметра сегментации
    • value — значение параметра сегментации
  • attachments — массив с объектами вложений
    • attachments.url — ссылка на вложение
    • attachments.name — имя файла вложения
    • attachments.type — тип файла вложения
  • quickReplies — массив объектов с быстрыми ответами
    • quickReplies.type — в данный момент поддерживается только TEXT
    • quickReplies.text — текст ответа
    • quickReplies.shown_text – необязательный параметр, текст, который будет показан клиенту в случае нажатия на кнопку быстрого ответа (вместо quickReplies.text)
    • quickReplies.callback_data – функция, которую виджет чата передаст в API в случае нажатия на кнопку. При наличии этого атрибута будет вызван метод JS SDK API ThreadsWidget.on.
    • quickReplies.imageUrl – ссылка иконки для кнопки
    • quickReplies.url – ссылка на файл в кнопке
  • code — используется для перевода треда на оператора. Для перевода необходимо передать UNCLEAR_QUESTION или SWITCH_TO_HUMAN
  • settings.blockInput — параметр, отвечающий за блокировку поля ввода сообщения (true/false) при использовании быстрых ответов
  • settings.masked – параметр, отвечающий за маскирование цифр в связанном сообщении клиента (true/false)

Завершение треда чат-ботом

Чат-бот может самостоятельно завершить тред, не переводя его на оператора. Для этого чат-бот может воспользоваться методами Close Threads by Bot или Close Threads by Bot with Comment.

Подсказки чат-бота для оператора

Чат-бот может работать в режиме суфлера. Например, тред обрабатывается оператором, чат-бот с помощью метода Hints может присылать подсказки для оператора, подходящие для ответа клиенту. Данные подсказки будут отображаться у оператора в разделе Готовые ответы > Подсказки.

Какую информация edna Chat Center передает чат-боту
Cледующая статья Прочие функции в работе чат-бота