Изменение информации о групповом чате или канале

Для корректной работы ваших чат-ботов и мини-приложений направляйте запросы на домен platform-api2.max.ru вместо platform-api.max.ru. Также убедитесь, что добавили сертификат Минцифры в список доверенных

PATCH/chats/{chatId}

Позволяет редактировать информацию о групповом чате или канале, включая название, описание, иконку и закреплённое сообщение или пост

Бот, чей токен access_token используется для авторизации, должен быть администратором этого чата или канала

Пример запроса:

curl -X PATCH "https://platform-api2.max.ru/chats/{chatId}" \
  -H "Authorization: {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
  "icon": { "url": "https://example.com/image.jpg" },
  "title": "Название чата",
  "notify": true
}'

Авторизация

access_token

apiKey

Передача токена через query-параметры больше не поддерживается — используйте заголовок Authorization: <token>

Токен для вызова HTTP-запросов присваивается при создании бота — его можно найти на платформе в разделе Чат-боты. Выберите необходимого бота и нажмите ⋮ → Настройки → значок копирования справа от поля с токеном

Если вы верифицировали профиль и создали бота в мини-приложении «MAX для бизнеса», получить токен можно там же или в боте «MAX для бизнеса» с помощью команды Получить токен

Рекомендуем не разглашать токен посторонним, чтобы они не получили доступ к управлению ботом. Токен может быть отозван за нарушение Правил платформы

Параметры

chatId

integer <int64>\-?\d+

ID чата или канала

Тело запроса

icon

object PhotoAttachmentRequestPayload Nullableoptional

Данные для прикрепления изображения в качестве аватара чата или канала

url

string Nullableoptional

от 1 символа

Любой внешний URL изображения, которое вы хотите прикрепить

token

string Nullableoptional

Токен существующего вложения

photos

object Nullableoptional

Токены, полученные после загрузки изображений

title

string Nullableoptional

от 1 до 200 символов

description

string Nullableoptional

от 0 до 16000 символов

Новое описание чата или канала. Чтобы удалить описание, передайте пустую строку

string Nullableoptional

ID сообщения для закрепления в чате или канале. Чтобы удалить закреплённое сообщение, используйте метод DELETE /chats/{chatId}/pin

notify

boolean Nullableoptional

По умолчанию: true

Если true, участники получат системное уведомление об изменении

Результат

chat_id

integer <int64>

ID чата или канала — в зависимости от ограничений метода и от того, с чем вы работаете. Как получить ID — в разделе «Получение chat_id»

type

enum ChatType

Возможные значения в enum: "chat" "channel" "dialog"

Тип чата:

"chat" — Групповой чат
"channel" — Канал
"dialog" — Диалог

status

enum ChatStatus

Возможные значения в enum: "active" "removed" "left" "closed"

Статус чата:

"active" — Бот является активным участником чата
"removed" — Бот был удалён из чата
"left" — Бот покинул чат
"closed" — Чат был закрыт

title

string Nullable

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

icon

object Image Nullable

Аватар группового чата или канала

url

string

URL изображения

last_event_time

integer <int64>

Время последнего события в чате или канале в формате Unix timestamp в миллисекундах

participants_count

integer <int32>

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

owner_id

integer <int64> Nullableoptional

ID владельца чата или канала

participants

object Nullableoptional

Список участников в формате ключ-значение, где ключ — идентификатор участника user_id, а значение — время его последней активности в чате или канале last_event_time. Может быть null, если запрашивается список чатов

is_public

boolean

Параметр показывает, доступен ли групповой чат или канал публично. Для диалогов и приватных каналов — всегда false

link

string Nullableoptional

Ссылка на чат

description

string Nullable

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

dialog_with_user

object UserWithPhoto Nullableoptional

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

user_id

integer <int64>

Идентификатор пользователя или бота

first_name

string

Отображаемое имя пользователя или бота

last_name

string Nullableoptional

Отображаемая фамилия пользователя. Для ботов это поле не возвращается

username

string Nullable

Никнейм бота или уникальное публичное имя пользователя. В случае с пользователем может быть null, если тот недоступен или имя не задано

is_bot

boolean

true, если это бот

last_activity_time

integer <int64>

Время последней активности пользователя или бота в MAX (Unix timestamp в миллисекундах). Если пользователь отключил в настройках профиля мессенджера MAX возможность видеть, что он в сети онлайн, поле может не возвращаться

name

string Nullable

Устаревшее поле, скоро будет удалено

description

string Nullableoptional

до 16000 символов

Описание пользователя или бота. В случае с пользователем может принимать значение null, если описание не заполнено

avatar_url

stringoptional

URL аватара пользователя или бота в уменьшенном размере

full_avatar_url

stringoptional

URL аватара пользователя или бота в полном размере

messages_count

integer Nullableoptional

Количество сообщений в групповом чате или постов канале

pinned_message

object Message Nullableoptional

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

sender

object Useroptional

Отправитель сообщения: пользователь или бот

Обратите внимание:

Все параметры в объекте относятся к отправителю сообщения
Объект отсутствует, если сообщение отправлено в канал

user_id

integer <int64>

Идентификатор пользователя или бота

first_name

string

Отображаемое имя пользователя или бота

last_name

string Nullableoptional

Отображаемая фамилия пользователя. Для ботов это поле не возвращается

username

string Nullable

is_bot

boolean

true, если это бот

last_activity_time

integer <int64>

name

string Nullable

Устаревшее поле, скоро будет удалено

recipient

object Recipient

Получатель сообщения: пользователь или бот (для диалога), канал или чат

Обратите внимание: все параметры в объекте относятся к получателю сообщения

chat_id

integer <int64> Nullable

ID чата или канала. Как получить ID — в разделе «Получение chat_id»

chat_type

enum ChatType

Возможные значения в enum: "chat" "channel" "dialog"

Тип чата:

chat — групповой чат
channel — канал или комментарий к посту (для вызовов методов группы /comments)
dialog — диалог

user_id

integer <int64> Nullable

ID получателя сообщения в диалоге (пользователя или бота). Если сообщение отправлено в групповой чат или канал, то параметр отсутствует

post_id

string Nullable

Идентификатор поста в канале, к которому оставлен комментарий

timestamp

integer <int64>

Время создания сообщения в формате Unix timestamp в миллисекундах

link

object LinkedMessage Nullableoptional

Пересланное или ответное сообщение

type

enum MessageLinkType

Возможные значения в enum: "forward" "reply"

Тип связанного сообщения:

"reply" — ответ на сообщение в чате
"forward" — пересланное сообщение в чате

sender

object Useroptional

Пользователь или бот, отправивший сообщение

user_id

integer <int64>

Идентификатор пользователя или бота

first_name

string

Отображаемое имя пользователя или бота

last_name

string Nullableoptional

Отображаемая фамилия пользователя. Для ботов это поле не возвращается

username

string Nullable

is_bot

boolean

true, если это бот

last_activity_time

integer <int64>

name

string Nullable

Устаревшее поле, скоро будет удалено

chat_id

integer <int64>optional

Чат или канал, в котором сообщение было изначально опубликовано. Только для пересланных сообщений с type = forward. Как получить ID — в разделе «Получение chat_id»

message

object MessageBody

Информация о сообщении

mid

string

Уникальный ID сообщения

seq

integer <int64>

ID расположения сообщения в чате по порядку

text

string Nullable

Текст сообщения

attachments

Attachment[] Nullable

Вложения сообщения. Могут быть одним из типов attachment, описанных в схеме ниже Если поле пустое или равно null, изменений не произойдет. Если массив пуст, все вложения будут удалены

type

string

payload

object PhotoAttachmentPayload

Данные, использованные для отправки изображения

photo_id

integer <int64>

Уникальный ID этого изображения

token

string

Токен вложения — уникальный ID загруженного медиа: изображения, аудио, видео или файла. Возвращается в ответ на вызов POST /uploads

url

string

URL изображения. Время жизни ссылки ограниченно. Срок истечения указан в параметре expires — если он истёк, ссылку необходимо запросить повторно. Доступно в веб-клиентe и на Android

markup

MarkupElement[] Nullableoptional

Разметка текста сообщения. Подробнее — в разделе Форматирование

type

string

Тип элемента разметки. Может быть жирный, курсив, ~зачеркнутый~, подчеркнутый, моноширинный, выделенный, цитата, заголовок, ссылка или упоминание пользователя

Обратите внимание: в тексте комментариев не поддерживаются гиперссылки и упоминание пользователей

from

integer <int32>

Индекс начала элемента разметки в тексте. Нумерация с нуля

length

integer <int32>

Длина элемента разметки в символах

body

object MessageBody

Содержимое сообщения. Текст + вложения. Может быть null, если сообщение содержит только пересланное сообщение

mid

string

Уникальный ID сообщения

seq

integer <int64>

ID расположения сообщения в чате по порядку

text

string Nullable

Текст сообщения

attachments

Attachment[] Nullable

type

string

payload

object PhotoAttachmentPayload

Данные, использованные для отправки изображения

photo_id

integer <int64>

Уникальный ID этого изображения

token

string

url

string

markup

MarkupElement[] Nullableoptional

Разметка текста сообщения. Подробнее — в разделе Форматирование

type

string

Обратите внимание: в тексте комментариев не поддерживаются гиперссылки и упоминание пользователей

from

integer <int32>

Индекс начала элемента разметки в тексте. Нумерация с нуля

length

integer <int32>

Длина элемента разметки в символах

stat

object MessageStat Nullableoptional

Статистика просмотров постов и репостов — возвращается только для каналов

views

integer

Количество пользователей, которые увидели пост или репост в канале. Просмотр засчитывается, когда пост или репост попадает в область видимости экрана Если это репост, то будет показано количество именно его просмотров

url

string Nullableoptional

Публичная ссылка на пост в канале. Отсутствует для диалогов и групповых чатов

Коды ответов

Код	Описание
`200`	Возвращается обновлённый объект чата или канала
`401`	Ошибка авторизации. Токен `access_token` указан некорректно или недействителен
`403`	Ошибка доступа. У вас нет прав на доступ к этому ресурсу
`500`	Внутренняя ошибка сервера