Добавление участников в групповой чат

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

POST/chats/{chatId}/members

Добавляет участников в групповой чат

Бот, чей токен access_token используется для авторизации, должен быть администратором этого чата с соответствующим правом add_remove_members. Чтобы получить информацию о правах бота, используйте GET /chats/-chatId-/members/admins. Подробнее о правах — в описании POST /chats/{chatId}/members/admins

Добавить подписчиков в канал с помощью этого метода нельзя

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

BASH
curl -X POST "https://platform-api2.max.ru/chats/{chatId}/members" \
  -H "Authorization: {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
  "user_ids": ["{user_id_1}", "{user_id_2}"]
}'

Авторизация

access_token
apiKey

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

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

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

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

Параметры

chatId
integer <int64>\-?\d+
ID группового чата

Тело запроса

user_ids
string
Массив ID пользователей, которых вы хотите добавить в групповой чат. В одном запросе можно передать максимум 100 идентификаторов

Результат

success
boolean
true, если запрос был успешным, false — в противном случае

message
stringoptional
Сообщение об ошибке

failed_user_ids
integer[] Nullableoptional
ID пользователей, которых не удалось добавить в групповой чат

failed_user_details
FailedUserDetails[] Nullableoptional
Подробное объяснение, почему пользователь не был добавлен в групповой чат

error_code
string

Код ошибки

Возможные значения:

  • add.participant.privacy — ошибки конфиденциальности при добавлении пользователей

  • add.participant.not.found — пользователи не найдены

user_ids
integer[]
ID пользователей с данной ошибкой

Коды ответов

КодОписание
200Успешный или неуспешный результат
401Ошибка авторизации. Токен access_token указан некорректно или недействителен
403Ошибка доступа. У вас нет прав на доступ к этому ресурсу
404Запрашиваемый ресурс не найден
500Внутренняя ошибка сервера