Изменение информации о чате
Позволяет редактировать информацию о чате, включая название, иконку и закреплённое сообщение.
Параметры
chatId
integer <int64>
\-?\d+
Идентификатор чата
icon
?
object PhotoAttachmentRequestPayload Nullable
Запрос на прикрепление изображения (все поля являются взаимоисключающими)
title
?
string Nullable
от 1
до 200
символов
pin
?
string Nullable
Идентификатор сообщения для закрепления в чате. Чтобы удалить закреплённое сообщение, используйте метод unpin
notify
?
boolean Nullable
По умолчанию: true
Если true
, участники получат системное уведомление об изменении
Результат
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 updateChatInfo() {
const params = {
title: "Chat for test",
};
const chat = await client.chats.updateChatInfo({ chatId: -1, params });
console.log(chat);
}
updateChatInfo();
Результат
{
chat_id: -1,
type: 'chat',
status: 'active',
title: 'Chat for test',
last_event_time: 1743171491607,
participants_count: 2,
is_public: false,
owner_id: 1,
link: 'https://max.ru/join/xxx',
messages_count: 24
}
Last updated