Для корректной работы ваших чат-ботов и мини-приложений направляйте запросы на домен `platform-api2.max.ru` вместо `platform-api.max.ru`. Также убедитесь, что добавили сертификат Минцифры в список доверенных Возвращает закреплённое сообщение в групповом чате или пост в канале Бот, чей токен `access_token` используется для авторизации, должен быть администратором этого чата или канала Пример запроса: curl -X GET "https://platform-api2.max.ru/chats/{chatId}/pin" \ -H "Authorization: {access_token}" ## Авторизация > Передача токена через query-параметры больше не поддерживается — используйте заголовок `Authorization: ` Токен для вызова HTTP-запросов присваивается при создании бота — его можно найти на [платформе](https://business.max.ru/self) в разделе **Чат-боты**. Выберите необходимого бота и нажмите **⋮** → **Настройки** → значок копирования справа от поля с токеном Если вы верифицировали профиль и создали бота в [мини-приложении «MAX для бизнеса»](https://max.ru/business_bot?startapp), получить токен можно там же или в [боте «MAX для бизнеса»](https://max.ru/business_bot) с помощью команды **Получить токен** Рекомендуем не разглашать токен посторонним, чтобы они не получили доступ к управлению ботом. Токен может быть отозван за нарушение Правил платформы ## Параметры ID чата ## Результат Закреплённое сообщение. Может быть `null`, если в чате нет закреплённого сообщения Отправитель сообщения: пользователь или бот **Обратите внимание**: - Все параметры в объекте относятся к отправителю сообщения - Объект отсутствует, если сообщение отправлено в канал Идентификатор пользователя или бота Отображаемое имя пользователя или бота Отображаемая фамилия пользователя. Для ботов это поле не возвращается Никнейм бота или уникальное публичное имя пользователя. В случае с пользователем может быть `null`, если тот недоступен или имя не задано `true`, если это бот Время последней активности пользователя или бота в MAX (Unix timestamp в миллисекундах). Если пользователь отключил в настройках профиля мессенджера MAX возможность видеть, что он в сети онлайн, поле может не возвращаться _Устаревшее поле, скоро будет удалено_ Получатель сообщения: пользователь или бот (для диалога), канал или чат **Обратите внимание**: все параметры в объекте относятся к получателю сообщения ID чата или канала. Как получить ID — в [разделе «Получение chat_id»](/docs-api#Получение%20chat_id) Возможные значения в enum: `"chat"` `"channel"` `"dialog"` Тип чата: - `chat` — групповой чат - `channel` — канал или комментарий к посту (для вызовов методов группы `/comments`) - `dialog` — диалог ID получателя сообщения в диалоге (пользователя или бота). Если сообщение отправлено в групповой чат или канал, то параметр отсутствует Идентификатор поста в канале, к которому оставлен комментарий Время создания сообщения в формате Unix timestamp в миллисекундах Пересланное или ответное сообщение Возможные значения в enum: `"forward"` `"reply"` Тип связанного сообщения: - `"reply"` — ответ на сообщение в чате - `"forward"` — пересланное сообщение в чате Пользователь или бот, отправивший сообщение Идентификатор пользователя или бота Отображаемое имя пользователя или бота Отображаемая фамилия пользователя. Для ботов это поле не возвращается Никнейм бота или уникальное публичное имя пользователя. В случае с пользователем может быть `null`, если тот недоступен или имя не задано `true`, если это бот Время последней активности пользователя или бота в MAX (Unix timestamp в миллисекундах). Если пользователь отключил в настройках профиля мессенджера MAX возможность видеть, что он в сети онлайн, поле может не возвращаться _Устаревшее поле, скоро будет удалено_ Чат или канал, в котором сообщение было изначально опубликовано. Только для пересланных сообщений с `type = forward`. Как получить ID — в [разделе «Получение chat_id»](/docs-api#Получение%20chat_id) Информация о сообщении Уникальный ID сообщения ID расположения сообщения в чате по порядку Текст сообщения Вложения сообщения. Могут быть одним из типов `attachment`, описанных в схеме ниже Если поле пустое или равно `null`, изменений не произойдет. Если массив пуст, все вложения будут удалены Данные, использованные для отправки изображения Уникальный ID этого изображения Токен вложения — уникальный ID загруженного медиа: изображения, аудио, видео или файла. Возвращается в ответ на вызов [POST /uploads](/docs-api/methods/POST/uploads) URL изображения. Время жизни ссылки ограниченно. Срок истечения указан в параметре `expires` — если он истёк, ссылку необходимо запросить повторно. Доступно в веб-клиентe и на Android Разметка текста сообщения. Подробнее — в разделе [Форматирование](/docs-api#Форматирование%20текста%20в%20сообщениях) Тип элемента разметки. Может быть **жирный**, *курсив*, ~зачеркнутый~, подчеркнутый, `моноширинный`, выделенный, цитата, заголовок, ссылка или упоминание пользователя **Обратите внимание**: в тексте комментариев не поддерживаются гиперссылки и упоминание пользователей Индекс начала элемента разметки в тексте. Нумерация с нуля Длина элемента разметки в символах Содержимое сообщения. Текст + вложения. Может быть `null`, если сообщение содержит только пересланное сообщение Уникальный ID сообщения ID расположения сообщения в чате по порядку Текст сообщения Вложения сообщения. Могут быть одним из типов `attachment`, описанных в схеме ниже Если поле пустое или равно `null`, изменений не произойдет. Если массив пуст, все вложения будут удалены Данные, использованные для отправки изображения Уникальный ID этого изображения Токен вложения — уникальный ID загруженного медиа: изображения, аудио, видео или файла. Возвращается в ответ на вызов [POST /uploads](/docs-api/methods/POST/uploads) URL изображения. Время жизни ссылки ограниченно. Срок истечения указан в параметре `expires` — если он истёк, ссылку необходимо запросить повторно. Доступно в веб-клиентe и на Android Разметка текста сообщения. Подробнее — в разделе [Форматирование](/docs-api#Форматирование%20текста%20в%20сообщениях) Тип элемента разметки. Может быть **жирный**, *курсив*, ~зачеркнутый~, подчеркнутый, `моноширинный`, выделенный, цитата, заголовок, ссылка или упоминание пользователя **Обратите внимание**: в тексте комментариев не поддерживаются гиперссылки и упоминание пользователей Индекс начала элемента разметки в тексте. Нумерация с нуля Длина элемента разметки в символах Статистика просмотров постов и репостов — возвращается только для каналов Количество пользователей, которые увидели пост или репост в канале. Просмотр засчитывается, когда пост или репост попадает в область видимости экрана Если это репост, то будет показано количество именно его просмотров Публичная ссылка на пост в канале. Отсутствует для диалогов и групповых чатов ## Коды ответов | Код | Описание | | --- | --- | | `200` | Закреплённое сообщение | | `401` | Ошибка авторизации. Токен `access_token` указан некорректно или недействителен | | `403` | Ошибка доступа. У вас нет прав на доступ к этому ресурсу | | `404` | Запрашиваемый ресурс не найден | | `500` | Внутренняя ошибка сервера |