Файлы канала

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

GET /channels.files

Описание

Возвращает список файлов, загруженных в публичный канал.

Параметры

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

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

* Должен быть указан один из параметров: roomId или roomName.

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/channels.files?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 channel files — Список файлов. Пример вывода:

{
  "success": true,
  "count": 5,
  "offset": 0,
  "total": 5,
  "files": [
    {
      "_id": "file123",
      "name": "document.pdf",
      "size": 1024000,
      "type": "application/pdf",
      "userId": "7w9BMr9r78W4RNe8x",
      "uploadedAt": "2026-06-24T10:00:00.000Z",
      "url": "/file-upload/file123/document.pdf"
    }
  ]
}