31.05.2026 00:00

GetPinned

[POST] .../v1/chatmessage/getpinned

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

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

Название Тип данных Обязательность Описание
chat_id String Обязательный UUID чата
limit Int32 Необязательный Лимит элементов выборки
offset Int32 Необязательный Смещение выборки
include_staff_private Boolean Необязательный Включать приватные Staff-сообщения, если есть права

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

{
  "chat_id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
  "limit": 20,
  "offset": 0
}

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

Название Тип данных Описание
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",
      "text": "Важное сообщение",
      "pinned": true,
      "reactions": [],
      "recipient_count": 2,
      "read_count": 1,
      "created_date": 1762011120,
      "last_update": 1762011120
    }
  ],
  "next_offset": 20,
  "total": 1
}