Получить список ответов первой линии

GET /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

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

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

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

Параметр	Тип	Обязательный	Описание
bot_unique_id	строка	Нет	Показывать записи только указанного бота.
search	строка	Нет	Поиск по тексту вопроса или ответа.
status	строка	Нет	Отбирать записи по статусу.
skip	число	Нет	Количество пропускаемых записей при просмотре списка. По умолчанию 0.
take	число	Нет	Количество возвращаемых записей. По умолчанию 10.

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

curl --request GET 'https://app.helpfy.ai/api/v1/first-lines' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'bot_unique_id=804be633-6f3b-4d38-abf3-8b2709e141fb' \
  --data-urlencode 'search=help with login'

Ответы

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

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

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

{
  "data": [
    {
      "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"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}