Skip to end of metadata
Go to start of metadata

Методы

ПревратитьВКонференцию / TurnIntoConference

Превращает разговор в конференцию.

Синтаксис:

Параметры:

  • legId - идентификатор разговор

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

Идентификатор конференции

Исключения:

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

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

Доступен с 1.27.

Пример:

ПревратитьВКонференциюИДобавитьУчастников / TurnIntoConferenceAndAddParticipants

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

Синтаксис:

Параметры:

  • legId - идентификатор разговора
  • participants - номера добавляемых участников разделённых запятой

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

Идентификатор конференции

Исключения:

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

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

Доступен с 1.27.

Пример:

НачатьКонференцию / StartConference

Инициирует конференцию с пользователями.

Синтаксис:

Параметры:

  • participants - номера участников разделённых запятой

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

Идентификатор конференции

Исключения:

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

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

Доступен с 1.27.

Пример:

ПолучитьАктивныеКонференции / GetActiveConferences

Получает список активных конференций.

Синтаксис:

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

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

Список активных конференций

Исключения:

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

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

Доступен с 1.27.

Пример:

ПолучитьАктивнуюКонференцию / GetActiveConference

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

Синтаксис:

Параметры:

  • conferenceId - идентификатор конференции

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

Информация о активной конференции

Исключения:

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

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

Доступен с 1.27.

Пример:

ДобавитьВКонференцию / AddToConference

Добавляет участника в конференцию.

Синтаксис:

Параметры:

  • conferenceId - идентификатор конференции

  • number - номер добавляемого пользователя

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

Исключения:

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

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

Доступен с 1.27.

Пример:

УдалитьИзКонференции / RemoveFromConference

Удаляет участника из конференции.

Синтаксис:

Параметры:

  • conferenceId - идентификатор конференции
  • number -  номер удаляемого пользователя

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

Исключения:

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

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

Доступен с 1.27.

Пример:

ПолучитьЗапланированныеКонференции / GetPlannedConferences

Получает запланированные конференции.

Синтаксис:

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

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

Список запланированных конференций.

Исключения:

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

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

Доступен с 1.27.

Пример:

ПолучитьЗапланированнуюКонференцию / GetPlannedConference

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

Синтаксис:

Параметры:

  • conferenceId - идентификатор конференции

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

Информация о запланированной конференции

Исключения:

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

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

Доступен с 1.27.

Пример:

СоздатьЗапланированнуюКонференцию / CreatePlannedConference

Создаёт запланированную конференцию.

Синтаксис:

Параметры:

  • name - название
  • startDate - время начала конференции(в UnixTime в микросекундах)
  • participants - номера участников, разделённые запятыми

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

Идентификатор конференции

Исключения:

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

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

Доступен с 1.27.

Пример:

ИзменитьЗапланированнуюКонференцию / UpdatePlannedConference

Обновляет запланированную конференцию.

Синтаксис:

Параметры:

  • conferenceId - идентификатор обновляемой конференции

  • name - название конференции

  • startDate - время начала (в UnixTime в микросекундах)

  • participants - список участников, разделённых запятой

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

Исключения:

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

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

Доступен с 1.27.

Пример:

УдалитьЗапланированнуюКонференцию / RemovePlannedConference

Удалить участника из конференции.

Синтаксис:

Параметры:

  • conferenceId - идентификатор удаляемой конференции

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

Исключения:

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

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

Доступен с 1.27.

Пример:

ПовторитьКонференцию / RepeatConference

Повторяет завершённую конференцию.

Синтаксис:

Параметры:

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

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

Идентификатор новой конференции

Исключения:

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

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

Доступен с 1.27.

Пример:

ПолучитьЗавершённыеКонференции / GetEndedConferences

Получает завершённые конференции пользователя.

Синтаксис:

Параметры:

  • userId - идентификатор пользователя
  • begin - дата начала (в UnixTime в микросекундах)
  • end - дата завершения (в UnixTime в микросекундах)
  • chunk - номер чанка

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

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

либо


Исключения:

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

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

Доступен с 1.27.

Пример:

События

com.orangeuce.pbx.api.events.PresenceNotification.CreatedPlannedConferenceEvent

Возникает когда запланировали конференцию.

Сообщение:

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

Доступно с 1.27.

com.orangeuce.pbx.api.events.PresenceNotification.ChangedPlannedConferenceEvent

Возникает после внесения правок в существующую запланированную конференцию.

Сообщение:


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

Доступно с 1.27.

com.orangeuce.pbx.api.events.PresenceNotification.DeletePlannedConferenceEvent

Возникает после удаления запланированной конференции. Так же это событие возникает когда запланированная конференция становиться активной.

Сообщение:

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

Доступно с 1.27.

com.orangeuce.pbx.api.events.PresenceNotification.StartConferenceEvent

Возникает при начале конференции.

Сообщение:

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

Доступно с 1.27.

com.orangeuce.pbx.api.events.PresenceNotification.EndConferenceEvent

Возникает после завершения конференции.

Сообщение:

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

Доступно с 1.27.

com.orangeuce.pbx.api.events.PresenceNotification.AddParticipantToConferenceEvent

Возникает при добавлении участников в конференцию. 

Сообщение:

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

Доступно с 1.27.

com.orangeuce.pbx.api.events.PresenceNotification.RemoveParticipantFromConferenceEvent

Возникает при удалении участника из конференции.

Сообщение:

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

Доступно с 1.27.

com.orangeuce.pbx.api.events.PresenceNotification.UpdateParticipantConferenceEvent

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

Сообщение:

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

Доступно с 1.27.

  • No labels