Получить список диалогов

GET /api/v1/bots/{botUniqueId}/dialogues

Возвращает диалоги с возможностью поиска по названию и просмотра по страницам.

URL

https://app.helpfy.ai/api/v1/bots/{botUniqueId}/dialogues

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

Заголовки

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

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

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

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

Параметр	Тип	Обязательный	Описание
botUniqueId	строка	Да	Уникальный идентификатор бота.

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

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

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

curl --request GET 'https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/dialogues' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'search=My new dialogue' \
  --data-urlencode 'skip=0'

Ответы

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

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

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

{
  "data": [
    {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "dialogue_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "name": "My new dialogue",
      "message_limit": 20,
      "operator_limit": 25,
      "successful_messages": 5,
      "clarification_attempted": false,
      "is_active": true,
      "created_at": "2024-10-18T09:17:43.552Z",
      "updated_at": "2024-10-18T09:17:43.552Z"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}