Получение информации о боте

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

GET/me

Метод возвращает информацию о боте, который идентифицируется с помощью токена доступа access_token. В ответе приходит объект User с вариантом наследования BotInfo, который содержит идентификатор бота, его название, никнейм, время последней активности, описание и аватар (при наличии)

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

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

Авторизация

access_token

apiKey

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

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

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

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

Результат

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 аватара пользователя или бота в полном размере

commands

BotCommand[] Nullableoptional

до 32 элементов

Команды, поддерживаемые ботом

name

string

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

Название команды

description

string Nullableoptional

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

Описание команды

Коды ответов

Код	Описание
`200`	Информация о боте
`401`	Ошибка авторизации. Токен `access_token` указан некорректно или недействителен
`500`	Внутренняя ошибка сервера