API взаимодействия программных компонентов внутри единой CTI-платформы.

UniPhone API предназначено для объединения различных программных продуктов и телекоммуникационных платформ как участников единой CTI-платформы. Выделяются три категории участников:

• Провайдер - поставщик сведений о телекоммуникационных операциях.
• CRM - программный продукт или облачный сервис для ведения управленческого учета, регистрации продаж и т.п.
• Софтфон - программный телефон, сервис click-to-сall или другое CTI-решение на стороне пользователя.

Сервер UniPhone выступает центральным узлом платформы, который в real-time режиме маршрутизирует сообщения между участниками.

TO DO: рисунок общая схема

Обмен сообщениями выполняется в режиме real-time по средством технологии WebSocket. Сообщения оформляются по протоколу WAMP v2 (Web Application Messaging Protocol).

В UniPhone API применяются две модели взаимодействия между участниками:

• Publish & Subscribe (PubSub)
• Remote Procedure Calls (RPC)

В модели PubSub отправитель и получатель сообщений связаны друг с другом косвенно. Отправитель предоставляет информацию в абстрактной «теме» (topic), а получатели принимают сообщения объявив о своей заинтересованности к соответствующей «теме». Отправителя обычно называют издателем (publisher), а получателя - подписчиком (subscriber).

TO DO: схема PubSub

Модель RPC подразумевает получение интересующей информации по средством обращения к ее поставщику. Выполнение запроса и его обработка выполняется асинхронно. Сервер UniPhone выступает посредником при вызове удаленной процедуры и возврате результата работы.

TO DO: схема RPC

TO DO: Пример

Для работы с API потребуется одна из реализаций WAMP-клиента.

• Autobahn|Cpp - C++ 11 реализация клиента на Boost ASIO.
• Autobahn|JS - Библиотека WAMP-клиента для браузера и Node.js.
• Autobahn|Python - Библиотека WAMP-клиента и WebSocket реализация для Python 2 и 3.
• PHP, Go, C#, Lua и другие языки программирования.

TO DO: Написать про аутентификацию

Каждому участнику отведена своя роль в зависимости от его специализации. Потому от него требуется реализация только своей части API.

Структура API представлена в виде требований к участникам платформы. В подразделе PubSub указаны «темы», к которым участнику необходимо предоставить доступ по правилам WAMP-протокола. В подразделе RPC указаны процедуры, которые необходимо зарегистрировать в системе, чтобы другие участники могли их вызывать. В замен каждый участник получает доступ к «темам» и процедурам остальных участников.

UniPhone API использует URI формат для именование ресурсов включая «темы», зарегистрированные процедуры и ошибки. Все они образуют единую, глобальную иерархию имен.

Имена ресурсов формируется следующим образом: /<тип_участника>.<вид_ресурса>.<имя_ресурса>. Например, обозначение ресурса call как «темы» публикуемого на стороне провайдера выглядит так:

/provider.topics.call

Содержание API:

• UniPhone Provider API
• UniPhone CRM API
• Примеры работы с API