Omnidesk

Omnidesk — удобный сервис для поддержки клиентов по всем каналам связи. В Omnidesk можно подключить бота для работы в качестве оператора.

Подключение

Конфигурация на стороне Omnidesk

Для начала необходимо настроить подключение на стороне Omnidesk.Работа Omnidesk построена на правилах. Данная инструкция гарантированно будет работать только на аккаунте без других правил, поскольку правила могут конфликтовать между собой. Чтобы настроить более сложные правила, обращайтесь к вашему администратору аккаунта Omnidesk.

1. Войдите в ваш Omnidesk аккаунт.

2. Необходимо создать нового сотрудника, в качестве которого будет подключен бот. Для начала нужно создать отдельную роль для данного сотрудника. Перейдите в раздел Роли сотрудников и нажмите Добавить.

3. Задайте название роли, в разделе Уровень доступа выберите полный.

4. Проставьте галочки под всеми каналами в разделе Доступ к каналам. Это нужно, чтобы у бота был доступ к обращениям этих каналов.

5. Сохраните роль, нажав Добавить роль.

6. Перейдите в раздел Сотрудники и нажмите кнопку Добавить.

7. Пропишите имя сотрудника и почту, на которую будет зарегистрирован его аккаунт. Эта почта понадобится при настройке канала в Платформе.

8. В разделе Настройки доступа нажмите Выбрать одну из ролей сотрудников и выберите роль, созданную для бота.

9. Переключите тумблер, чтобы включить сотрудника. Без включения сотрудника-бота не будет возможности выполнять действия от его имени напрямую и через API, а также указать соответствующую роль в правилах.

10. Затем создайте новую группу (отдел операторов) в Omnidesk для работы бота:

11. 1. перейдите в раздел Добавить группу;

    2. нажмите Добавить группу;

    3. Введите название группы и нажмите Добавить группу.

12. Откройте настройки правил.

13. Создайте в новое правило, нажав входящие обращения и Добавить правило.

14. Настройте правило следующим образом:

15. 1. Пропишите название правила;

    2. Нажмите Добавить действие.

    3. Выберите Назначить ответственным — сотрудника с ролью, созданной для бота.

    4. Добавьте действие Выполнить вебхук методом POST.

    5. В поле URL для отправки запроса вставьте вебхук из настроек канала на платформе.

    6. Выберите Кастомный запрос в формате JSON.

    7. В поле Ваш кастомный запрос укажите следующее тело запроса: { "event": "new_message", "message": { "kind": "text", "text": "[case_description]" }, "visitor": { "id": "[user_id]", "fields": { "email": "[user_email]", "login": "[user_id]", "name": "[user_full_name]", "phone": "[user_phone]" } }, "chat_id": "[case_id]" }

    8. Чтобы вебхук не выполнялся, когда обращение создаёт сотрудник самостоятельно, нажмите Добавить условие: Статус — равен — открытое в блоке «Все заданные». Подробнее о логике статусов: https://support.omnidesk.ru/knowledge_base/item/135753#11.

    9. Добавьте действие Завершить чат и выставить статус — в ожидании.

    10. Также потребуется создать новую метку для обозначения чатов на боте. Для этого добавьте действие Добавить метки и укажите название новой метки, к примеру, На боте.

    11. 1. Мы можем использовать эту метку в других правилах Omnidesk, чтобы однозначно отделять диалоги на боте от прочих диалогов.

    12. Также в правилах, где выполняется вебхук в Платформу, последним нужно добавить действие Игнорировать остальные правила, для того чтобы обращения на боте не конфликтовали с другими правилами.

    13. Сохраните правило, нажав Создать правило.

    14. После сохранения расположите правило в начале списка, зажав и потянув за кнопку, указанную на скриншоте.

16. Создайте в новое правило, нажав измененные обращения и Добавить правило.

17. Настройте правило так же, как настроено правило для входящих обращений.

18. Перейдите в настройки меток.

19. Откройте метку, созданную для обозначения чатов на боте.

20. Сохраните куда-либо идентификатор метки. Его можно найти в адресной строке. Он понадобится для настройки перевода на оператора.

21. Перейдите в Настройки, затем в API, нажмите Добавить API-ключ и сохраните его. Он понадобится для настройки канала на Платформе.

Конфигурация канала Проекта в Платформе

Проекту необходимо создать и настроить канал с коннектором Omnidesk.

1. Перейдите на вкладку каналов внутри проекта.
2. Нажмите кнопку Create channel.
3. Откроется панель выбора канала.
4. Выберите Omnidesk.

5. Откроется панель создания канала.
6. По необходимости пропишите заголовок для данного канала в поле названия с плейсхолдером New channel.
7. В поле Omnidesk domain введите адрес вашего стенда Omnidesk, к примеру https://test-ru.omnidesk.ru.
8. 1. Вы можете найти адрес стенда в адресной строке браузера в админке Omnidesk.
9. В поле Omnidesk API key укажите полученный в Omnidesk апи-ключ.
10. В поле Omnidesk user e-mail введите e-mail сотрудника, от имени которого будет работать бот.
11. Кликните Copy this webhook, чтобы скопировать адрес вебхука из поля Chatbot webhook URL, необходимыйпри создании правил в Omnidesk.
12. Выберите дефолтного агента в поле Default agent.
13. Для сохранения канала без его активации, нажмите кнопку CREATE.
14. Для сохранения и активации канала, нажмите кнопку CREATE & ACTIVATE.
15. 1. канал будет сохранен и активирован, если:

    2. 1. Проект опубликован;

       2. будет доступен адрес канала;

       3. удастся зарегистрировать вебхук канала.

    3. канал будет сохранен, но не активирован, если одно или больше условий не будут выполнены.

16. Для отмены создания канала нажмите кнопку CANCEL.

Общение

Перевод на оператора

Для перевода диалога на оператора используется API-запрос через слот External Request и дополнительное правило для измененных обращений.

1. Настройте правило для перевода на оператора в Omnidesk, как указано на картинке.
2. 1. При удалении метки «на боте» бот-оператор должен перестать быть ответственным, и при необходимости можно назначить нового ответственного тем же правилом. Для этого нужны, к примеру, действия:

   2. 1. Назначить ответственным — никого (сбросить ответственного);

      2. Назначить ответственным — любого сотрудника, который доступен;

      3. Зафиксировать чат — за ответственным, если есть и доступен;

      4. и убрать из "Моих" у сотрудника, за кем уже зафиксирован.

      5. 1. Последнее действие нужно для того, чтобы новый ответственный увидел чат во вкладке «Мои» в интерфейсе активных чатов.

3. Импортируйте в свою компанию агента с примером запроса на перевод.
4. 1. Таким образом, в ресурсах вашей компании появится внешний запрос для перевода на оператора в Omnidesk.
5. В самое начало сценария своего агента добавьте слот Memory с настройками как в импортированном агенте.
6. В переменной bot_label_id укажите числом идентификатор метки (п. 16 раздела "Конфигурация на стороне Omnidesk").
7. В нужных местах сценария своего агента используйте слот External Request из примера.

Переменная	Конечный канал	Переменная в запросе из канала
channel_webhook_token	Omnidesk	email:api_key

Функционал общения	Конечный канал	Доступность в канале	Примечания
Кнопки	Omnidesk	Нет	Кнопки из слота Button menu передаются нумерованным списком
Передача файлов в виде файлов от Агента (Attachment)	Omnidesk	Да
Перевод на оператора	Omnidesk	Да	Только через слот External request
Передача файлов в виде ссылок от Агента (Attachment)	Omnidesk	Да
Получение файла от Собеседника в сценарий	Omnidesk	Да	Пример client_message:{Текст, отправленный с вложением}—————Вложенные файлы:https://glilya.omnidesk.ru/attachment/download/chat/b0bde02aff7ea6c28152cd9fe14fd0d9/24629614_file_0.jpg