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

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

Параметры

Поле
Описание

chatId integer <int64> \-?\d+

Идентификатор запрашиваемого чата

Результат

Поле
Описание

chat_id integer <int64>

Идентификатор чата

type enum ChatType

Enum: "dialog" "chat" "channel"

Тип чата:

  • "dialog" — Диалог.

  • "chat" — Групповой чат.

  • "channel" — Канал.

status enum ChatStatus

Enum: "active" "removed" "left" "closed" "suspended"

Статус чата:

  • "active" — Бот является активным участником чата.

  • "removed" — Бот был удалён из чата.

  • "left" — Бот покинул чат.

  • "closed" — Чат был закрыт.

  • "suspended" — Бот был остановлен пользователем. Только для диалогов.

title string Nullable

Отображаемое название чата. Может быть null для диалогов

icon object Image Nullable

Иконка чата

last_event_time integer <int64>

Время последнего события в чате

participants_count integer <int32>

Количество участников чата. Для диалогов всегда 2

owner_id? integer <int64> Nullable

Идентификатор владельца чата (виден только администраторам чата)

participants? object Nullable

Участники чата с временем последней активности. Может быть null, если запрашивается список чатов (видно только администраторам)

is_public boolean

Доступен ли чат публично (для диалогов всегда false)

link? string Nullable

Ссылка на чат

description string Nullable

Описание чата

dialog_with_user object UserWithPhoto Nullable

Данные о пользователе в диалоге (только для чатов типа "dialog")

messages_count? integer Nullable

Количество сообщений в чате (доступно только для групповых чатов и каналов, недоступно для диалогов)

chat_message_id? string Nullable

Идентификатор сообщения, содержащего кнопку, через которую был инициирован чат

pinned_message object Message Nullable

Закреплённое сообщение в чате или канале (возвращается только при запросе конкретного чата)

Пример чата

const MaxBot = require("./src/core/MaxBot");

// Создаём экземпляр клиента с токеном
const client = new MaxBot({
    token: "test",
});

async function getChatById() {
    const chat = await client.chats.getChatById(-1);

    console.log(chat);
}

getChatById();

Результат

{
  chat_id: -1,
  type: 'chat',
  status: 'active',
  title: 'Тест чат',
  last_event_time: 1743171491607,
  participants_count: 2,
  is_public: false,
  owner_id: 1,
  participants: { '1': 1743156320438, '2': 1743102390132 },
  link: 'https://max.ru/join/xFxUgyQSQHuCY0MDVVyZK8jBgTDNL0gtdBszRMwrQmU',
  messages_count: 24
}

Last updated