Получение информации о членстве бота в групповом чате или канале
Для корректной работы ваших чат-ботов и мини-приложений направляйте запросы на домен platform-api2.max.ru вместо platform-api.max.ru. Также убедитесь, что добавили сертификат Минцифры в список доверенных
GET/chats/{chatId}/members/me
Возвращает информацию о членстве бота в групповом чате или канале, общую информацию о нём, а также список доступных прав доступа. Бот идентифицируется с помощью токена доступа
Пример запроса:
curl -X GET "https://platform-api2.max.ru/chats/{chatId}/members/me" \
-H "Authorization: {access_token}"
Авторизация
access_tokenapiKey
Передача токена через query-параметры больше не поддерживается — используйте заголовок
Authorization: <access_token>
Токен для вызова HTTP-запросов присваивается при создании бота — его можно найти на платформе в разделе Чат-боты. Выберите необходимого бота и нажмите ⋮ → Настройки → значок копирования справа от поля с токеном
Eсли вы верифицировали профиль и создали бота в мини-приложении «MAX для бизнеса», получить токен можно там же или в боте «MAX для бизнеса» с помощью команды Получить токен
Рекомендуем не разглашать токен посторонним, чтобы они не получили доступ к управлению ботом. Токен может быть отозван за нарушение Правил платформы
Параметры
chatIdinteger <int64>
\-?\d+
ID группового чата или канала
Результат
user_idinteger <int64>
Идентификатор пользователя или бота
first_namestring
Отображаемое имя пользователя или бота
last_namestring Nullable optional
Отображаемая фамилия пользователя. Для ботов это поле не возвращается
usernamestring Nullable
Никнейм бота или уникальное публичное имя пользователя. В случае с пользователем может быть null, если тот недоступен или имя не задано
is_botboolean
true, если это бот
last_activity_timeinteger <int64>
Время последней активности пользователя или бота в MAX (Unix timestamp в миллисекундах). Если пользователь отключил в настройках профиля мессенджера MAX возможность видеть, что он в сети онлайн, поле может не возвращаться
namestring Nullable
Устаревшее поле, скоро будет удалено
descriptionstring Nullable optional
до 16000 символов
Описание пользователя или бота. В случае с пользователем может принимать значение null, если описание не заполнено
avatar_urlstring optional
URL аватара пользователя или бота в уменьшенном размере
full_avatar_urlstring optional
URL аватара пользователя или бота в полном размере
last_access_timeinteger <int64>
Время последней активности пользователя в чате. Может быть устаревшим для суперчатов (равно времени вступления)
is_ownerboolean
Является ли пользователь владельцем группового чата или канала
is_adminboolean
Является ли пользователь администратором группового чата или канала
join_timeinteger <int64>
Дата присоединения к чату в формате Unix timestamp в миллисекундах
permissionsChatAdminPermission[] Nullable
Возможные значения в enum: "read_all_messages" "add_remove_members" "add_admins" "change_chat_info" "pin_message" "write" "can_call" "edit_link" "post_edit_delete_message" "edit_message" "delete_message" "edit" "delete"
Перечень прав доступа пользователя или бота, если тот является администратором группового чата или канала. Для обычных участников чата или канала поле не возвращается
Ниже приведено краткое описание всех прав — подробнее читайте в разделе «Доступные права администратора»
Краткое описание доступных прав администратора:
read_all_messages— читать все сообщения в канале или групповом чатеedit— редактировать посты и комментарии в каналах (для групповых чатов недоступно). Ранее вместоeditв API использовалосьedit_message— в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используетсяeditdelete— удалять посты и комментарии в каналах (для групповых чатов недоступно). Ранее вместоdeleteв API использовалосьdelete_message— в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используетсяdeletewrite— редактировать и удалять сообщения в групповых чатах, а также писать посты и комментарии в каналах. Ранее вместоwriteв API использовалосьpost_edit_delete_message— в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используетсяwritepin_message— закреплять сообщениеchange_chat_info— изменять информацию о канале или групповом чатеadd_remove_members— добавлять и удалять участников группового чата (доступно пользователям и ботам) или подписчиков канала (доступно только пользователям)add_admins— добавлять и удалять администраторов группового чата или каналаedit_link— изменять ссылку на групповой чат (для каналов недоступно)can_call— звонить в групповом чате (для каналов недоступно)view_stats— право на просмотр статистики каналов (для групповых чатов недоступно). Назначается по умолчанию владельцам каналов. Для других пользователей-администраторов канала и ботов недоступно
aliasstring optional
Описание роли, которое будет отображаться на клиентском устройстве в настройках чата или канала рядом с именем пользователя
Если пользователь администратор или владелец и ему не установлено это название, то поле не передаётся, клиентское устройство на своей стороне подменит значение на соответствующее: "владелец" или "админ"
Коды ответов
| Код | Описание |
|---|---|
200 | Информация о членстве бота |
401 | Ошибка авторизации. Токен |
403 | Ошибка доступа. У вас нет прав на доступ к этому ресурсу |
404 | Запрашиваемый ресурс не найден |
500 | Внутренняя ошибка сервера |