Skip to content

User.md

Latest commit

 

History

History
173 lines (146 loc) · 12.3 KB

User.md

File metadata and controls

173 lines (146 loc) · 12.3 KB

User

dev.max.ru/docs-api/objects/User

Объект, описывающий один из вариантов наследования:

  • User — объект содержит общую информацию о пользователе или боте без аватара
  • UserWithPhoto — объект с общей информацией о пользователе или боте, дополнительно содержит URL аватара и описание
  • BotInfo — объект включает общую информацию о боте, URL аватара и описание. Дополнительно содержит список команд, поддерживаемых ботом. Возвращается только при вызове метода GET /me
  • ChatMember — объект включает общую информацию о пользователе или боте, URL аватара и описание при его наличии. Дополнительно содержит данные для пользователей-участников чата. Возвращается только при вызове некоторых методов группы /chats.

User {#User}

Поля объекта

Поле Тип Описание
user_id integer Идентификатор пользователя или бота
first_name string Отображаемое имя пользователя или бота
last_name string Отображаемая фамилия пользователя. Для ботов это поле не возвращается
username string Никнейм бота или уникальное публичное имя пользователя.
is_bot boolean true, если это бот
last_activity_time integer Время последней активности пользователя или бота в MAX (Unix-время в миллисекундах)

Пример объекта

    {
        "user_id": 0,
        "first_name": "string",
        "last_name": "string",
        "username": "string",
        "is_bot": true,
        "last_activity_time": 0
    }

UserWithPhoto {#UserWithPhoto}

Поля объекта

Поле Тип Описание
user_id integer Идентификатор пользователя или бота
first_name string Отображаемое имя пользователя или бота
last_name string Отображаемая фамилия пользователя. Для ботов это поле не возвращается
username string Никнейм бота или уникальное публичное имя пользователя
is_bot boolean true, если это бот
last_activity_time integer Время последней активности пользователя или бота в MAX (Unix-время в миллисекундах)
description string Описание бота (до 16000 символов)
avatar_url string URL аватара бота в уменьшенном размере
full_avatar_url string URL аватара бота в полном размере

Пример объекта

{
    "user_id": 0,
    "first_name": "string",
    "last_name": "string",
    "username": "string",
    "is_bot": true,
    "last_activity_time": 0,
    "description": "string",
    "avatar_url": "string",
    "full_avatar_url": "string"
}

BotInfo {#BotInfo}

Поля объекта

Поле Тип Описание
user_id integer Идентификатор пользователя или бота
first_name string Отображаемое имя пользователя или бота
last_name string Отображаемая фамилия пользователя. Для ботов это поле не возвращается
username string Никнейм бота или уникальное публичное имя пользователя.
is_bot boolean true, если это бот
last_activity_time integer Время последней активности пользователя или бота в MAX (Unix-время в миллисекундах)
description string Описание бота (до 16000 символов)
avatar_url string URL аватара бота в уменьшенном размере
full_avatar_url string URL аватара бота в полном размере
commands object Команды, поддерживаемые ботом (до 32 элементов)

Поля объекта BotCommand {#BotCommand}

Поле Тип Описание
name string Название команды (от 1 до 64 символов)
description string Описание команды (от 1 до 128 символов)

Пример объекта

{
    "user_id": 0,
    "first_name": "string",
    "last_name": "string",
    "username": "string",
    "is_bot": true,
    "last_activity_time": 0,
    "name": "string",
    "description": "string",
    "avatar_url": "string",
    "full_avatar_url": "string",
    "commands": [{
        "name": "string",
        "description": "string"
    }]
}

ChatMember {#ChatMember}

Поля объекта

Поле Тип Описание
user_id integer Идентификатор пользователя или бота
first_name string Отображаемое имя пользователя или бота
last_name string Отображаемая фамилия пользователя. Для ботов это поле не возвращается
username string Никнейм бота или уникальное публичное имя пользователя
is_bot boolean true, если это бот
last_activity_time integer Время последней активности пользователя или бота в MAX (Unix-время в миллисекундах)
description string Описание пользователя или бота (до 16000 символов)
avatar_url string URL аватара пользователя или бота в уменьшенном размере
full_avatar_url string URL аватара пользователя или бота в полном размере
last_access_time integer Время последней активности пользователя в чате. Может быть устаревшим для суперчатов (равно времени вступления)
is_owner boolean Является ли пользователь владельцем чата
is_admin boolean Является ли пользователь администратором чата
join_time integer Дата присоединения к чату в формате Unix time
permissions object Перечень прав пользователя. Возможные значения:
read_all_messages — Читать все сообщения
add_remove_members — Добавлять/удалять участников
add_admins — Добавлять администраторов
change_chat_info — Изменять информацию о чате
pin_message — Закреплять сообщения
write — Писать сообщения
edit_link — Изменять ссылку на чат
alias string Заголовок, который будет показан на клиенте. Если пользователь администратор или владелец и ему не установлено это название, то поле не передаётся, клиенты на своей стороне подменят на "владелец" или "админ"

Пример объекта

{
    "last_access_time": 0,
    "is_owner": false,
    "is_admin": true,
    "join_time": 1773988397836,
    "permissions": [
        "add_remove_members",
        "change_chat_info",
        "read_all_messages",
        "can_call",
        "add_admins",
        "edit_link",
        "write",
        "pin_message"
    ],
    "user_id": 123456789,
    "first_name": "Green-API bot",
    "username": "id123456789_1_bot",
    "is_bot": true,
    "last_activity_time": 1774253997680,
    "description": "Bot created by Green-API",
    "avatar_url": "https://i.oneme.ru/i?r=BTFjO43w8Yr1OSJ4tcurq5HiiuX5fPo",
    "full_avatar_url": "https://i.oneme.ru/i?r=BTFjO43w8Yr1OSJ4tfPo"
}