Получение закреплённого сообщения в групповом чате или канале

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

GET/chats/{chatId}/pin

Возвращает закреплённое сообщение в групповом чате или пост в канале

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

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

curl -X GET "https://platform-api2.max.ru/chats/{chatId}/pin" \
  -H "Authorization: {access_token}"

Авторизация

access_token

apiKey

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

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

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

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

Параметры

chatId

integer <int64>\-?\d+

ID чата

Результат

message

object Message Nullableoptional

Закреплённое сообщение. Может быть null, если в чате нет закреплённого сообщения

sender

object Useroptional

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

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

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

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

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

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`	Ошибка доступа. У вас нет прав на доступ к этому ресурсу
`404`	Запрашиваемый ресурс не найден
`500`	Внутренняя ошибка сервера