Получение сообщений ветки

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

GET /chat.getThreadMessages

Описание

Возвращает все сообщения из указанной ветки (thread).

Параметры

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

Название	Обязательный	Тип данных	Описание
tmid	да	string	Идентификатор ветки (thread message id)
offset	нет	number	Смещение для пагинации
count	нет	number	Количество результатов на страницу
sort	нет	string	Поле для сортировки
fields	нет	string	JSON-строка с полями для включения
query	нет	string	JSON-строка с условиями фильтрации

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/chat.getThreadMessages?tmid=<THREAD_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> — токен аутентификации пользователя;
• <THREAD_ID> — идентификатор ветки.

Ответ

200 — Successfully get thread messages — Сообщения ветки. Пример вывода:

{
  "success": true,
  "count": 3,
  "offset": 0,
  "total": 3,
  "messages": [
    {
      "_id": "msg_123456",
      "rid": "GENERAL",
      "msg": "Thread reply",
      "tmid": "thread_123456",
      "ts": "2026-06-24T10:05:00.000Z"
    }
  ]
}