Operator API
При помощи Operator API вы можете подключить любой операторский канал к проекту чат-бота, который был создан на платформе JAICP. При интеграции с платформой в приложение оператора направляются данные, полученные чат-ботом в диалоге с клиентом.
Методы API позволяют:
- Отправить сообщение или ссылку на файл оператору.
- Выбрать группу операторов для обработки обращений.
- Передать оператору дополнительную информацию о клиенте.
- Подписаться на уведомления, посредством которых 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, на который будут направляться запросы Operator API.На {apiUrl}/setWebhook поступит запрос, содержащий в теле поле url. Значение этого поля — вебхук, на который необходимо направлять события в платформу JAICP согласно спецификации.
Подключение канала
Авторизуйтесь на платформе JAICP, перейдите в проект. Нажмите на панели управления Каналы > Операторы > Подключить канал. Выберите канал для подключения Operator API.
Заполните поля:
- Название — укажите название канала.
- API URL — URL, на который будут направляться запросы Operator API.
Нажмите Создать.
Выберите уже созданный входящий канал, перейдите в окно редактирования. В поле Оператор выберите операторский канал из списка > нажмите Сохранить.