Skip to end of metadata
Go to start of metadata

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

Методы

ПодписатьсяНаГруппуСобытий / Subscribe

Синтаксис:

Параметры:

  • events - группы событий с модификаторами, разделённые запятой

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

Исключения: 

  • com.orangeuce.pbx.api.exception.EventGroupNotFoundException - не найдена одна из переданных групп событий
  • com.orangeuce.pbx.api.exception.BadModificatorFormatException - не верно задан модификатор группы событий

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

Доступен с версии 2.0.

Пример: В данном примере, с помощью метода ПодписатьсяНаГруппуСобытий осуществляется:

  • подписка на все события группы PARK_CALL
  • подписка на свои события группы TERMINAL (подробнее про "свои события" смотри здесь)
  • отказ от подписки на события группы LEG

ОтписатьсяОтГруппыСобытий / UnSubscribe

Синтаксис:

Параметры:

  • events - группы событий с модификаторами, разделённые запятой

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

Исключения:

  • com.orangeuce.pbx.api.exception.EventGroupNotFoundException - не найдена одна из переданных групп событий
  • com.orangeuce.pbx.api.exception.BadModificatorFormatException - не верно задан модификатор группы событий

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

Доступен с версии 2.0.

Пример: В данном примере, с помощью метода ОтписатьсяОтГруппыСобытий осуществляется отказ от подписки на все события групп QUEUE_STATUS, RECORDING_CALL и PLANNED_CONFERENCE.

ПолучитьГруппыСобытий / GetSubscribedEventGroups

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

Синтаксис:

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

Возвращаемое значение: список групп событий с модификаторами

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

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

Доступен с версии 2.0.

Пример:

Доступные группы событий и модификаторы

ACTIVE_TERMINAL

События этой группы:

  • PresenceNotification.ChangeActiveTerminalEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событием пользователя считается событие, в котором проставлен его идентификатор.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

STATUS

События этой группы:

  • PresenceNotification.ChangeStatusEvent
  • PresenceNotification.ChangeStateEvent
  • PresenceNotification.ChangeTextStatusEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событием пользователя считается событие, в котором проставлен его идентификатор.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

QUEUE_STATUS

События этой группы:

  • PresenceNotification.EnterQueueEvent
  • PresenceNotification.EscapeQueueEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. События считаются своими если пользователь оператор в очереди или ответсвенный.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

LEG

События этой группы: PresenceNotification.AddLegEvent, PresenceNotification.UpdateLegEvent, PresenceNotification.DeleteLegEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь -  свои события (в которых проставлен его идентификатор) + события очереди, в которой он является оператором.
    • супервайзер - свои события (в которых проставлен его идентификатор) + события очереди, в которой он является оператором + события  пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

RECORDING_CALL

События этой группы:

  • PresenceNotification.StartRecordingCallEvent
  • PresenceNotification.StopRecordingCallEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - события звонка, в котором он является участником
    • супервайзер - события звонка, в котором он является участником
    • администратор - все события
  • ALL - получать все события этой группы

PARK_CALL

События этой группы:

  • PresenceNotification.ParkEvent
  • PresenceNotification.UnparkEvent

Модификаторы

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - события звонка, в котором он является участником
    • супервайзер - события звонка, в котором он является участником
    • администратор - все события
  • ALL - получать все события этой группы

PLANNED_CONFERENCE

События этой группы:

  • PresenceNotification.CreatedPlannedConferenceEvent
  • PresenceNotification.ChangedPlannedConferenceEvent
  • PresenceNotification.DeletePlannedConferenceEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - события конференции, в которой он является участником
    • супервайзер - события конференции, в которой он является участником
    • администратор - все события
  • ALL - получать все события этой группы

ACTIVE_CONFERENCE

События этой группы:

  • PresenceNotification.StartConferenceEvent
  • PresenceNotification.EndConferenceEvent
  • PresenceNotification.AddParticipantToConferenceEvent
  • PresenceNotification.RemoveParticipantFromConferenceEvent
  • PresenceNotification.UpdateParticipantConferenceEvent
  • PresenceNotification.RaisedHandConferenceEvent
  • PresenceNotification.OmittedHandConferenceEvent
  • PresenceNotification.UnMuteMemberConferenceEvent
  • PresenceNotification.MuteMemberConferenceEvent
  • PresenceNotification.GrantedModeratorRightsConferenceEvent
  • PresenceNotification.StartRecordingConferenceEvent
  • PresenceNotification.StopRecordingConferenceEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - события конференции, в которой он является участником
    • супервайзер - события конференции, в которой он является участником
    • администратор - все события
  • ALL - получать все события этой группы

EVENT_HISTORY

События этой группы:

  • PresenceNotification.CreateEvent
  • PresenceNotification.Event
  • PresenceNotification.ReadMissedEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - события звонка, в котором он являлся участником
    • супервайзер - события звонка, в котором участником являлся он или пользователь, состоящий с ним в одной группе.
    • администратор - все события
  • ALL - получать все события этой группы

TERMINAL

События этой группы:

  • TerminalNotification.TerminalModifiedEvent
  • TerminalNotification.TerminalDeletedEvent
  • TerminalNotification.TerminalStatusChangedEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событием пользователя считается событие, в котором проставлен идентификатор его терминала.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

USER

События этой группы:

  • UserNotification.UserCreatedEvent
  • UserNotification.UserModifiedEvent
  • UserNotification.UserDeletedEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событием пользователя считается событие, в котором проставлен его идентификатор.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

USER_GROUP

События этой группы:

  • UserNotification.UserGroupCreatedEvent
  • UserNotification.UserGroupModifiedEvent
  • UserNotification.UserGroupDeletedEvent

Модификаторы:

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - события группы, в которой он состоит
    • супервайзер - события группы, в которой он состоит
    • администратор - все события
  • ALL - получать все события этой группы

USER_EXTENSION

События этой группы:

  • UserNotification.UserExtensionModifiedEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событием пользователя считается событие, в котором проставлен его идентификатор.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

CONTACT

События этой группы:

  • ContactNotification.ContactCreatedEvent
  • ContactNotification.ContactChangedEvent
  • ContactNotification.ContactDeletedEvent
  • ContactNotification.ContactAddToFavoriteListEvent
  • ContactNotification.ContactRemoveFromFavoriteListEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событием пользователя считается событие, в котором проставлен его идентификатор.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

QUEUE

События этой группы:

  • QueueNotification.QueueAddEvent
  • QueueNotification.QueueModifiedEvent
  • QueueNotification.QueueDeleteEvent

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событие считается событием пользователя, если он является агентом или ответсвенным в очереди.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события.
  • ALL - получать все события этой группы

SMS

События этой группы:

  • SmsNotification.SentSmsEvent
  • SmsNotification.DidNotSendSmsEvent
  • SmsNotification.UpdateProviderListEvent 

Модификаторы:

  • NONE - не получать события этой группы
  • MINE - получать события в зависимости от роли пользователя:
    • пользователь - только свои события. Событием пользователя считается событие, в котором проставлен его идентификатор.
    • супервайзер - свои события и события пользователей, состоящих с ним в одной группе.
    • администратор - все события .
  • ALL - получать все события этой группы

Подписка на группы событий, заданная по умолчанию

  • ACTIVE_TERMINAL.MINE
  • STATUS.ALL
  • QUEUE_STATUS.MINE
  • LEG.MINE
  • RECORDING_CALL.MINE
  • PARK_CALL.ALL
  • PLANNED_CONFERENCE.ALL
  • ACTIVE_CONFERENCE.ALL
  • EVENT_HISTORY.MINE
  • TERMINAL.MINE
  • USER.ALL
  • USER_GROUP.ALL
  • USER_EXTENSION.MINE
  • CONTACT.ALL
  • QUEUE.MINE
  • SMS.MINE
  • No labels