Инструменты пользователя

Инструменты сайта


Боковая панель

api

Основные положения

Доступ к апи осуществляется POST или GET веб запросом вида:
http[s]://<ipaddress>/Api/api_v2/<modulename>/<modulerequest>?<requestparams>&apikey=<apikey>

Внимание https не поддерживается по умолчанию и добавляется внутренней it службой компании

Где:

  • ipaddress - ip адрес или доменное имя АТС
  • apikey - апи ключ для доступ к АТС (необходимо хранить в секрете)
  • modulename - имя модуля к которому направлен апи запрос
  • modulerequest - апи запрос
  • requestparams - параметры запроса

Доступные modulename, modulerequest и requestparams описаны ниже.

apikey и requestparams рекомендуется передавать в теле POST запроса

Возврат - json объект вида:

{ response:<apiresult>, errors:[<errors>] }

  • apiresult - результат выполнения запроса. Для каждого запроса описывается отдельно
  • errors - массив ошибок при выполнении запроса

Например: http://mypbx.localdomain/Api/api_v2/users/element.get?elementid=1&apikey=7f643d74a3494136dec92d83ccda0c60092c1271
Возврат:

{"response": {
  "password":"ХХХХХ", 
  "ringtimer":"0", 
  "recording":"1", 
  "schemeId":1, 
  "callWaiting":true, 
  "userRedirectSchemeId":"1", 
  "userRedirectEnable":true, 
  "userRedirectNum":"910", 
  "elementId":"1", 
  "elementName":"Менеджер1", 
  "elementExten":"112", 
  "adminRedirectModule":"", 
  "adminRedirectElementId":0, 
  "adminRedirectParam":"" 
}}

Настройка доступа

Настройки апи доступа находятся в меню Настройки→Апи

Доступ с внешних ip адресов - Определяет доступ к АПИ с внешних ип адресов. Локальными ip адресами считаются 192.168.0.0/16, 127.0.0.0/8 и 10.0.0.0/8.

Использование api с внешних ip адресов по http небезопасно

api.txt · Последние изменения: 2020/06/08 22:41 — admin