Получить сообщения диалога

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

Возвращает сообщения указанного диалога с просмотром по страницам.

URL

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

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

Заголовки

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

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

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

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

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

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

Параметр	Тип	Обязательный	Описание
skip	число	Нет	Количество записей, которые нужно пропустить при просмотре списка.
take	число	Нет	Количество записей, возвращаемых за один запрос.

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

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

Ответы

HTTP	Описание
200	Список сообщений с разделением на страницы.

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

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

{
  "data": [
    {
      "unique_id": "53623bcc-6b29-4b2e-b7fd-63c8eb8b6kb7",
      "dialogue_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "role": "user",
      "content": "Message content",
      "meta": {
        "key": "value"
      },
      "created_at": "2024-10-18T09:17:43.552Z"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}