Получение информации о сообщениях или постах
Для корректной работы ваших чат-ботов и мини-приложений направляйте запросы на доменplatform-api2.max.ruвместоplatform-api.max.ru. Также убедитесь, что добавили сертификат Минцифры в список доверенных
GET/messages
Возвращает информацию о сообщениях из чата или постах из канала. Для выполнения запроса нужно указать один из параметров — chat_id или message_ids:
-
chat_id— метод возвращает массив сообщений или постов из указанного чата или канала, только если чат-бот в них является администратором. Сообщения возвращаются в обратном порядке: последние сообщения будут первыми в массиве. Как получить ID — на странице «Получение ID чата или канала» -
message_ids— метод возвращает информацию о запрошенных сообщениях или постах. Можно указать один идентификатор или несколько
Пример запроса с использованием chat_id:
curl -X GET "https://platform-api2.max.ru/messages?chat_id={chat_id}" \
-H "Authorization: {access_token}"
Пример запроса с использованием message_ids:
curl -X GET "https://platform-api2.max.ru/messages?message_ids={message_id1},{message_id2}" \
-H "Authorization: {access_token}"Авторизация
Передача токена через query-параметры больше не поддерживается — используйте заголовок
Authorization: <token>
Токен для вызова HTTP-запросов присваивается при создании бота — его можно найти на платформе в разделе Чат-боты. Выберите необходимого бота и нажмите ⋮ → Настройки → значок копирования справа от поля с токеном
Если вы верифицировали профиль и создали бота в мини-приложении «MAX для бизнеса», получить токен можно там же или в боте «MAX для бизнеса» с помощью команды Получить токен
Рекомендуем не разглашать токен посторонним, чтобы они не получили доступ к управлению ботом. Токен может быть отозван за нарушение Правил платформы
Параметры
message_ids. Как получить ID — на странице «Получение ID чата или канала»
chat_id
По умолчанию: 50
Максимальное количество сообщений или постов в ответе
HTTP-коды ответов
| Код | Описание |
|---|---|
200 | Информация о сообщении или массиве сообщений из чата |
401 | Ошибка авторизации. Токен access_token указан некорректно или недействителен |
403 | Это исключение возникает, когда пользователь приостановил бота или у него нет доступа к чату |
500 | Внутренняя ошибка сервера |
Подробнее о форматах ответа и кодах ошибок — на странице «Общее описание»
Результат
Отправитель сообщения: пользователь или бот
Обратите внимание:
- Все параметры в объекте относятся к отправителю сообщения
- Объект отсутствует, если сообщение отправлено в канал
true, если это бот
Получатель сообщения: пользователь или бот (для диалога), канал или чат
Обратите внимание: все параметры в объекте относятся к получателю сообщения
Возможные значения в enum: "chat" "channel" "dialog"
Тип чата:
chat— групповой чатchannel— канал или комментарий к посту (для вызовов методов группы/comments)dialog— диалог
Возможные значения в enum: "forward" "reply"
Тип связанного сообщения:
"reply"— ответ на сообщение в чате"forward"— пересланное сообщение в чате
true, если это бот
type = forward. Как получить ID — на странице «Получение ID чата или канала»
attachment, описанных в схеме ниже
Если поле пустое или равно null, изменений не произойдёт. Если массив пуст, все вложения будут удалены
expires — если он истёк, ссылку необходимо запросить повторно. Доступно в веб-клиентe и на Android
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении
Результат загрузки аудиосообщения или аудиофайла
Если пользователь отправил боту аудиосообщение, то ответах на запросы получения информации о сообщениях вернётся тип audio
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
true, если это бот
от 1 до 128 символов
Видимый текст кнопки. Чтобы он отображался полностью, рекомендуем не превышать заданное количество символов в зависимости от размещения текста: 20 символов — при одной кнопке в ряду, 10 — при двух, 5 — при трёх, 3 — при четырёх
до 1024 символов
Токен кнопки
2048 символов
true, отправляет местоположение без запроса подтверждения пользователя
Если false, возвращает модальное окно с дополнительным уточнением об отправке местоположения
до 1024 символов
Текст, который будет скопирован
от 1 символа
URL, прикреплённый к сообщению для предпросмотра медиавложения
Тип элемента разметки. Может быть жирный, курсив, ~зачеркнутый~, подчеркнутый, моноширинный, выделенный, цитата, заголовок, ссылка или упоминание пользователя
Обратите внимание: в тексте комментариев не поддерживаются гиперссылки и упоминания пользователей
от 1 до 2048 символов
URL ссылки
@username упомянутого пользователя
null, если сообщение содержит только пересланное сообщение
attachment, описанных в схеме ниже
Если поле пустое или равно null, изменений не произойдёт. Если массив пуст, все вложения будут удалены
expires — если он истёк, ссылку необходимо запросить повторно. Доступно в веб-клиентe и на Android
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении
Результат загрузки аудиосообщения или аудиофайла
Если пользователь отправил боту аудиосообщение, то ответах на запросы получения информации о сообщениях вернётся тип audio
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении
URL вложения, который возвращается в объекте Update после отправки сообщения в чат или канал
В случае с вложенным видео прямую ссылку также можно получить с помощью метода GET /videos/{-videoToken-}
true, если это бот
от 1 до 128 символов
Видимый текст кнопки. Чтобы он отображался полностью, рекомендуем не превышать заданное количество символов в зависимости от размещения текста: 20 символов — при одной кнопке в ряду, 10 — при двух, 5 — при трёх, 3 — при четырёх
до 1024 символов
Токен кнопки
2048 символов
true, отправляет местоположение без запроса подтверждения пользователя
Если false, возвращает модальное окно с дополнительным уточнением об отправке местоположения
до 1024 символов
Текст, который будет скопирован
от 1 символа
URL, прикреплённый к сообщению для предпросмотра медиавложения
Тип элемента разметки. Может быть жирный, курсив, ~зачеркнутый~, подчеркнутый, моноширинный, выделенный, цитата, заголовок, ссылка или упоминание пользователя
Обратите внимание: в тексте комментариев не поддерживаются гиперссылки и упоминания пользователей
от 1 до 2048 символов
URL ссылки
@username упомянутого пользователя