Получение избранных сообщений

Метод и конечная точка

GET /chat.getStarredMessages

Описание

Возвращает список сообщений, добавленных в избранное в указанной комнате. Поддерживает пагинацию и сортировку.

Параметры

Перечень параметров представлен в таблице.

Название	Обязательный	Тип данных	Описание
roomId	да	string	Идентификатор комнаты
offset	нет	number	Смещение для пагинации
count	нет	number	Количество результатов на страницу
sort	нет	string	Поле для сортировки

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.getStarredMessages?roomId=<ROOM_ID>&offset=0&count=20' \
  -H 'accept: application/json' \
  -H 'X-User-Id: <USER_ID>' \
  -H 'x-auth-token: <AUTH_TOKEN>'

Где:

• <ENV> — окружение, на котором выполняется запрос;
• <DEFAULT_DOMAIN> — домен сервера Squadus;
• <USER_ID> — идентификатор пользователя, от имени которого выполняется запрос;
• <AUTH_TOKEN> — токен аутентификации пользователя;
• <ROOM_ID> — идентификатор комнаты.

Ответ

200 — Successfully get starred messages — Избранные сообщения. Пример вывода:

{
  "success": true,
  "count": 3,
  "offset": 0,
  "total": 3,
  "messages": [
    {
      "_id": "msg_123456",
      "rid": "GENERAL",
      "msg": "Important note",
      "starred": true,
      "ts": "2026-06-24T10:00:00.000Z"
    }
  ]
}