JAICP

Webim (Custom Channel API) как операторский канал


Webim — платформа онлайн-консультирования, которая позволяет общаться через различные каналы: чат на сайте, мессенджеры, социальные сети, чат-боты, мобильные приложения и другие. Платформа также интегрируется с системами CRM и HelpDesk.

Чтобы настроить Webim как операторский канал:

  1. Создайте канал в Webim.
  2. Создайте операторский канал в JAICP.
  3. Подключите операторский канал к входящему.
  4. Настройте перевод на оператора или группу операторов в сценарии

Создание канала в Webim

  1. Авторизуйтесь в личном кабинете платформы Webim как администратор аккаунта.

  2. Перейдите на страницу Настройки > Общие > Каналы общения.

  3. В секции Произвольный, нажмите Добавить канал.

  4. Заполните настройки произвольного канала:

    • Название — укажите название, которое будет отображаться в интерфейсе оператора.

    • Ваш секретный ключ — придумайте и введите секретный ключ. Он будет использоваться платформой Webim для отправки сообщения.

    • Адрес сервера — укажите адрес сервера, куда будут отправляться события о новых сообщениях в формате:

      https://{имя_хоста}/chatapi/webhook/webim/{идентификатор_канала}

      https://app.jaicp.com/chatapi/webhook/webim/3899495ffd6f48e9aeaec — пример адреса сервера.

    • Выбор отдела — выберите отдел, на который будут переводиться диалоги, или создайте новый.

      Как создать отдел
      1. Перейдите в раздел Команда > Отделы и нажмите Создать новый отдел.
      2. Заполните необходимые поля и нажмите Сохранить.
  5. Скопируйте значения полей Наш секретный ключ и Идентификатор канала. Они понадобятся для подключения канала в JAICP.

    • Наш секретный ключ используется, чтобы идентифицировать запросы к платформе Webim.
    • Идентификатор канала используется, чтобы идентифицировать канал, с которого пришло сообщение.
  6. Нажмите Сохранить.

Создание операторского канала

  1. Авторизуйтесь в платформе JAICP и перейдите в проект.
  2. Перейдите на вкладку Каналы.
  3. В разделе Операторы нажмите Подключить канал.
  4. Выберите Webim (Custom Channel API).
  5. Заполните поля:
    • Название — укажите название канала.
    • ID Канала — вставьте значение из поля Идентификатор канала.
    • Входящий ключ — вставьте ключ из поля Ваш секретный ключ.
    • Исходящий ключ — вставьте ключ из поля Наш секретный ключ.
    • Имя аккаунта Webim — укажите название аккаунта. Вы можете скопировать его из адресной строки — {имя_вашего_аккаунта}.webim.ru.

Подключение входящего канала

  1. Выберите уже подключенный входящий канал или подключите новый.
  2. Перейдите в окно редактирования канала.
  3. В поле Оператор выберите операторский канал Webim и нажмите Сохранить.

Особенности сценария

Перевести диалог на оператора можно с помощью ответа бота с типом switch. Webim также поддерживает перевод диалога на группу операторов, закрепленных за определенным отделом.

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

state: TransferToAgent
    intent!: /agent
    a: Минуточку… Перевожу на оператора.
    script:
        $response.replies = $response.replies || [];
        $response.replies.push({
            "type": "switch",
            "firstMessage": $client.history,
            "closeChatPhrases": ["/closeLiveChat", "Закрыть диалог"]
        });

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

Чтобы перевести диалог на группу операторов:

  1. В Webim перейдите в раздел Команда > Сотрудники и назначьте отдел, указанный в Выбор отдела, нужным операторам.
  2. Перейдите в Команда > Отделы > Редактировать отдел и скопируйте Буквенный идентификатор отдела.
  3. В сценарии JAICP вставьте идентификатор отдела в параметр destination в типе ответа switch.

Если в destination правильно указан идентификатор отдела, диалог будет переведен на указанный отдел. Если неправильно или параметр destination вовсе не указан, диалог будет переведен в общую очередь.

state: TransferToAgent
    intent!: /agent
    a: Минуточку… Перевожу на оператора.
    script:
        $response.replies = $response.replies || [];
        $response.replies.push({
            "type": "switch",
            "destination": "main",    // Буквенный идентификатор отдела в Webim.
            "firstMessage": $client.history,
            "closeChatPhrases": ["/closeLiveChat", "Закрыть диалог"]
        });