api:users

Список запросов

Запрос	Описание
users/element.list	Получает список сотрудников
users/element.get	Получает параметры сотрудника
users/element.add	Добавляет нового сотрудника
users/element.edit	Изменяет параметры сотрудника
users/element.del	Удаляет сотрудника
users/device.list	Получает список телефонов
users/device.get	Получает параметры телефона
users/device.add	Добавляет новый телефон
users/device.edit	Изменяет параметры телефона
users/device.del	Удаляет телефон

users/element.list

Получает список сотрудников

Параметры запроса:
Нет

Возврат: Массив объектов в формате json

elementId - Идентификатор сотрудника
elementName - Имя сотрудника
elementExten - Внутренний номер сотрудника

users/element.get

Получает параметры сотрудника

Параметры запроса:

elementId - Идентификатор сотрудника

Возврат: Объект в формате json

elementId - Идентификатор сотрудника
elementName - Имя сотрудника
elementExten - Внутренний номер сотрудника
schemeId - Идентификатор схемы по которой должны обрабатываться исходящие звонки сотрудника.
ringtimer - Время дозвона до сотрудника. 0 - Время дозвона по умолчанию. По истечении этого времени считается что сотрудник не ответил на звонок и будет вызвана переадресация, если она настроена.
password - Пароль сотрудника. На текущий момент используется для авторизации в «менеджере звонков», в дальнейшем планируется для личного кабинета сотрудника.
recording - Запись разговоров. 0 - Не записывать звонки. 1 - Записывать звонки.
callWaiting - Определяет реакцию на звонок если сотрудник уже занят. 0-Если сотрудник занят, завершать дозвон. 1-Если сотрудник занят, всё равно отправить звонок на телефон (ип телефоны многоканальные и позволяют отобразить 2-й и более звонок)
userRedirectEnable - Включить переадресацию заданную сотрудником. Это заготовка для личного кабинета, где сотрудник сможет сам управлять своей переадресацией. В текущей версии личного кабинета нет, но переадресация заданная сотрудником работает.
userRedirectNum - Номер телефона заданный сотрудником, на который переадресовывать звонки.
userRedirectSchemeId - Идентификатор схемы для переадресации заданной сотрудником. 0-исходящая схема сотрудника (schemeId). У сотрудника могут быть запреты например для выхода в город, но администратор может указать другую схему, которая будет использоваться только для переадресаций.
adminRedirectModule - Переадресация звонка на другой модуль АТС (задаётся в виде внутреннего имени модуля, например: users,ivr,extline) Переадресация задаваемая в этом параметре позволяет переадресавать на любой элемент в том числе без внутреннего номера, может быть настроена только администратором АТС и имеет приоритет выше чем переадресация заданная сотрудником.
adminRedirectElementId - Элемент модуля указанного в параметре adminRedirectModule на который происходит переадресация
adminRedirectParam - Параметры элемента указанного в adminRedirectElementId. На текущий момент параметры поддерживают только элементы модуля «Внешняя линия»(extline) и параметром является номер телефона, который необходимо набрать по внешней линии.

users/element.add

Создаёт нового сотрудника

Параметры запроса:

elementName - Имя сотрудника
elementExten - Внутренний номер сотрудника
schemeId - Идентификатор схемы по которой должны обрабатываться исходящие звонки сотрудника.
ringtimer - Время дозвона до сотрудника. 0 - Время дозвона по умолчанию. По истечении этого времени считается что сотрудник не ответил на звонок и будет вызвана переадресация, если она настроена.
password - Пароль сотрудника. На текущий момент используется для авторизации в «менеджере звонков», в дальнейшем планируется для личного кабинета сотрудника.
recording - Запись разговоров. 0 - Не записывать звонки. 1 - Записывать звонки.
callWaiting - Определяет реакцию на звонок если сотрудник уже занят. 0-Если сотрудник занят, завершать дозвон. 1-Если сотрудник занят, всё равно отправить звонок на телефон (ип телефоны многоканальные и позволяют отобразить 2-й и более звонок)
userRedirectEnable - Включить переадресацию заданную сотрудником. Это заготовка для личного кабинета, где сотрудник сможет сам управлять своей переадресацией. В текущей версии личного кабинета нет, но переадресация заданная сотрудником работает.
userRedirectNum - Номер телефона заданный сотрудником, на который переадресовывать звонки.
userRedirectSchemeId - Идентификатор схемы для переадресации заданной сотрудником. 0-исходящая схема сотрудника (schemeId). У сотрудника могут быть запреты например для выхода в город, но администратор может указать другую схему, которая будет использоваться только для переадресаций.
adminRedirectModule - Переадресация звонка на другой модуль АТС (задаётся в виде внутреннего имени модуля, например: users,ivr,extline) Переадресация задаваемая в этом параметре позволяет переадресавать на любой элемент в том числе без внутреннего номера, может быть настроена только администратором АТС и имеет приоритет выше чем переадресация заданная сотрудником.
adminRedirectElementId - Элемент модуля указанного в параметре adminRedirectModule на который происходит переадресация
adminRedirectParam - Параметры элемента указанного в adminRedirectElementId. На текущий момент параметры поддерживают только элементы модуля «Внешняя линия»(extline) и параметром является номер телефона, который необходимо набрать по внешней линии.

Возврат:
Идентификатор нового сотрудника

users/element.edit

Изменяет параметры сотрудника

Параметры запроса: Совпадает с users/element.add
Возврат: - Булево

users/element.del

Удаляет сотрудника

Параметры запроса:

elementId - Идентификатор сотрудника

Возврат: - Булево

users/device.list

Получает параметры телефона

Параметры запроса:
Нет

Возврат: Массив объектов в формате json

elementId - Идентификатор телефона
elementName - Название/описание телефона
deviceUniqueId - уникальный буквенноцифровой идентификатор. Подходит для использования в качестве логина
userId - Идентификатор сотрудника которому назначен данный телефон
isCommon - Признак общего телефона (устарело)
proto - Название модуля протокола (на текущий момент поддерживается только модуль 'PJSIP')
protoDeviceId - Идентификатор элемента протокола для модуля из параметра 'proto'

users/device.get

Получает список телефонов

Параметры запроса:

elementId - Идентификатор телефона

Возврат: Объект в формате json

elementId - Идентификатор телефона
elementName - Название/описание телефона
elementExten - Для телефона не используется
deviceUniqueId - уникальный буквенноцифровой идентификатор. Подходит для использования в качестве логина
userId - Идентификатор сотрудника которому назначен данный телефон
isCommon - Признак общего телефона (устарело)
protoDeviceObject - Объект voip протокола в формате json. Содержит параметры для подключения телефонов к АТС.

protoDeviceObject для sip протокола:

callerId - Имя и номер отображаемое при исходящих звонка с телефона. Внимание, когда телефон сопоставлен с сотрудником это поле игнорируется и подставляется внутренний номер и имя сотрудника.
login - Логин для подключения телефона и Внутреннее обозначение телефона в платформе asterisk
password - Пароль для подключения телефона
pickupGroups - группы перехвата в формате платформы asterisk, например: '1,2' - можно перехватывать группу 1 и 2
callGroups - принадлежность группам перехвата, например '1,3' - входящий звонок на этот номер будет входить в группу 1 и 3
account - Внутренний идентификатор sip аккаунта платформы asterisk (используется для биллинга)
sendrpid - Ответивший сотрудник и номер добавляется в sip протокол отдельным полем. Не всегда отвечает тот номер на который мы позвонили, существуют переводы и перехваты. Этот параметр позволяет телефону отобразить реальный аппарат с которым он соединён. На аппаратном телефоне должна быть поддержка rpid.
qualify - Заставляет платформу asterisk отправлять пакет options на телефон каждые 60 секунд. Используется для определения доступности телефона и удержания подключения активным, что-бы nat сервисы не сменили порт.
deviceId - Идентификатор телефона с которым сопоставлен объект voip протокола

users/device.add

Добавляет новый телефон

На текущий момент АТС поддерживает только sip протокол

Параметры запроса:

elementName - Название/описание телефона
userId - Идентификатор сотрудника которому будет назначен телефон
isCommon - Признак общего телефона (устарело)
pickupGroups - Группы перехвата в формате платформы asterisk, например: '1,2' - можно перехватывать группу 1 и 2
password - пароль для нового телефона
callGroups - принадлежность группам перехвата, например '1,3' - входящий звонок на этот номер будет входить в группу 1 и 3

Возврат: Объект в формате json. Совпадает с возвратом users/device.get

users/device.edit

Изменяет параметры телефона

Параметры запроса:

elementId - Идентификатор телефона для изменения
elementName - Название/описание телефона
userId - Идентификатор сотрудника которому будет назначен телефон
isCommon - Признак общего телефона (устарело)
pickupGroups - Группы перехвата в формате платформы asterisk, например: '1,2' - можно перехватывать группу 1 и 2
password - пароль для нового телефона
callGroups - принадлежность группам перехвата, например '1,3' - входящий звонок на этот номер будет входить в группу 1 и 3

Возврат: Объект в формате json. Совпадает с возвратом users/device.get

users/device.del

Удаляет телефон

Параметры запроса:

elementId - Идентификатор телефона для удаления

Возврат- Булево