Создать ответ первой линии

POST /api/v1/first-lines

Создаёт готовый ответ первой линии для указанного бота и текущего пользователя.

URL

https://app.helpfy.ai/api/v1/first-lines

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Для JSON-тела передайте Content-Type: application/json.

Подробнее — авторизация API.

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

Тело запроса (application/json)

Поле	Тип	Обязательно	Описание
bot_unique_id	строка	Да	Уникальный идентификатор бота.
main_question	строка	Да	Основная формулировка вопроса первой линии.
similar_questions	строка	Нет	Другие формулировки вопроса. Разделяйте их переносами строк.
answer	строка	Да	Готовый ответ на вопрос.
action	ANSWER, OPERATOR	Да	Действие, которое нужно выполнить. (по умолчанию: "ANSWER")
status	ACTIVE, INACTIVE	Да	Статус обработки. (по умолчанию: "ACTIVE")

Пример запроса

curl --request POST 'https://app.helpfy.ai/api/v1/first-lines' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "11111111-1111-4111-8111-111111111111",
  "main_question": "example",
  "answer": "Мы команда по разработке",
  "action": "ANSWER",
  "status": "INACTIVE"
}
JSON

Ответы

HTTP	Описание
201	Успешный ответ

Пример ответа — HTTP 201

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "main_question": "Расскажите про вашу компанию?",
  "similar_questions": "Кто вы?\nКак называется ваша компания?\nРасскажите про вас",
  "answer": "Мы команда по разработке",
  "action": "OPERATOR",
  "status": "INACTIVE",
  "created_at": "2024-10-18T14:13:46.180Z",
  "updated_at": "2024-10-18T14:13:46.180Z"
}