Zendesk Chat как входящий канал

Zendesk Chat — программное обеспечение онлайн-чата.

Для использования Zendesk Chat как входящего канала:

Настройте сервис Zendesk Chat.
Создайте канал в JAICP.
Сценарий.
Протестируйте бота.

Настройка сервиса

Зарегистрируйтесь и авторизуйтесь в сервисе Zendesk Chat.

Клиент API.

Нажмите на панели управления Настройки > Аккаунт. Выберите вкладку API и SDK > Добавить клиента API.

Заполните поля:

Клиентское имя — имя, которое видят пользователи при запросе доступа от вашего приложения или при просмотре списка приложений, к которым предоставлен доступ.
Компания — название компании, которое отображается, когда пользователи просят разрешить доступ к вашему приложению.
URL для перенаправления — URL-адреса, на которые служба Zendesk Chat должна перенаправлять пользователей, когда они разрешат или запретят вашему приложению доступ к Zendesk Chat.

Нажмите Создать клиент API.

Скопируйте ID клиента и секретный ключ клиента.

Токен.

Для получения токена пройдите авторизацию по протоколу OAuth.

Например, перейдите по адресу:

https://www.zopim.com/oauth2/authorizations/new?response_type=token&redirect_uri={url для перенаправления}&client_id={ID клиента}&scope=read%20write%20chat&subdomain={субдомен}

Здесь:

redirect_uri — URL-адрес для перенаправления.
client_id — ID клиента, который вы скопировали ранее.
subdomain — субдомен вашего аккаунта. Вы можете скопировать субдомен из адресной строки браузера: https:/{subdomain}.zendesk.com/

При переходе по сформированному адресу необходимо авторизоваться и предоставить доступ к аккаунту. После этого на странице для перенаправления, которую вы указали, будет доступен токен. Скопируйте токен из адресной строки браузера:

https://{url для перенаправления}/#access_token={значение токена}&token_type=bearer&scope=read+write+chat

Оператор.

Создайте аккаунты для операторов. Для этого нажмите на панели управления Настройки > Агенты > Добавить агента > введите данные оператоора.

Для добавления аккаунтов в отдел нажмите на панели управления Настройки > Отделы > Создать отдел.

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

Перейдите в платформу JAICP, нажмите на панели управления Каналы > Создать канал. В разделе Другое выберите Zendesk Chat.

Заполните поля:

Название — укажите название токена или оставьте по умолчанию.
Токен — укажите токен, который вы скопировали ранее.
Ветка — укажите ветку проекта, которую вы хотите развернуть в канал, по умолчанию master.
Публикация — автоматически (после каждого сохранения внесенных в проект изменений) или вручную (с помощью кнопки Опубликовать в строке с описанием канала).

Обратите внимание на переключатель Публикация. Публикацию или деплой сценария нужно выполнять перед запуском чатбота. На этом этапе происходит сборка чатбота, проверка синтаксиса сценариев и скриптов, а также проверка прохождения тестов.

Нажмите Создать. Дождитесь всплывающего окна с результатом деплоя.

Сценарий

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

state: Operator Zendesk Chat
    q: $regex</start>
    a: Перевожу на оператора
    script:
        $response.zopim = {
            needResponse: true,
            departmentName: 'first department'        // название отдела
        };

Добавление тегов:

state: tags
        q!: tags
        script:
            $response.zopim = {
                tags: ["tag1", "tag2"]
            };

Обратите внимание, что добавление кнопок возможно, если в стейте передается текстовое сообщение. Например:

state: tags
        q!: buttons
        a: Текстовое сообщение
        buttons:
            "Это кнопка"

Тестирование

Перейдите в окно диалога с ботом в подключенном канале и отправьте ему приветственную/активационную фразу, предусмотренную вашим сценарием. После этого должен начаться ваш диалог с ботом.