Skip to end of metadata
Go to start of metadata

Методы

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

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

Синтаксис:

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

Возвращаемое значение: Пустой список

либо

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

ПолучитьОчереди / GetQueues

Получает информацию о очередях существующих в системе.

Синтаксис:

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

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.24.

Пример:

ПолучитьОчередиПользователя / GetUserQueues

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

Синтаксис:

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

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

НайтиПользователя / FindContactByIdentifier

Найти пользователя по логину либо e-mail пользователя

Синтаксис:

Параметры:

  • identifier - логин или e-mail пользователя

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

Исключения:

  • com.orangeuce.pbx.api.exception.UserNotExistsException - пользователь с таким идентификатором не найден
  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

ПолучитьСвойстваПользователя / GetUserProperties

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

Синтаксис:

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

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.24.

Пример:

 

ПолучитьКонтакт / GetContact

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

Синтаксис:

Параметры:

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

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

Исключения:

  • com.orangeuce.pbx.api.exception.ContactNotExistsException - пользователь с таким идентификатором не найден
  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

ПолучитьКонтактыПользователя / GetContacts

Получить все контакты доступные текущему пользователю

Синтаксис:

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

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

ПолучитьСтатусДляПользователя / GetUserStatus

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

Синтаксис:

Параметры:

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

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.24.

Пример:

ПолучитьСтатусы / GetPresence

Получить статусы всех пользователей в виде ассоциативного списка, в котором ключом является идентификатор пользователя, а значением статус.

Синтаксис:

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

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

СменитьАктивныйТерминал / ChangeActiveTerminal

Изменить активный терминал текущего пользователя. Доступные терминалы можно узнать, вызвав метод ПолучитьТерминалыПользователя

Синтаксис:

Параметры:

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

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

Исключения:

  • com.orangeuce.pbx.api.exception.TerminalNotExistsException - терминал с таким идентификатором не найден
  • com.orangeuce.pbx.api.exception.ApiPermissionException - терминал не принадлежит текущему пользователю
  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

СменитьСтатус / ChangeUserStatus

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

Синтаксис:

Параметры:

  • status - статус пользователя

Допустимые значения для статуса:

  • AVAILABLE - доступен
  • DND - не беспокоить
  • AWAY - отошел
  • OUT_OF_OFFICE - не в офисе
  • CUSTOM - пользовательский

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

СменитьТекстовыйСтатус / ChangeUserTextStatus

Изменить текстовый статус пользователя.

Синтаксис:

Параметры:

  • status - текстовый статус пользователя

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

Исключения:

  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

СменитьСтатусОчереди / ChangeUserQueueStatus

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

Синтаксис:

Параметры:

  • status - статус пользователя в очереди

Допустимые значения для статуса:

  • READY - готов принимать звонки из очереди
  • NOT_READY - покинуть очередь

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

Исключения:

  • com.orangeuce.pbx.api.exception.TerminalNotExistsException - у пользователя отсутствует активный терминал
  • Apache.NMS... - ошибка взаимодействия с сервером. Вариантов много, но все будут начинаться с Apache.NMS

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

Доступен с 1.22.

Пример:

События

com.orangeuce.pbx.api.events.PresenceNotification.EnterQueueEvent

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

Сообщение:

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

Доступно с 1.22.

com.orangeuce.pbx.api.events.PresenceNotification.EscapeQueueEvent

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

Сообщение:

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

Доступно с 1.22.

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.ContactNotification.ContactChangedEvent

Уведомление об изменении пользователя, в том числе имя, связанные с ним очередитерминалы.

Сообщение:

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

Доступно с 1.22.

com.orangeuce.pbx.api.events.PresenceNotification.ChangeStatusEvent

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

Сообщение:

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

Доступно с 1.22.

com.orangeuce.pbx.api.events.PresenceNotification.ChangeTextStatusEvent

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

Сообщение:

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

Доступно с 1.22.

com.orangeuce.pbx.api.events.PresenceNotification.ChangeActiveTerminalEvent

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

Сообщение:

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

Доступно с 1.22.

  • No labels