Operator API

Operator API — REST API для интеграции операторских каналов с платформой JAICP.

При помощи Operator API вы можете подключить любой операторский канал к проекту чат-бота, который был создан на платформе JAICP. При интеграции с платформой в приложение оператора направляются данные, полученные чат-ботом в диалоге с клиентом.

предупреждение

Ваш веб-сервер должен уметь отвечать на запросы Operator API. JAICP будет отправлять запросы на ваш веб-сервер в соответствии со спецификацией Operator API.

Методы API позволяют:

• Отправить сообщение или ссылку на файл оператору.
• Выбрать группу операторов для обработки обращений.
• Передать оператору дополнительную информацию о клиенте.
• Подписаться на уведомления, посредством которых Operator API информирует о сообщениях для клиента, о доставке сообщений клиента, о закрытии сообщения оператором и других событиях.

Начало работы

1. Создайте веб-сервер. Предположим, что его URL — https://webserver.example.com. Бот JAICP будет отправлять запросы на этот веб-сервер.
2. Разработайте эндпоинты, чтобы веб-сервер мог отвечать на все запросы Operator API.
3. Создайте канал Operator API и укажите URL вашего веб-сервера в поле API URL.
4. После создания канала на https://webserver.example.com/setWebhook поступит запрос, содержащий в теле поле url. Значение этого поля — вебхук, на который вы должны отправлять события для JAICP.

подсказка

Смотрите пример использования Operator API в статье Интеграция с операторской платформой.

Запросы Operator API

Веб-сервер должен уметь отвечать на следующие запросы:

Метод	Описание
POST {apiUrl}/setWebhook	Метод устанавливает URL, на который вы должны направлять события для обработки платформой JAICP.
GET {apiUrl}/getDestinations	Получение доступных групп операторов для перенаправления событий.
POST {apiUrl}/selectDestination	Установление сессии между клиентом чат-бота и выбранной группой операторов.
POST {apiUrl}/sendText	Клиент отправил сообщение в чат с оператором.
POST {apiUrl}/sendFile	Клиент отправил файл в чат с оператором.
POST {apiUrl}/closeChat	Клиент закрыл чат с оператором.

Здесь {apiUrl} — URL вашего веб-сервера.