Skip to end of metadata
Go to start of metadata

Методы

ПолучитьИсторию / GetParamUserEvent

Получить фрагмент истории коммуникаций пользователя за указанный промежуток времени. Размер истории фиксирован в 32 события.

Синтаксис:

Параметры:

  • begin - начало временного диапазона. UnixTime в микросекундах.
  • end - конец временного диапазона. UnixTime в микросекундах.
  • chunk - фрагмент истории начинающийся с 0, каждый фрагмент содержит по 32 записи.

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

Пустой список, когда чанки закончились

либо

Исключения:

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

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

Доступен с 1.22.

Пример:

ПолучитьВсюИсторию / GetAllEvents

Синтаксис:

Параметры:

  • begin - начало временного диапазона. UnixTime в микросекундах.
  • end - конец временного диапазона. UnixTime в микросекундах.
  • chunk - фрагмент истории начинающийся с 0, каждый фрагмент содержит по 32 записи.

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

Пустой список, когда чанки закончились

либо

Исключения:

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

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

Доступен с 1.22.

Пример:

ЗаписьДоступна / IsFileAvailableByFlowId

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

Синтаксис:

Параметры:

  • flowId - идентификатор flowId события

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

Исключения:

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

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

Доступен с 1.22.

Пример:

ПолучитьТокен / GetDownloadToken

Получить токен для скачивания файла с записью. Токен представляет собой GUID, который передается в качестве параметра в строке запроса http://127.0.0.1/download/?token=b52ea040-1436-4e11-90bd-acc7205f929c Где 127.0.0.1 адрес сервера, а b52ea040-1436-4e11-90bd-acc7205f929c токен. Данный токен будет валиден в течение одного часа. Если скачать файл не удалось, необходимо запросить новый токен. Скачивать запись могут только участники, либо пользователи с ролью супервайзер либо администратор. Данный URL можно передать на воспроизведение в большинство аудиоплееров. Если такого события не существует, то будет выброшено исключение, во всех остальных случаях сначала произойдет проверка прав доступа и наличия файла записи и затем вернется токен. Если файл не будет найден на локальном диске, то будет проверен сервис выбранный для загрузки записей. При обращении по данному URL может произойти некоторая задержка, если файл еще не успел загрузиться из удаленного хранилища.

Синтаксис:

Параметры:

  • flowId - идентификатор flowId события

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

Исключения:

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

Ошибки HTTP запроса:

  • если не указан токен, то ошибку 400
  • если активный токен не найден, то ошибку 403
  • если файл с записью не найден, то ошибку 404
  • если произошла внутренняя ошибка, то ошибку 500. В этом случае стоит обратиться в службу поддержки, поскольку это возможная ошибка.

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

Доступен с 1.22.

Пример:

События

com.orangeuce.pbx.api.events.PresenceNotification.Event

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

Сообщение:

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

Доступно с 1.22.

  • No labels