Skip to end of metadata
Go to start of metadata

Методы

СоздатьПользователя / СreateUser

Создание пользователя. Доступно только администратору

Синтаксис:

Параметры:  

  • login - логин пользователя. обязательное поле
  • password - пароль, удовлетворяющий требованиям сложности. пароль может быть пустым ("") - это означает что пользователь будет авторизоваться через LDAP
  • extensionNumber - внутренний номер. если extensionNumber = "", то система назначит номер автоматически
  • name - имя пользователя. если name = "", то name задаётся равным login
  • email - почтовый адрес. email - необязательное поле.

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.LoginNotUniqueException - Логин занят другим пользователем
  • com.orangeuce.pbx.api.exception.WeakPasswordException - Слабый пароль
  • com.orangeuce.pbx.api.exception.InvalidExtensionNumberException - Неверный формат внутреннего номера
  • com.orangeuce.pbx.api.exception.NameNotUniqueException - Имя занято другим пользователем
  • com.orangeuce.pbx.api.exception.InvalidEmailException - Неверный формат почтового адреса
  • com.orangeuce.pbx.api.exception.EmailNotUniqueException - Email присвоен другому пользователю
  • com.orangeuce.pbx.api.exception.UserLimitExceededException - Превышена квота на количество пользователей в системе
  • com.orangeuce.pbx.api.exception.EmergencyPeriodExceededException - Истёк срок действия экстренных лицензий
  • com.orangeuce.pbx.api.exception.AdminCantBeEmergencyException - Администратор не может быть создан по экстренной лицензии

 Доступность:

Доступен с 1.27

Пример:

РедактироватьПользователя / EditUser

Редактирование базовых параметров пользователя. Доступно только администратору

Синтаксис:

Параметры:

  • userId - Id существующего пользователя
  • login - если login = "", то остаётся старый логин
  • extensionNumber - если extensionNumber = "", то остаётся старый номер
  • name - если name = "", то остаётся старое имя
  • email - если email = "", то остаётся старое значение

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователя не существует
  • com.orangeuce.pbx.api.exception.LoginNotUniqueException - Логин занят другим пользователем
  • com.orangeuce.pbx.api.exception.WeakPasswordException - Слабый пароль
  • com.orangeuce.pbx.api.exception.InvalidExtensionNumberException - Неверный формат внутреннего номера
  • com.orangeuce.pbx.api.exception.NameNotUniqueException - Имя занято другим пользователем
  • com.orangeuce.pbx.api.exception.InvalidEmailException - Неверный формат почтового адреса
  • com.orangeuce.pbx.api.exception.EmailNotUniqueException - Email присвоен другому пользователю

Доступность:

Доступен с 1.27

Пример:

ИзменитьПарольПользователя / ChangeUserPassword

Изменение пароля пользователя. Доступно только администратору

Синтаксис:

Параметры:

  • userId - Id существующего пользователя
  • password - новое значение пароля пользователя

Возвращаемое значение: нет 

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователя не существует
  • com.orangeuce.pbx.api.exception.WeakPasswordException - Слабый пароль

Доступность:

Доступен с 1.27

Пример:

ИзменитьРольПользователя / ChangeUserRole

Изменение роль пользователя. Доступно только администратору. Существует всего три роли: USER (пользователь), ADMIN (супервизор), SUPER_ADMIN (администратор)

Синтаксис:

Параметры:

  • userId - Id существующего пользователя
  • role - одно из значений: USER, ADMIN, SUPER_ADMIN

Возвращаемое значение: нет 

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователя не существует
  • com.orangeuce.pbx.api.exception.IllegalArgumentException - Неверное значение роли

Доступность:

Доступен с 2.0

Пример:

УдалитьПользователя / DeleteUser

Удаление пользователя. Доступно только администратору

Синтаксис:

Параметры:

  • userId - Id существующего пользователя

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователя не существует
  • com.orangeuce.pbx.api.exception.SelfRemoveException - Попытка удалить самого себя
  • com.orangeuce.pbx.api.exception.DidNumberReferenceException - Требуется удалить ссылку на экстеншн пользователя в правилах входящих вызовов
  • com.orangeuce.pbx.api.exception.DefaultExtensionReferenceException - Требуется удалить ссылку на экстеншн пользователя в правилах входящих вызовов в разделе "экстеншн по умолчанию"
  • com.orangeuce.pbx.api.exception.LastSuperAdminException - Нельзя удалить единственного супер админа в системе
  • com.orangeuce.pbx.api.exception.IvrActionReferenceException - Требуется удалить ссылку на экстеншн пользователя в действии(ях) IVR
  • com.orangeuce.pbx.api.exception.QueueReferenceException - Пользователь является ответственным за звонки в очереди

Доступность:

Доступен с 1.27

Пример:

ПолучитьВсехПользователей / GetAllUsers

Получить список всех пользователей

Синтаксис:

Параметры: нет

Возвращаемое значение:

Исключения:

  • нет

Доступность:

Доступен с 1.27

Пример:

ПолучитьПользователяПоИД / GetUser

Получить информацию о пользователе по идентификатору

Синтаксис:

Параметры: 

  • userId - Id существующего пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователя не существует

Доступность:

Доступен с 1.27

Пример:

 

СоздатьГруппу / CreateUserGroup

Создание новой группы пользователей. Функция возвращает идентификатор созданной группы. Доступно только администратору

Синтаксис:

Параметры:

  • name - Название группы. Не может быть пустым
  • description - Описание группы. Может быть пустым

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.IllegalArgumentException - Передано пустое имя группы

Доступность:

Доступен с 1.27

Пример:

РедактироватьГруппу / EditUserGroup

Редактирование базовых параметров группы пользователей. Доступно только администратору

Синтаксис:

Параметры:

  • groupId - Id группы
  • name - Новое имя
  • description - Новое описание

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.IllegalArgumentException - Передано пустое имя группы
  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Группа не существует

Доступность:

Доступен с 1.27

Пример:

УдалитьГруппу / DeleteUserGroup

Удаление группы пользователей. Доступно только администратору

Синтаксис:

Параметры:

  • groupId - Id группы

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции
  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Группа не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьВсеГруппы / GetAllUserGroups

Получение списка всех групп пользователей

Синтаксис:

Параметры: нет

Возвращаемое значение:

Исключения: нет

Доступность:

Доступен с 1.27

Пример:

ПолучитьГруппуПоИД / GetUserGroup

Получение группы пользователей по идентификатору

Синтаксис:

Параметры:

  • id - Id группы

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Группа не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьГруппыПользователя / GetUserGroups

Получить группы, в которых состоит пользователь

Синтаксис:

Параметры:

  • userId - Id пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ДобавитьПользователяВГруппу / AddUserToGroup

Добавление пользователя в группу. Доступно только администратору

Синтаксис:

Параметры:

  • userId - Id пользователя
  • groupId - Id группы, куда добавить пользователя

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователя не существует или группы не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции

Доступность:

Доступен с 1.27

Пример:

УдалитьПользователяИзГруппы / RemoveUserFromGroup

Удаление пользователя из группы. Доступно только администратору

Синтаксис:

Параметры:

  • userId - Id пользователя
  • groupId - Id группы, откуда удалить пользователя

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - Пользователя не существует или группы не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - Недостаточно привилегий для выполнения операции

Доступность:

Доступен с 1.27

Пример:

ПолучитьВсеГруппыПодбора / GetAllPickupGroups

Получение всех групп подбора

Синтаксис:

Параметры: нет

Возвращаемое значение:

Исключения: нет

Доступность:

Доступен с 1.27

Пример:

ПолучитьГруппуПодбораПользователя / GetUserPickupGroup

Получение группы подбора пользователя

Синтаксис:

Параметры:

  • userId - идентификатор пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователя не существует

Доступность:

Доступен с 1.27

Пример:

ЗадатьГруппуПодбораПользователю / SetUserPickupGroup

Задание группы подбора пользователю

Синтаксис:

Параметры:

  • userId - идентификатор пользователя
  • pickupGroupId - идентификатор группы подбора

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не найден, группа подбора не найдена
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав для выполнения данной операции

Доступность:

Доступен с 1.27

Пример:

ПолучитьВсеОчереди / GetAllQueues

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

Синтаксис:

Параметры: нет

Возвращаемое значение:

Исключения: нет

Доступность:

Доступен с 1.27

Пример:

ПолучитьОчередьПоИД / GetQueue

Получение информации об очереди по ее идентификатору

Синтаксис:

Параметры:

  • queueId - идентификатор очереди

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - очередь не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьОчередиУказанногоПользователя / GetQueuesOfUser

Получение списка очередей, в которых участвует пользователь

Синтаксис:

Параметры:

  • userId - идентификатор пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ДобавитьПользователяВОчередь / AddUserToQueue

Добавление пользователя в очередь

Синтаксис:

Параметры:

  • userId - идентификатор пользователя
  • queueId - идентификатор очереди

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует, очередь не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав для выполнения данного действия

Доступность:

Доступен с 1.27

Пример:

УдалитьПользователяИзОчереди / RemoveUserFromQueue

Удаление пользователя из очереди

Синтаксис:

Параметры:

  • userId - идентификатор пользователя
  • queueId - идентификатор очереди

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует, очередь не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав для выполнения данного действия

Доступность:

Доступен с 1.27

Пример:

ПолучитьВнешниеТерминалыПользователя / GetExternalTerminals

Получение списка внешних терминалов пользователя

Синтаксис:

Параметры:

  • userId - идентификатор пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьВнешнийТерминал / GetExternalTerminal

 Получение внешнего терминала по его идентификатору

Синтаксис:

Параметры:

  • terminalId - идентификатор терминала

Возвращаемое значение: 

Исключения:

  • com.orangeuce.pbx.api.exception.TerminalNotExistsException - терминал не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьСофтТерминалыПользователя  / GetSoftwareSipTerminals

Получение списка программных терминалов пользователя

Синтаксис:

Параметры:

  • userId - идентификатор пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьСофтТерминал / GetSoftwareSipTerminal

 Получение программного терминала по его идентификатору

Синтаксис:

Параметры:

  • terminalId - идентификатор терминала

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.TerminalNotExistsException - терминал не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьАппаратныеТерминалыПользователя / GetHardwareSipTerminals

Получение списка аппаратных телефонов пользователя

Синтаксис:

Параметры:

  • userId - идентификатор пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьАппаратныйТерминал / GetHardwareSipTerminal

 Получение аппаратного терминала по его идентификатору

Синтаксис:

Параметры:

  • terminalId - идентификатор терминала

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.TerminalNotExistsException - терминал не существует

Доступность:

Доступен с 1.27

Пример:

ДобавитьВнешнийТерминалПользователю / AddExternalTerminal

Добавление пользователю внешнего терминала. Функция возвращает идентификатор созданного терминала.

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя
  • terminalName - название терминала
  • terminalNumber - номер терминала

Возвращаемое значение: 

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует
  • com.orangeuce.pbx.api.exception.TerminalNumberNotUniqueException - номер терминала уже используется у другого
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав на выполнение данного действия

Доступность:

Доступен с 1.27

Пример:

ДобавитьСофтТерминалПользователю / AddSoftwareSipTerminal

Добавление пользователю программного телефона. Функция возвращает идентификатор созданного терминала.

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя
  • terminalName - название терминала
  • terminalLogin - логин терминала
  • terminalPassword - пароль терминала

Возвращаемое значение: 

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует
  • com.orangeuce.pbx.api.exception.LoginNotUniqueException - логин терминала уже занят
  • com.orangeuce.pbx.api.exception.WeakPasswordException - пароль терминала слишком слабый
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав на выполнение данного действия

Доступность:

Доступен с 1.27

Пример:

ДобавитьАппаратныйТерминалПользователю / AddHardwareSipTerminal

Добавление пользователю аппаратного телефона. Функция возвращает идентификатор созданного терминала.

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя
  • terminalName - название терминала
  • terminalLogin - логин терминала
  • terminalPassword - пароль терминала
  • mac - MAC-адрес терминала
  • port - порт sip-терминала

Возвращаемое значение: 

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует
  • com.orangeuce.pbx.api.exception.LoginNotUniqueException - логин терминала уже занят
  • com.orangeuce.pbx.api.exception.WeakPasswordException - пароль терминалала слишком слабый
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав на выполнение данного действия

Доступность:

Доступен с 1.27

Пример:

УдалитьТерминалПользователя / DeleteUserTerminal

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

Синтаксис:

Параметры:

  • terminalId - идентификатор терминала

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - терминал не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав на выполнение данного действия

Доступность:

Доступен с 1.27

Пример:

ПолучитьТерминалыПользователяВПорядкеОбхода / GetOrderedUserTerminals

Получение списка терминалов пользователя в порядке обхода

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя

Возвращаемое значение: 

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ЗадатьПорядокОбходаТерминаловПользователя / SetUserTerminalsOrder

Задание порядка обхода терминалов пользователя

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя
  • terminalsIds - идентификаторы терминалов разделённые запятой

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует
  • com.orangeuce.pbx.api.exception.TerminalNotBelongToUserException - один из терминалов не принадлежит пользователю
  • com.orangeuce.pbx.api.exception.TerminalListIsNotComplete - список идентификаторов терминалов не содержит все идентификаторы терминалов пользователя
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав на выполнение данного действия

Доступность:

Доступен с 1.27

Пример:

РедактироватьВнешнийТерминал / EditExternalTerminal

Редактирование внешнего терминала

Синтаксис:

Параметры:

  • terminalId - идентификатор терминала
  • terminalName - название терминала. Если название = "", то остаётся старое значение
  • terminalNumber - номер терминала. Если номер = "", то остаётся старое значение

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsExceptionтерминал не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - недостаточно разрешений для совершения операции
  • com.orangeuce.pbx.api.exception.TerminalNumberNotUniqueException - номер терминала уже занят

Доступность:

Доступен с 1.27

Пример:

РедактироватьСофтТерминал / EditSoftwareSipTerminal

Редактирование программного терминала

Синтаксис:

Параметры:

  • terminalId - идентификатор терминала
  • terminalName - название терминала. Если название = "", то остаётся старое значение
  • terminalLogin - логин терминала. Если значение = "", то остаётся старое значение
  • terminalPassword - пароль терминала. Если значение = "", то остаётся старое значение

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsExceptionтерминал не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - недостаточно разрешений для совершения операции
  • com.orangeuce.pbx.api.exception.LoginNotUniqueException - логин терминала уже занят
  • com.orangeuce.pbx.api.exception.WeakPasswordException - пароль терминала слишком слабый

Доступность:

Доступен с 1.27

Пример:

РедактироватьАппаратныйТерминал / EditHardwareSipTerminal

Редактирование аппаратного терминала

Синтаксис:

Параметры:

  • terminalId - идентификатор терминала
  • terminalName - название терминала. Если название = "", то остаётся старое значение
  • terminalLogin - логин терминала. Если значение = "", то остаётся старое значение
  • terminalPassword - пароль терминала. Если значение = "", то остаётся старое значение
  • mac - MAC-адрес. Если значение = "", то остаётся старое значение

  • port - сетевой порт sip-терминала. Если значение = "", то остаётся старое значение

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsExceptionтерминал не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - недостаточно разрешений для совершения операции
  • com.orangeuce.pbx.api.exception.LoginNotUniqueException - логин терминала уже занят
  • com.orangeuce.pbx.api.exception.WeakPasswordException - пароль терминала слишком слабый

Доступность:

Доступен с 1.27

Пример:

ПолучитьПравилаПереадресацииПользователя / GetUserCallForwardingRules

Получение правил переадресации пользователя

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя

Возвращаемое значение: 

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ПолучитьПравилоПереадресацииПользователяПоТипу / GetUserCallForwardingRuleByType

Получить правила переадресации для указанного статуса

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя
  • type - тип правила
    Возможны следующие значения:
    • AVAILABLE - доступен
    • DND - не беспокоить
    • AWAY - отошел
    • OUT_OF_OFFICE - не в офисе
    • CUSTOM - пользовательский

Возвращаемое значение: 

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует
  • com.orangeuce.pbx.api.exception.IllegalArgumentException - неверный тип правила

Доступность:

Доступен с 1.27

Пример:

ЗадатьПравилоПереадресацииПользователяПоТипу / SetUserCallForwardingRuleByType

Задание правила переадресации указанному пользователю в зависимости от указанного статуса (AVAILABLE, DND, AWAY, OUT_OF_OFFICE, CUSTOM)

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя
  • type - тип правила
    Возможны следующие значения:
    • AVAILABLE - д+оступен
    • DND - не беспокоить
    • AWAY - отошел
    • OUT_OF_OFFICE - не в офисе
    • CUSTOM - пользовательский
  • reasonForwarding - причины переадресации:
    • BUSY и DO_NOT_RESPOND для типов AVAILABLE, CUSTOM
    • Пустое значение для DND, AWAY, OUT_OF_OFFICE
  • strategyForwarding - стратегия переадресации
    Возможны следующие значения:
    • VOICEMAIL - голосовая почта
    • TO_NUMBER - переадресация
    • BREAK - прервать
  • callTimeout - таймаут
  • forwardToNumber - учитывается, если strategyForwarding = TO_NUMBER

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует
  • com.orangeuce.pbx.api.exception.IllegalArgumentException - неверный аргумент

Доступность:

Доступен с 1.27

Пример:

ПолучитьСписокМузыкиНаУдержании / GetAllMoh

Получение списка всей Музыки на удержании

Синтаксис:

Параметры: нет

Возвращаемое значение:

Исключения: нет

Доступность:

Доступен с 1.27

Пример:

ПолучитьМузыкуНаУдержанииПользователя / GetUserMoh

Получение списка Музыки на удержании указанного пользователя

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ЗадатьМузыкуНаУдержанииПользователя / SetUserMoh

Задание Музыки на удержании для указанного пользователя

Синтаксис:

Параметры:

  • userId  - идентификатор пользователя
  • mohId - идентификатор музыки на удержании

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует, музыка на удержании не существует
  • com.orangeuce.pbx.api.exception.ApiPermissionException - нет прав для совершения данной операции

Доступность:

Доступен с 1.27

Пример:

ПолучитьВсеDIDНомера / GetAllDids

Получение списка всех DID номеров

Синтаксис:

Параметры: нет

Возвращаемое значение:

Исключения: нет

Доступность:

Доступен с 1.27

Пример:

ПолучитьDIDПользователя / GetUserCallerId

Получение DID Пользователя

Синтаксис:

Параметры:

  • userId - идентификатор пользователя

Возвращаемое значение:

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - пользователь не существует

Доступность:

Доступен с 1.27

Пример:

ЗадатьDIDПользователя / SetUserCallerId

Задание DID Пользователя

Синтаксис:

Параметры:

  • userId - идентификатор пользователя
  • didId - идентификатор did номера

Возвращаемое значение: нет

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - не существует пользователь или DID
  • com.orangeuce.pbx.api.exception.ApiPermissionException - недостаточно прав на выполнение данной операции

Доступность:

Доступен с 1.27

Пример:

 

ЗадатьНастройкиЗаписиЗвонков / SetRecordingSettings

Задание настроек записи звонков. Существует три типа настройки: RECORD_ALL (записывать все звонки), DENY_RECORD (запретить запись звонков), DEFAULT (по умолчанию не записывать)

Синтаксис:

Параметры:

  • userId - идентификатор пользователя
  • recordingSettings - новое значение настроек

Возвращаемое значение: нет 

Исключения:

  • com.orangeuce.pbx.api.exception.ObjectNotExistsException - не существует пользователь 
  • com.orangeuce.pbx.api.exception.ApiPermissionException - недостаточно прав на выполнение данной операции
  • com.orangeuce.pbx.api.exception.IllegalArgumentException - неверное значение настроек записи

Доступность:

Доступен с 2.0

Пример:

События

com.orangeuce.pbx.api.events.UserNotification.UserCreatedEvent

Уведомление о создании пользователя.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.UserNotification.UserModifiedEvent

Уведомление об изменении пользователя.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.UserNotification.UserDeletedEvent

Уведомление об удалении пользователя.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.UserNotification.UserGroupCreatedEvent

Уведомление о создании группы пользователей.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.UserNotification.UserGroupModifiedEvent

Уведомление о редактировании группы пользователей.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.UserNotification.UserGroupDeletedEvent

Уведомление об удалении группы пользователей.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.UserNotification.UserExtensionModifiedEvent

Уведомление об изменении экстеншена пользователя: изменился moh, изменился caller Id, добавлен терминал пользователю, изменился порядок терминалов.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.TerminalNotification.TerminalModifiedEvent

Уведомление об изменении терминала пользователя: внешнего, софтверного, аппаратного.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.TerminalNotification.TerminalDeletedEvent

Уведомление об изменении терминала пользователя: внешнего, софтверного, аппаратного.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.QueueNotification.QueueAddEvent

Уведомление о создании новой очереди.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.QueueNotification.QueueModifiedEvent

Уведомление об изменении очереди.

Сообщение:

Доступность:

Доступно с 1.27.

com.orangeuce.pbx.api.events.QueueNotification.QueueDeleteEvent

Уведомление об удалении очереди.

Сообщение:

Доступность:

Доступно с 1.27.

 

  • No labels