25.03.2026 15:10

Get

[POST] .../v1/chatmessage/get

Возвращает сообщения выбранного чата с фильтрацией по датам и пагинацией.

Входные параметры

Название Тип данных Обязательность Описание
chat_id String Обязательный UUID чата
ids Array of String Необязательный Массив UUID сообщений
from_date Int64 Необязательный Нижняя граница даты создания (Unix time, сек.)
to_date Int64 Необязательный Верхняя граница даты создания (Unix time, сек.)
limit Int32 Необязательный Лимит элементов выборки
offset Int32 Необязательный Смещение выборки
include_staff_private Boolean Необязательный Включать Staff-ограниченные сообщения (если есть права): Private и System с action_code = StaffNoticeAdded

Ограничения и проверки

  • chat_id обязателен и должен быть корректным UUID чата.
  • Метод доступен только пользователю, у которого есть доступ к чату.
  • Для обычных чатов проверяется право chat_message_select (684).
  • Для чатов, связанных с Lead/Deal/Ticket/Task, доступ наследуется от сущности: Select у сущности заменяет chat_message_select.
  • Для entity-чатов право Edit у сущности дает полный доступ к сообщениям (включая staff/private).
  • Параметр limit ограничивается серверным максимумом; при превышении применяется допустимый предел.
  • Отрицательное значение offset автоматически приводится к 0.
  • Поле include_staff_private = true учитывается только для пользователей, которым разрешен просмотр Staff-ограниченных сообщений.
  • В выдачу попадают только не удаленные сообщения.
  • Для пользователя с правом chat_manage_all (688) доступно чтение без участия в чате; в этом режиме read-история не создается.

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

{
  "chat_id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
  "from_date": 1762000000,
  "to_date": 1762100000,
  "limit": 50,
  "offset": 0,
  "include_staff_private": false
}

Выходные параметры

Название Тип данных Описание
result Array of ChatMessage Массив сообщений чата
next_offset Int32 Смещение для следующей страницы
total Int64 Общее количество элементов

Пример ответа

{
  "ok": true,
  "result": [
    {
      "id": "9beec41f-6ef5-4e87-b4ea-05895cff2c54",
      "chat_id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
      "author_entity_type": "User",
      "author_entity_id": 15,
      "author_role": "Member",
      "message_type": "Regular",
      "text": "Добрый день",
      "file_ids": [101],
      "action_code": null,
      "action_payload": null,
      "event_id": "evt-01",
      "external_message_id": "msg-15001",
      "edited": false,
      "read": false,
      "created_date": 1762011120,
      "last_update": 1762011120
    }
  ],
  "next_offset": 50,
  "total": 1
}