Тип данных KeyboardButtonRequestUsers

Объект, определяющий критерии для запроса подходящих пользователей через кнопку клавиатуры бота.

Описание

Этот объект определяет критерии, используемые для запроса подходящих пользователей. Информация о выбранных пользователях будет передана боту при нажатии соответствующей кнопки. Подробнее о запросе пользователей »

Поле Тип Описание
request_id Integer 32-битный идентификатор запроса со знаком, который будет получен обратно в объекте UsersShared. Должен быть уникальным в пределах сообщения
user_is_bot Boolean Необязательный. Укажите True для запроса ботов, False — для запроса обычных пользователей. Если не указано, дополнительные ограничения не применяются.
user_is_premium Boolean Необязательный. Укажите True для запроса премиум-пользователей, False — для запроса обычных пользователей. Если не указано, дополнительные ограничения не применяются.
max_quantity Integer Необязательный. Максимальное количество выбираемых пользователей; 1-10. По умолчанию 1.
request_name Boolean Необязательный. Укажите True для запроса имени и фамилии пользователей
request_username Boolean Необязательный. Укажите True для запроса имён пользователей (username)
request_photo Boolean Необязательный. Укажите True для запроса фотографий пользователей

Примеры

json

{
  "request_id": 123456789,
  "user_is_bot": false,
  "user_is_premium": true,
  "max_quantity": 3,
  "request_name": true,
  "request_username": true,
  "request_photo": false
}

История изменений

  • API 7.0. Обновлен объект KeyboardButtonRequestUsers: Переименован из KeyboardButtonRequestUser, добавлено поле max_quantity
  • API 7.0. Добавлен объект KeyboardButtonRequestUsers
  • API 7.2. Обновлен объект KeyboardButtonRequestUsers: Добавлены поля request_name, request_username, request_photo

Дополнительно

  • UsersShared - Объект содержит информацию о пользователях, чьи идентификаторы были переданы боту через специальную кнопку клавиатуры.
Комментарии