Интерфейс Parlay X
В Сервере CommuniGate Pro реализован Интерфейс Parlay X для работы с Сигналами Реального Времени, Автоматическими Правилами, Тарификацией и другими функциями. Parlay X является протоколом на базе HTTP/XML. Он используется при обращении через модуль HTTP User CommuniGate Pro к разделу /ParlayX/.
Все HTTP запросы Parlay X должны быть аутентифицированы.
Поддерживается интерфейс Parlay X версии 2 и версии 3.
Управление Звонками Третьей Стороной
Управление Звонками Третьей Стороной через Интерфейс ParlayX позволяет клиентскому приложению:
- инициировать звонок между двумя сторонами
- читать статус инициированного звонка
- прервать инициированный звонок
- закончить инициированный звонок
При получении запроса на "установление звонка", CommuniGate Pro запускает от имени аутентифицированного пользователя приложение parlayMakeCall из среды приложений Реального Времени.
Параметры приложения являются параметрами запроса: адреса вызывающей и вызываемой стороны и, при необходимости, параметр charging.
Возвращаемый callIdentifier является Идентификатором Задачи запущенного приложения.
Запросы "прервать звонок" и "закончить звонок" отправляются в запущенное приложение как события cancelCall и endCall.
Запрос "прочитать статус" возвращает содержимое словаря "статус приложения", устанавливаемого запущенным приложением.
Запросы "добавить участника" и "удалить участника" отправляются в запущенное приложение как события addCallPeer и delCallPeer; в параметрах события содержится URI участника, указанное в запросе.
Запросы "переключить участника" отправляются в запущенное приложения как два события.
Первым отправляется событие transferTarget. Его параметры содержат Идентификатор Задачи для сессии, в которую должен быть передан участник.
Затем отправляется событие transferCallPeer. Его параметры содержит URI участника, указанного в запросе.
Приложение не завершает свою работу немедленно в случае аварийного завершения или прекращения звонка. Приложение продолжат работать ещё некоторое время (по умолчанию около 30 секунд), обрабатывая запросы "прочитать статус" для завершения звонка/сессии.
Уведомления о Звонках
Интерфейс ParlayX для Обработки Звонков позволяет клиентским приложениям задавать Сигнальные Правила для Пользователя. Эти Правила включают в себя специальные Действия Parlay, в которых реализованы команды "Направление Звонка" ("CallDirection") и "Уведомление о Звонке" (""CallNotification"") Интерфейса Parlay.
Аутентифицированные пользователи могут изменять собственные Сигнальные Правила, если у них заданы соответствующие Установки Пользователя.
Аутентифицированные Пользователи могут читать и изменять Сигнальные Правила других Пользователей, если им предоставлены права Администратора Домена.
Обратите внимание
Запросы stopCallNotification и stopCallDirectionNotification должны содержать части addresses и criteria, а значение части correlator игнорируется.
Это необходимо по причине того, что Правила задаются индивидуально для каждого Пользователя, а данные correlator не позволяют серверу направить запрос на удаление правила для нужного Пользователя.
Обратите внимание
Сообщения handleXxxxResponse могут задавать действия Подключить вместо действия Перенаправить к. Адрес, указанный в части routingAddress добавляется в набор AOR Сигнала, но активным остаётся текущий набор AOR.
Платежи
Интерфейс для Платежей ParlayX позволяет клиентскому приложению взаимодействовать с Менеджером Тарификации CommuniGate Pro.
Обратите внимание
Пользователь CommuniGate Pro может иметь несколько Остатков. Все запросы на Платежи ParlayX должны включать элемент типа xsd:string balanceType, задающий имя Остатка Пользователя.
Управление Пользователем
Интерфейс для Управления Пользователем ParlayX позволяет клиентскому приложению взаимодействовать с Менеджером Тарификации CommuniGate Pro.
Обработка Звонков
Интерфес ParlayX для Обработки Звонков позволяет клиентским приложениям:
- задавать Сигнальные Правила для Пользователя
- прочитать Сигнальные Правила, заданные для Пользователя
Аутентифицированные пользователи могут изменять собственные Сигнальные Правила, если у них заданы соответствующие Установки Пользователя.
Аутентифицированные Пользователи могут читать и изменять Сигнальные Правила других Пользователей, если им предоставлены права Администратора Домена.
Все элементы acceptList Parlay X преобразовываются в одно Сигнальное Правило.
Все элементы blockList Parlay X преобразовываются в одно Сигнальное Правило.
Элемент forward и каждый элемент forwardList Parlay X преобразовываются в три Сигнальных Правила.