11.06.2026 00:00

GetAround

[POST] .../v1/chatmessage/getaround

Возвращает окно сообщений вокруг выбранного сообщения в чате. Метод удобно использовать для перехода к закрепленному сообщению или результату поиска: клиент получает само целевое сообщение и ближайший контекст до и после него.

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

Название Тип данных Обязательность Описание
chat_id String Обязательный UUID чата
id String Обязательный UUID целевого сообщения
limit_before Int32 Необязательный Количество сообщений до целевого сообщения
limit_after Int32 Необязательный Количество сообщений после целевого сообщения
include_staff_private Boolean Необязательный Включать приватные Staff-сообщения, если есть права

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

  • chat_id и id обязательны и должны быть корректными UUID.
  • Целевое сообщение должно принадлежать указанному чату и быть доступно пользователю.
  • Метод возвращает только неудаленные сообщения.
  • Параметры limit_before и limit_after ограничиваются серверными настройками.
  • Отрицательные значения limit_before и limit_after приводятся к 0.
  • Поле include_staff_private = true учитывается только для пользователей, которым разрешен просмотр Staff-сообщений.
  • Сообщения возвращаются в хронологическом порядке: от старых к новым.
  • Состав объекта сообщения совпадает с ChatMessage/Get.

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

{
  "chat_id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
  "id": "9beec41f-6ef5-4e87-b4ea-05895cff2c54",
  "limit_before": 20,
  "limit_after": 20,
  "include_staff_private": false
}

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

Название Тип данных Описание
result Array of ChatMessage Сообщения вокруг выбранного сообщения

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

{
  "ok": true,
  "result": [
    {
      "id": "3b8fd84b-7f18-4d1d-82ea-bbc53b5f2d80",
      "chat_id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
      "author_entity_type": "User",
      "author_entity_id": 15,
      "message_type": "Regular",
      "text": "Сообщение перед закрепленным",
      "pinned": false,
      "reactions": [],
      "recipient_count": 3,
      "read_count": 1,
      "created_date": 1762011060,
      "last_update": 1762011060
    },
    {
      "id": "9beec41f-6ef5-4e87-b4ea-05895cff2c54",
      "chat_id": "6f6fdb2f-7d0b-4c34-b6fd-1fbcf40d37ef",
      "author_entity_type": "User",
      "author_entity_id": 15,
      "message_type": "Regular",
      "text": "Закрепленное сообщение",
      "pinned": true,
      "reactions": [],
      "recipient_count": 3,
      "read_count": 1,
      "created_date": 1762011120,
      "last_update": 1762011120
    }
  ]
}