Prompter API

Суфлер — помощник, который анализирует вопросы клиентов и подсказывает операторам наиболее подходящие варианты ответов. Он не общается с клиентом напрямую, а помогает оператору быстрее реагировать на запросы.

Prompter API позволяет:

Подключить суфлеров в Aimychat для автоматической поддержки операторов.
Интегрировать суфлеров в сторонние сервисы через API.

Как работает интеграция

Когда пользователь отправляет вопрос в операторскую платформу, система передает этот запрос через вебхук Prompter API в Agent Platform. Процесс в Agent Platform анализирует вопрос, формирует подходящие варианты ответов и возвращает их обратно в операторскую платформу. Оператор получает готовые варианты ответов и может выбрать наиболее подходящий для отправки пользователю.

Подключение Prompter API

Добавить новый канал в проекте можно несколькими способами:

В проекте перейдите в раздел Интеграции, выберите Подключить → Канал → Prompter API.
На холсте выберите Сообщение → Подключить канал → Prompter API.

Задайте название. Оно будет отображаться в списке интеграций.
Выберите способ публикации изменений:
- Автоматически — изменения публикуются, если вы нажали Опубликовать на холсте.
- Вручную — чтобы опубликовать изменения:
  1. В конструкторе нажмите на триггер Сообщение.
  2. Нажмите Опубликовать у нужного канала.
Нажмите Подключить.

После создания канала получить токен и адрес вебхука можно двумя способами:

Нажмите → Редактировать у канала на вкладке Интеграции.
Нажмите Получить вебхук в триггере Сообщение на холсте. Токен — это часть URL вебхука после https://bot.jaicp.com/chatapi/webhook/prompter_api/

Интеграция в сторонние сервисы

Вы можете подключить любой сторонний сервис. Он должен использовать метод POST /chatapi/webhook/prompter_api/{token}. Этот метод отправляет в Agent Platform вопрос клиента и получает подходящие варианты ответа.

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

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

token — токен канала Prompter API, который можно получить после подключения канала.

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

clientInfo — объект с информацией о клиенте.
- id — уникальный идентификатор клиента в вашей системе.
- firstName и lastName — имя и фамилия клиента (необязательные параметры).
chatId — уникальный идентификатор диалога в вашей системе.
text — текст вопроса клиента.

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

В ответ на запрос платформа возвращает JSON-объект с вариантами ответов:

{
    "clientInfo": {
        "id": "testClientId"
    },
    "chatId": "testChatId",
    "questionId": "questionId",
    "answerOptions": [
        {
            "messages": [
                {
                    "type": "TEXT",
                    "text": "Ответ на вопрос клиента",
                    "markup": "plain"
                }
            ]
        }
    ]
}

подсказка

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

Aimychat

Для подключения суфлера в Aimychat можно воспользоваться вебхуком:

Перейдите в раздел Настройки → вкладка Суфлеры.
Добавьте нового суфлера и укажите адрес вебхука Prompter API.
На вкладке Группы выберите нужную группу или создайте новую. В окне редактирования группы перейдите на вкладку Суфлеры, выберите ваш суфлер и нажмите Добавить.

Вебхук представляет собой эндпоинт на стороне Agent Platform, который принимает POST-запросы от Aimychat с вопросами клиентов.

Как работает интеграция​

Подключение Prompter API​

Интеграция в сторонние сервисы​

Параметры запроса​

Ответ на запрос​

Aimychat​