HTTP-интерфейс сервера

У сервера Октелл есть встроенный веб-сервер. Через него внешняя система обращается к платформе по обычному HTTP: запускает служебные сценарии, узнаёт состояние пользователей и очередей, управляет звонками, скачивает записи разговоров и загружает файлы.

Что делает встроенный веб-сервер

Служба слушает порты 80 и 4055 — их можно изменить в настройках веб-сервера — и делает это на всех сетевых интерфейсах. Запросы принимаются методами GET и POST; в обоих случаях параметры можно перечислять в URL.

http://login:password@192.168.0.1:4055/wp_setuserstate?user=admin&userstateid=5

Запуск служебных сценариев

Основной способ научить платформу чему угодно: сценарий делает работу, HTTP-запрос его вызывает. Код запуска для этого способа — 27.

execsvcscript

В синхронном режиме ответом становится значение, присвоенное служебной переменной «Возвращаемое значение 1». Метод оборачивает его в XML.

execsvcscriptplain

То же самое и с теми же параметрами, но ответ сценария размещается в теле HTTP-ответа без искажений — без XML-обёртки. Это делает метод пригодным для отдачи чего угодно: строки, JSON, готовой HTML-страницы.

Как отдать результат сценария без авторизации

Порядок такой:

1. Положите в папку WWW рабочего каталога сервера файл test.html с любым содержимым.
2. Откройте http://server:port/test.html — без пароля должно вернуться содержимое файла.
3. Рядом создайте файл test.html.execsvcscriptplain, а в его теле разместите строку JSON:

{
  "scriptname": "myscript",
  "timeout": 10,
  "parameter1": "ЧЕРЕЗ WWW"
}

4. Создайте служебный сценарий myscript, выводящий какое-нибудь уведомление, чтобы было видно, что он запустился.
5. Выполните тот же запрос — уведомление должно появиться.

Все параметры GET-запроса — или POST с Content-type: application/x-www-form-urlencoded — разбираются и передаются на старт сценария так же, как при вызове execsvcscriptplain: значения параметров, режим исполнения, таймаут ожидания. В служебную переменную выходного значения можно положить любое содержимое, включая HTML-страницу, — оно вернётся в теле ответа без изменений.

Служебные данные запроса внутри сценария

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

{
  "scriptname": "myscript",
  "timeout": 10,
  "parameter1": "Константа",
  "parameter3": "%page%"
}

Плагины

execpluginmethod исполняет метод в серверном плагине, передавая параметры и возвращая результат с выходными значениями.

Ответом возвращается строка с содержимым JSON.

Состояние системы

Лицензия

Файлы

Скачивание

Общий параметр attachment: 1 — скачивание вложением, 0 — как медиа, по расширению файла. По умолчанию 1.

Загрузка

upload принимает файлы методом POST. Веб-сервер понимает multipart/form-data и application/octet-stream; в запросе должны присутствовать поля Content-Transfer-Encoding и Content-Disposition. Одним запросом через MIME можно передать несколько файлов. Чтобы имена не оказались случайными, исходные имена указываются параметром суб-заголовка Content-Disposition.

По умолчанию файлы размещаются во временном каталоге \OktellWorkDirectory\Temp\UploadData.

Ответом возвращается XML с описанием всех сохранённых файлов и путей к ним; для неудачно сохранённых атрибут saved равен нулю.

Управление звонками

Параметры дозвона

Режимы flash

Смена состояния пользователя