Prompter API

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

Перед началом работы с Prompter API подключите к проекту канал Prompter API.

подсказка

Подробнее о методе, параметрах запроса и формате ответов см. в спецификации Prompter API.

Токен для доступа к API

Токен конфигурируется при создании канала и необходим для отправки запросов Prompter API.

Чтобы получить токен, перейдите в окно редактирования созданного канала Prompter API:

1. Нажмите на панели управления Каналы.
2. Нажмите  в строке канала Prompter API, затем Редактировать.
3. Скопируйте токен.

Метод API

Отправка оператору ответов на запрос

Метод POST /chatapi/webhook/prompter_api/{token} позволяет отправлять оператору наиболее подходящие варианты ответов на вопросы клиентов.

Параметр пути:

• token — токен канала Prompter API.

Параметры тела запроса:

• clientInfo — объект с информацией о клиенте.
  • id — идентификатор клиента.
  • firstName и lastName — имя и фамилия клиента. Необязательные параметры.
• chatId — идентификатор сессии. Задается на стороне сервиса.
• text — вопрос клиента.

После отправки запроса на вебхук придет JSON-объект:

{
    "clientInfo": {
        "id": "testClientId"
    },
    "chatId": "testChatId",
    "questionId": "questionId",
    "answerOptions": [ // Наиболее подходящие варианты ответов. Варианты берутся из интентов, у которых значение выше порога классификатора.
        {
            "messages": [
                {
                    "type": "TEXT", // Другие типы ответов см. в спецификации.
                    "text": "Ответ на вопрос клиента",
                    "markup": "plain" // Тип разметки текста: plain, html или markdown.
                }
            ],
            "intent": {
                "id": 1234, // Идентификатор интента, в котором найден ответ на вопрос клиента.
                "confidence": 1.0, // Значение уверенности классификатора в том, что ответ правильный.
                "name": "Название интента",
                "path": "/Путь к интенту"
            }
        }
    ]
}