API версия 2

Запросы к API идут по протоколу HTTP.

Все запросы имеют вид: https://scriptdesigner.ru/integration/apiv2/controller/method?key=API-KEY

  • https://scriptdesigner.ru/integration/apiv2 — эта часть URL постоянна
  • controller/method — роутинг для получения данных. Варианты будут описаны ниже.
  • key — ключ API (так же можно передавать как HTTP-заголовок - Key:Ваш Ключ API)



json Формат ответа по-умолчанию
jsonp Чтобы получить jsonp ответ - передайте GET-параметр "_format=jsonp". Название callback функции можно передать в GET-параметре "callback=my_func", по-умолчанию используется название функции "callback"

Проверка ключа API(user/check)

Проверка правильности введенного пользователем ключа API.

URL запроса:
https://scriptdesigner.ru/integration/apiv2/user/check?key=API-KEY
Пример ответа:
{
  "key": 'ключ',
  "user_id": 0
}

Список пользователей (user/list)

Выдает список ваших пользователей с их ролями и ключами авторизации.

URL запроса:
https://scriptdesigner.ru/integration/apiv2/user/list?key=API-KEY
Пример ответа:
[
    {"id":123456,"role":"user_head_manager","login":"[email protected]","auth_token":"ключ 1"},
    {"id":123457,"role":"user_designer","login":"[email protected]","auth_token":"ключ 2"},
    {"id":123459,"role":"user_supervisor","login":"[email protected]","auth_token":"ключ 4"},
    {"id":123458,"role":"user_operator","login":"[email protected]","auth_token":"ключ 3"}
]

Авторизация пользователя (user/auth)

Авторизует пользователя по ID и токену авторизации.

URL запроса:
https://scriptdesigner.ru/integration/apiv2/user/auth?key=USER_KEY&id=USER_ID&token=AUTH_TOKEN
Параметры:
  • key [обязательный] — ключ API администратора для всех пользователей
  • id [обязательный] — ID пользователя
  • token [обязательный] — Токен авторизации пользователя
Ответ:

Переадресует на главную страницу.

Список скриптов (script/list)

Возвращает список скриптов пользователя. Каждый элемент списка содержит ID скрипта, название, и метку - опубликован скрипт или нет. По-умолчанию возвращает все опубликованные скрипты.

URL запроса:
https://scriptdesigner.ru/integration/apiv2/script/list?key=API-KEY
Пример ответа:
[
  {
    "id": 1617,
    "name": "Prohod Sekretaria",
    "published": 0
  },
  {
    "id": 460,
    "name": "Назначение встречи",
    "published": 1
  },
  {
    "id": 198,
    "name": "Smart4smart 3.0",
    "published": 1
  }
]

Добавить запись звонка (call/attach-record)

Прикрепляет к звонку URL записи телефонного разговора. URL должен быть доступен и вести к звуковому файлу - чтобы можно было прослушать при помощи онлайн плеера.

URL запроса:
https://scriptdesigner.ru/integration/apiv2/call/attach-record?key=API-KEY&id=1234&url=http%3A%2F%2Frecords-server.ru%2Frecord_123.mp3
Параметры:
  • id [обязательный] — ID звонка. Вы можете получить ID звонка, используя WebHooks
  • url [обязательный] — URL записи разговора (urlencoded строка)

Список настраиваемых полей (field/list)

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

URL запроса:
https://scriptdesigner.ru/integration/apiv2/field/list?key=API-KEY
Пример ответа:
[
    {"id":1,"code":"name","account_id":1,"name":"Имя","type":"string","type_data":""},
    {"id":2,"code":"gender","account_id":1,"name":"Пол","type":"in","type_data":"М, Ж"}
]

Создать настраиваемое поле (field/create)

Создает настраиваемое поле

Параметры:
  • code [обязательный] — код поля, используется для идентификации поля при прогоне скриптов
  • name [обязательный] — название поля
  • type [обязательный] — тип поля (возможные значения: string, number, date, boolean, in)
  • type_data [не обязательный] — варианты выбора (заполняется для типа поля `in`)
URL запроса:
https://scriptdesigner.ru/integration/apiv2/field/create?key=API-KEY&code=name&name=%D0%98%D0%BC%D1%8F&type=string
Пример ответа:
{result: true}
{result: false, errors: []}

Изменить настраиваемое поле (field/update)

Изменяет настраиваемое поле

Параметры:
  • code [обязательный] — код поля, используется для идентификации поля при прогоне скриптов
  • name [не обязательный] — название поля
  • type [не обязательный] — тип поля (возможные значения: string, number, date, boolean, in)
  • type_data [не обязательный] — варианты выбора (заполняется для типа поля `in`)
URL запроса:
https://scriptdesigner.ru/integration/apiv2/field/update?key=API-KEY&code=name&name=%D0%98%D0%BC%D1%8F
Пример ответа:
{result: true}
{result: false, errors: []}

Удалить настраиваемое поле (field/delete)

Удаляет настраиваемое поле

Параметры:
  • code [обязательный] — код поля, используется для идентификации поля при прогоне скриптов
URL запроса:
https://scriptdesigner.ru/integration/apiv2/field/delete?key=API-KEY&code=name
Пример ответа:
{result: true}

Автозапуск скрипта

Автозапуск скрипта должен происходить после авторизации пользователя в системе (см. "Авторизация пользователя").

Для автозапуска необходимо использовать url: https://scriptdesigner.ru/dashboard#/call/9999

Параметры:
  • dashboard [обязательный] — интерфейс администратора аккаунта. Также может иметь значения operator-dashboard (интерфейс оператора) и designer-dashboard (интерфейс проектировщика)
  • 9999 [обязательный] — номер скрипта для звонка

API позволяет передавать в звонок различные данные.

Подробнее о передаче данных смотрите в разделе Webhook (только для авторизованных пользователей).


Яндекс.Метрика