test

HyperScript iframe API example











Как пользоваться примером

  • Введите логин пользователя из вашей системы в поле User ID
  • Нажмите кнопку "Show auth form", чтобы вызывать форму авторизации в HyperScript
  • После успешной авторизации система выдаст ключ, который появится в поле API key. Автоматически загрузиться
    список скриптов
  • После выбора скрипта из списка, он будет запущен

Общие сведения

Получение данных от сервера происходит по REST API.

Для работы с API необходим идентификатор пользователя в вашей системе и ключ. Для того, чтобы получить ключ,
необходимо пройти процедуру связывания аккаунтов. Для этого нужно вызвать метод showAuthForm с параметром user.
Фрейм отобразить форму авторизации. После успешной авторизации будет вызвана callback-функция с объектом
{status: 'ok', key: 'someGeneratedKey'}.

Чтобы проверить связан ли текущий пользователь, необходимо вызвать метод isPair с параметром user. Если
пользователь связан, то callback-функция вернет объект {pair: true}

Для запуска нужного скрипта вызывается метод showScript с параметрами user, key, id, skipStart, withoutSaving
где user - идентификатор пользователя, key - ключ авторизации, id - идентификатор скрипта, skipStart = true -
показывает скрипт сразу, без вступления, withoutSaving = true - не сохраняет статистику после прохода скрипта.

Идентификатор скрипта можно получить вызвав метод getUserScripts с параметрами user и key. Callback-функция
вернет массив объектов вида {id: 1, name: 'Script'}. Также при вызове метода showScriptList отображается
выпадающий список со скриптами пользователя. После выбора скрипта callback-функция вернет id выбранного скрипта.

Список методов:

  • showAuthForm(user) - показать форму связывания аккаунтов
  • hideAuthForm() - скрыть форму связывания аккаунтов
  • isPair(user) - возвращает, связан ли указанный аккаунт с аккаунтом HyperScript
  • getUserScripts(user, key) - возвращает массив [id, name] скриптов пользователя
  • showScriptList(user, key) - показывает выпадающий список скриптов пользователя, callback-функция
    вызывается после выбора скрипта
  • hideScriptList() - скрыват список скриптов пользователя
  • showScript(user, key, id, skipStart, withoutSaving) - показывает указанный скрипт
  • hideScript() - скрывает форму скрипта
  • checkAccess(user, key, id) - проверка доступа пользователя к скрипту

WebHooks

WebHooks – метод отслеживания определенных событий в HyperScript и уведомление сторонних приложений о них.
Например, Вы будете получать уведомления о прохождении скрипта оператором, видеть пройденные шаги, значения занесенные в поля и т.п.
Для подключения WebHook в HyperScript необходимо:

  1. Перейти в Ваш скрипт (WebHook подключается для каждого скрипта отдельно)
  2. Перейдите в раздел «Интеграция» - WebHook
  3. Для добавления WebHooks нажмите «Добавить хук»
  4. В появившемся поле введите url адрес Вашего сайта. Нажмите кнопку «Сохранить»
  5. При проходе скрипта в любой из систем, в которую интегрирован HyperScript по нажатию на кнопку «Разговор окончен» на указанный Вами WebHook отправляется post запрос, содержащий:
    • log[0][id] log[1][id] log[2][id] - последовательность кликов какую делал оператор.
    • start s1 s2 s12 - id шагов
    • fields - переменные поля, которые вводит оператор
    • duration - продолжительность прохода в секундах
    • event - название события, например «закончить разговор» (stop script)
    • outcome - результат прохождения скрипта:
      • forced_interruption - оператор прервал разговор
      • forced_interruption - оператор нажал «нет нужного ответа» и возможно ввел вариант ответа (комментарий)
      • ок - оператор довел собеседника до конца скрипта
  6. Для удаления WebHook нажмите на значок корзины рядом с ним, затем кнопку сохранить. Данную операцию необходимо проделать для каждого скрипта.