Получение информации о канале

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

GET /channels.info

Описание

Возвращает информацию о публичном канале.

Параметры

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

Название	Обязательный	Тип данных	Описание
roomId	нет*	string	Идентификатор канала
roomName	нет*	string	Название канала

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

Запрос

curl -X 'GET' \
  'https://im-<ENV>.<DEFAULT_DOMAIN>/api/v1/channels.info?roomId=<ROOM_ID>' \
  -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 info — Информация о канале. Пример вывода:

{
  "success": true,
  "channel": {
    "_id": "GENERAL",
    "name": "general",
    "fname": "general",
    "t": "c",
    "msgs": 150,
    "usersCount": 25,
    "u": {
      "_id": "7w9BMr9r78W4RNe8x",
      "username": "john.doe"
    },
    "ts": "2026-06-24T10:00:00.000Z",
    "ro": false,
    "default": true,
    "description": "General channel for all users",
    "_updatedAt": "2026-06-24T10:00:00.000Z"
  }
}