Types#

class maxo.types.Attachment[исходный код]#

Базовые классы: MaxoType

Общая схема, представляющая вложение сообщения

type: AttachmentType#
abstractmethod to_request()[исходный код]#
Тип результата:

AttachmentsRequests

class maxo.types.AttachmentPayload[исходный код]#

Базовые классы: MaxoType

url: str#

//dev.max.ru/docs-api/objects/Update) после отправки сообщения в чат.

Прямую ссылку на видео также можно получить с помощью метода [GET /videos/{-videoToken-}](https://dev.max.ru/docs-api/methods/GET/videos/-videoToken-)

Type:

URL медиа-вложения. Этот URL будет получен в объекте [Update](https

class maxo.types.AttachmentRequest[исходный код]#

Базовые классы: MaxoType

Запрос на прикрепление данных к сообщению

type: AttachmentRequestType#
class maxo.types.AudioAttachment[исходный код]#

Базовые классы: Attachment

payload: MediaAttachmentPayload#
transcription: str | None | Omitted#

Аудио транскрипция

classmethod factory(url, token, transcription=<Omitted>)[исходный код]#

Фабричный метод.

Параметры:
  • url (str)

  • token (str)

  • transcription (str | None | Omitted)

Тип результата:

Self

property unsafe_transcription: str#
to_request()[исходный код]#
Тип результата:

AudioAttachmentRequest

class maxo.types.AudioAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление аудио к сообщению. Должен быть единственным вложением в сообщении

payload: UploadedInfo#
classmethod factory(token)[исходный код]#

Фабричный метод.

Параметры:

token (str)

Тип результата:

Self

class maxo.types.BaseMaxoType[исходный код]#

Базовые классы: object

BaseMaxoType()

class maxo.types.BaseUpdate[исходный код]#

Базовые классы: MaxoType

BaseUpdate()

class maxo.types.BotAddedToChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только бот будет добавлен в чат или канал

type: ClassVar[UpdateType] = 'bot_added'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, куда был добавлен бот. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#

Указывает, что бот добавлен в канал, а не в чат

user: User#

Пользователь, добавивший бота в чат

class maxo.types.BotCommand[исходный код]#

Базовые классы: MaxoType

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

name: str#

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

description: str | None | Omitted#

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

property unsafe_description: str#
class maxo.types.BotInfo[исходный код]#

Базовые классы: UserWithPhoto

Объект включает общую информацию о боте, URL аватара и описание. Является наследником [схемы UserWithPhoto](https://dev.max.ru/docs-api/objects/UserWithPhoto). Дополнительно к ней содержит список команд, поддерживаемых ботом. Возвращается только при вызове метода GET /me

commands: list[BotCommand] | None | Omitted#

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

property unsafe_commands: list[BotCommand]#
class maxo.types.BotMixin[исходный код]#

Базовые классы: object

property bot: Bot#
as_(bot)[исходный код]#
Параметры:

bot (Bot | None)

Тип результата:

Self

class maxo.types.BotRemovedFromChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только бот будет удалён из чата

type: ClassVar[UpdateType] = 'bot_removed'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, откуда был удалён бот. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#

Указывает, что бот удалён из канала, а не из чата

user: User#

Пользователь, удаливший бота из чата

class maxo.types.BotStarted[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь начнёт или возобновит общение с ботом: нажмёт соответствующую кнопку в настройках бота в МАКС

type: ClassVar[UpdateType] = 'bot_started'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID диалога, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#

Пользователь, который нажал кнопку Start

payload: str | None | Omitted#

Дополнительные данные из диплинков, переданные при запуске бота

user_locale: str | Omitted#

Текущий язык пользователя в формате IETF BCP 47

property unsafe_payload: str#
property unsafe_user_locale: str#
class maxo.types.BotStopped[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь остановит бота в его настройках в МАКС

type: ClassVar[UpdateType] = 'bot_stopped'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID диалога, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#

Пользователь, который остановил бота

user_locale: str | Omitted#

Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#
class maxo.types.Button[исходный код]#

Базовые классы: MaxoType

text: str#

20 символов - при 1 кнопке в ряду, 10 - при 2, 5 - при 3, 3 - при 4

Type:

Видимый текст кнопки. Чтобы он отображался полностью, рекомендуем не превышать заданное количество символов в зависимости от размещения текста

type: ButtonType#
class maxo.types.Callback[исходный код]#

Базовые классы: MaxoType

Объект, отправленный боту, когда пользователь нажимает кнопку

callback_id: str#

Текущий ID клавиатуры

timestamp: datetime#

Unix-время, когда пользователь нажал кнопку

user: User#

Пользователь, нажавший на кнопку

payload: str | Omitted#

Токен кнопки

property id: str#
property unsafe_payload: str#
property data: str | Omitted#
property unsafe_data: str#
class maxo.types.CallbackButton[исходный код]#

Базовые классы: Button

После нажатия на такую кнопку клиент отправляет на сервер полезную нагрузку, которая содержит

payload: str#

Токен кнопки

property callback_data: str#
maxo.types.CallbackQuery#

псевдоним для MessageCallback

class maxo.types.Chat[исходный код]#

Базовые классы: MaxoType

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

chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата или канала - в зависимости от ограничений метода и от того, с чем вы работаете. Как получить ID - в [разделе «Получение chat_id»](https

is_public: bool#

Доступен ли чат публично (для диалогов всегда false)

last_event_time: datetime#

Время последнего события в чате или канале

participants_count: int#

Количество участников чата или канала. Для диалогов всегда 2

status: ChatStatus#

Статус чата:

  • "active" - Бот является активным участником чата

  • "removed" - Бот был удалён из чата

  • "left" - Бот покинул чат

  • "closed" - Чат был закрыт

type: ChatType#

Тип чата:

  • "chat" - Групповой чат

  • "channel" - Канал

  • "dialog" - Диалог

description: str | None#

Описание чата или канала

icon: Image | None#

Иконка чата или канала

title: str | None#

Отображаемое название чата или канала. Может быть null для диалогов

chat_message_id: str | None | Omitted#

Идентификатор сообщения с кнопкой, через которую был инициирован чата

dialog_with_user: UserWithPhoto | None | Omitted#

Данные о пользователе в диалоге (только для чатов типа "dialog")

Ссылка на чат

messages_count: int | None | Omitted#

Количество сообщений в групповых чатах и каналах

owner_id: int | None | Omitted#

ID владельца чата или канала

participants: dict[str, Any] | None | Omitted#

Участники чата или канала с временем последней активности. Может быть null, если запрашивается список чатов

pinned_message: Message | None | Omitted#

Закреплённое сообщение в чате (возвращается только при запросе конкретного чата или канала)

property id: int#
property unsafe_chat_message_id: str#
property unsafe_description: str#
property unsafe_dialog_with_user: UserWithPhoto#
property unsafe_icon: Image#
property unsafe_messages_count: int#
property unsafe_owner_id: int#
property unsafe_participants: dict[str, Any]#
property unsafe_pinned_message: Message#
property unsafe_title: str#
class maxo.types.ChatAdmin[исходный код]#

Базовые классы: MaxoType

permissions: list[ChatAdminPermission]#

//dev.max.ru/docs-api/methods/POST/chats/-chatId-/members/admins)

**Краткое описание доступных прав администратора**:

  • read\_all\_messages - читать все сообщения в канале или групповом чате

  • edit - редактировать посты в каналах (для групповых чатов недоступно). Ранее вместо edit в API использовалось edit\_message - в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используйте edit

  • delete - удалять посты (для групповых чатов недоступно). Ранее вместо delete в API использовалось delete\_message - в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используйте delete

  • write - редактировать и удалять сообщения в групповых чатах, а также писать посты в каналах. Ранее вместо write в API использовалось post\_edit\_delete\_message - в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используйте write

  • pin\_message - закреплять сообщение

  • change\_chat\_info - изменять информацию о канале или групповом чате

  • add\_remove\_members - добавлять и удалять участников группового чата (доступно пользователям и ботам) или подписчиков канала (доступно только пользователям)

  • add\_admins - добавлять и удалять администраторов группового чата или канала

  • edit\_link - изменять ссылку на групповой чат (для каналов недоступно)

  • can\_call - звонить в групповом чате (для каналов недоступно)

  • view\_stats - право на просмотр статистики каналов (для групповых чатов недоступно). Назначается по умолчанию владельцам каналов. Для других пользователей-администраторов канала и ботов недоступно

Type:

Перечень прав доступа пользователя или бота, который назначается администратором группового чата или канала. Если право назначается действующему администратору, то его текущие права будут обновлены в соответствии с переданным списком. Ниже приведено краткое описание всех прав - подробнее читайте [в разделе «Доступные права администратора»](https

user_id: int#

Идентификатор пользователя-участника группового чата или канала, который назначается администратором

Максимум - 50 администраторов в чате

alias: str | Omitted#

Описание роли, которое будет отображаться на клиентском устройстве в настройках чата или канала рядом с именем пользователя

Если пользователь администратор или владелец и ему не установлено это название, то поле не передаётся, клиентское устройство на своей стороне подменит значение на соответствующее: «владелец» или «админ»

property unsafe_alias: str#
class maxo.types.ChatAdminsList[исходный код]#

Базовые классы: MaxoType

admins: list[ChatAdmin]#

Список пользователей и ботов, которые получат права администратора группового чата или канала

marker: int | None | Omitted#

Указатель на следующую страницу данных

property unsafe_marker: int#
class maxo.types.ChatList[исходный код]#

Базовые классы: MaxoType

chats: list[Chat]#

Список запрашиваемых чатов

marker: int | None#

Указатель на следующую страницу запрашиваемых чатов

property unsafe_marker: int#
class maxo.types.ChatMember[исходный код]#

Базовые классы: UserWithPhoto

Объект включает общую информацию о пользователе или боте, URL аватара и описание (при наличии). Является наследником [схемы UserWithPhoto](https://dev.max.ru/docs-api/objects/UserWithPhoto). Дополнительно к ней содержит данные для пользователей-участников чата или канала. Возвращается только при вызове некоторых методов группы /chats, например [GET /chats/{chatId}/members](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members)

is_admin: bool#

Является ли пользователь администратором группового чата или канала

is_owner: bool#

Является ли пользователь владельцем группового чата или канала

join_time: datetime#

Дата присоединения к чату в формате Unix time

last_access_time: datetime#

Время последней активности пользователя в чате. Может быть устаревшим для суперчатов (равно времени вступления)

permissions: list[ChatAdminPermission] | None#

Перечень прав доступа пользователя или бота, если тот является администратором группового чата или канала. Для обычных участников чата или канала поле не возвращается

Если право назначается действующему администратору, то его текущие права будут обновлены в соответствии с переданным списком. Ниже приведено краткое описание всех прав - подробнее читайте [в разделе «Доступные права администратора»](https://dev.max.ru/docs-api/methods/POST/chats/-chatId-/members/admins)

**Краткое описание доступных прав администратора**:

  • read\_all\_messages - читать все сообщения в канале или групповом чате

  • edit - редактировать посты в каналах (для групповых чатов недоступно). Ранее вместо edit в API использовалось edit\_message - в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используйте edit

  • delete - удалять посты (для групповых чатов недоступно). Ранее вместо delete в API использовалось delete\_message - в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используйте delete

  • write - редактировать и удалять сообщения в групповых чатах, а также писать посты в каналах. Ранее вместо write в API использовалось post\_edit\_delete\_message - в ответе могут возвращаться оба значения, однако при назначении новых прав администраторам используйте write

  • pin\_message - закреплять сообщение

  • change\_chat\_info - изменять информацию о канале или групповом чате

  • add\_remove\_members - добавлять и удалять участников группового чата (доступно пользователям и ботам) или подписчиков канала (доступно только пользователям)

  • add\_admins - добавлять и удалять администраторов группового чата или канала

  • edit\_link - изменять ссылку на групповой чат (для каналов недоступно)

  • can\_call - звонить в групповом чате (для каналов недоступно)

  • view\_stats - право на просмотр статистики каналов (для групповых чатов недоступно). Назначается по умолчанию владельцам каналов. Для других пользователей-администраторов канала и ботов недоступно

alias: str | Omitted#

Описание роли, которое будет отображаться на клиентском устройстве в настройках чата или канала рядом с именем пользователя

Если пользователь администратор или владелец и ему не установлено это название, то поле не передаётся, клиентское устройство на своей стороне подменит значение на соответствующее: «владелец» или «админ»

property unsafe_alias: str#
property unsafe_permissions: list[ChatAdminPermission]#
class maxo.types.ChatMembersList[исходный код]#

Базовые классы: MaxoType

members: list[ChatMember]#

Список участников группового чата или канала с общей информацией о них, а также временем последней активности и списком прав доступа для пользователей и ботов, которые являются администраторами

marker: int | None | Omitted#

Указатель на следующую страницу данных

property unsafe_marker: int#
class maxo.types.ChatTitleChanged[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только будет изменено название чата

type: ClassVar[UpdateType] = 'chat_title_changed'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

title: str#

Новое название

user: User#

Пользователь, который изменил название

class maxo.types.ClipboardButton[исходный код]#

Базовые классы: Button

При нажатии на кнопку с типом clipboard текст, указанный в свойстве payload, копируется в буфер обмена

payload: str#

Текст, который будет скопирован

class maxo.types.ContactAttachment[исходный код]#

Базовые классы: Attachment

payload: ContactAttachmentPayload#
classmethod factory(vcf_info=<Omitted>, max_info=<Omitted>)[исходный код]#

Фабричный метод.

Параметры:
  • vcf_info (str | None | Omitted)

  • max_info (User | None | Omitted)

Тип результата:

Self

to_request()[исходный код]#
Тип результата:

ContactAttachmentRequest

class maxo.types.ContactAttachmentPayload[исходный код]#

Базовые классы: MaxoType

hash: str | None | Omitted#

//dev.max.ru/docs-api#Типы%20кнопок)

Type:

Хеш информации о пользователе в формате VCF. Используется для проверки того, что пользователь поделился номером телефона, привязанным к его аккаунту в МАКС<br/> Подробнее - [в разделе «Типы кнопок»](https

max_info: User | None | Omitted#

Информация о пользователе

vcf_info: str | None | Omitted#

Информация о пользователе в формате VCF

property unsafe_hash: str#
property unsafe_max_info: User#
property unsafe_vcf_info: str#
class maxo.types.ContactAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление карточки контакта к сообщению. Должен быть единственным вложением в сообщении

payload: ContactAttachmentRequestPayload#
classmethod factory(name=None, contact_id=<Omitted>, vcf_info=<Omitted>, vcf_phone=<Omitted>)[исходный код]#

Фабричный метод.

Параметры:
  • name (str | None)

  • contact_id (int | None | Omitted)

  • vcf_info (str | None | Omitted)

  • vcf_phone (str | None | Omitted)

Тип результата:

Self

class maxo.types.ContactAttachmentRequestPayload[исходный код]#

Базовые классы: MaxoType

name: str | None#

Имя контакта

contact_id: int | None | Omitted#

ID контакта, если он зарегистирован в MAX

vcf_info: str | None | Omitted#

Полная информация о контакте в формате VCF

vcf_phone: str | None | Omitted#

Телефон контакта в формате VCF

property unsafe_contact_id: int#
property unsafe_name: str#
property unsafe_vcf_info: str#
property unsafe_vcf_phone: str#
class maxo.types.DialogCleared[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь очистит историю сообщений

type: ClassVar[UpdateType] = 'dialog_cleared'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#

Пользователь, который очистил историю сообщений

user_locale: str | Omitted#

Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#
class maxo.types.DialogMuted[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь отключит уведомления о новых сообщениях в диалоге с ботом

type: ClassVar[UpdateType] = 'dialog_muted'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

muted_until: datetime#

Время в формате Unix, до наступления которого диалог был отключён

user: User#

Пользователь, который отключил уведомления

user_locale: str | Omitted#

Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#
class maxo.types.DialogRemoved[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь удалит чат

type: ClassVar[UpdateType] = 'dialog_removed'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#

Пользователь, который удалил чат

user_locale: str | Omitted#

Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#
class maxo.types.DialogUnmuted[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь включит уведомления о новых сообщениях в диалоге с ботом

type: ClassVar[UpdateType] = 'dialog_unmuted'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

user: User#

Пользователь, который включил уведомления

user_locale: str | Omitted#

Текущий язык пользователя в формате IETF BCP 47

property unsafe_user_locale: str#
class maxo.types.EmphasizedMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет *курсив*

class maxo.types.ErrorEvent[исходный код]#

Базовые классы: BaseUpdate, Generic[_ExceptionT, _UpdateT]

ErrorEvent(*, exception: ~_ExceptionT, update: maxo.routing.signals.update.MaxoUpdate[~_UpdateT])

exception: _ExceptionT#
update: MaxoUpdate[_UpdateT]#
property error: _ExceptionT#
property event: _UpdateT#
class maxo.types.FailedUserDetails[исходный код]#

Базовые классы: MaxoType

Подробное описание, почему пользователь не был добавлен в групповой чат или канал

error_code: str#

Код ошибки

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

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

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

user_ids: list[int]#

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

class maxo.types.FileAttachment[исходный код]#

Базовые классы: Attachment

filename: str#

Имя загруженного файла

payload: FileAttachmentPayload#
size: int#

Размер файла в байтах

classmethod factory(url, token, filename, size)[исходный код]#

Фабричный метод.

Параметры:
Тип результата:

Self

to_request()[исходный код]#
Тип результата:

FileAttachmentRequest

class maxo.types.FileAttachmentPayload[исходный код]#

Базовые классы: AttachmentPayload

token: str#

Используйте token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении.

class maxo.types.FileAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление файла к сообщению. Должен быть единственным вложением в сообщении

payload: UploadedInfo#
classmethod factory(token)[исходный код]#

Фабричный метод.

Параметры:

token (str)

Тип результата:

Self

class maxo.types.GetPinnedMessageResult[исходный код]#

Базовые классы: MaxoType

message: Message | None | Omitted#

Закреплённое сообщение. Может быть null, если в чате нет закреплённого сообщения

property unsafe_message: Message#
class maxo.types.GetSubscriptionsResult[исходный код]#

Базовые классы: MaxoType

Список всех WebHook подписок

subscriptions: list[Subscription]#

Список текущих подписок

class maxo.types.HeadingMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет заголовок

class maxo.types.HighlightedMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет выделенный текст

class maxo.types.Image[исходный код]#

Базовые классы: MaxoType

Общая схема, описывающая объект изображения

url: str#

URL изображения

class maxo.types.InlineKeyboardAttachment[исходный код]#

Базовые классы: Attachment

Кнопки в сообщении

payload: Keyboard#
classmethod factory(buttons)[исходный код]#

Фабричный метод.

Параметры:

buttons (list[list[CallbackButton | ClipboardButton | LinkButton | RequestGeoLocationButton | RequestContactButton | OpenAppButton | MessageButton]])

Тип результата:

Self

to_request()[исходный код]#
Тип результата:

InlineKeyboardAttachmentRequest

class maxo.types.InlineKeyboardAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление клавиатуры к сообщению

payload: InlineKeyboardAttachmentRequestPayload#
classmethod factory(buttons)[исходный код]#
Параметры:

buttons (list[list[CallbackButton | ClipboardButton | LinkButton | RequestGeoLocationButton | RequestContactButton | OpenAppButton | MessageButton]])

Тип результата:

Self

class maxo.types.InlineKeyboardAttachmentRequestPayload[исходный код]#

Базовые классы: MaxoType

buttons: list[list[CallbackButton | ClipboardButton | LinkButton | RequestGeoLocationButton | RequestContactButton | OpenAppButton | MessageButton]]#

//dev.max.ru/docs-api#Клавиатура%20для%20чат-бота)

Type:

Двумерный массив кнопок. Подробнее о типах кнопок и клавиатуре в ботах - [в разделе «Клавиатура для чат-бота»](https

class maxo.types.Keyboard[исходный код]#

Базовые классы: MaxoType

Клавиатура - это двумерный массив кнопок. Подробнее о типах кнопок и клавиатуре в ботах - [в разделе «Клавиатура для чат-бота»](https://dev.max.ru/docs-api#Клавиатура%20для%20чат-бота)

buttons: list[list[CallbackButton | ClipboardButton | LinkButton | RequestGeoLocationButton | RequestContactButton | OpenAppButton | MessageButton]]#
class maxo.types.LinkButton[исходный код]#

Базовые классы: Button

После нажатия на такую кнопку пользователь переходит по ссылке, которую она содержит

url: str#
class maxo.types.LinkMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет ссылку в тексте

url: str#

URL ссылки

class maxo.types.LinkedMessage[исходный код]#

Базовые классы: MaxoType

message: MessageBody#
type: MessageLinkType#

Тип связанного сообщения

chat_id: int | Omitted#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

Чат, в котором сообщение было изначально опубликовано. Только для пересланных сообщений. Как получить ID - в [разделе «Получение chat_id»](https

sender: User | Omitted#

Пользователь, отправивший сообщение.

property unsafe_chat_id: int#
property unsafe_sender: User#
property generated_url: str | None#

Генерирует ссылку на сообщение.

Возвращает:

str | None: Ссылка на сообщение или None, если chat\_id не определен.

property unsafe_generated_url: str#

Генерирует ссылку на сообщение.

Если generated\_url не определен, вызывает :py:exc:~maxo.errors.AttributeIsEmptyError.

Возвращает:

str: Ссылка на сообщение.

class maxo.types.LocationAttachment[исходный код]#

Базовые классы: Attachment

latitude: float#

Широта

longitude: float#

Долгота

to_request()[исходный код]#
Тип результата:

LocationAttachmentRequest

class maxo.types.LocationAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление клавиатуры к сообщению

latitude: float#

Широта

longitude: float#

Долгота

class maxo.types.MarkupElement[исходный код]#

Базовые классы: MaxoType

from_: int#

Индекс начала элемента разметки в тексте. Нумерация с нуля

length: int#

Длина элемента разметки

type: MarkupElementType#

Тип элемента разметки. Может быть **жирный**, *курсив*, ~зачеркнутый~, <ins>подчеркнутый</ins>, моноширинный, выделенный, цитата, заголовок, ссылка или упоминание пользователя

property offset: int#
class maxo.types.MaxUpdate[исходный код]#

Базовые классы: BaseUpdate

Базовый класс для всех апдейтов из Макса.

У всех апдейтов есть тип (type, update\_type) и время (timestamp). Фасад (facade) объединяет методы для работы с апдейтом, например, отправить сообщение или ответить на колбэк.

type: ClassVar[UpdateType]#
timestamp: datetime#
property update_type: UpdateType#
class maxo.types.MaxoType[исходный код]#

Базовые классы: BaseMaxoType, BotMixin

MaxoType()

class maxo.types.MediaAttachmentPayload[исходный код]#

Базовые классы: AttachmentPayload

token: str#

Используйте token, если вы пытаетесь повторно использовать одно и то же вложение в другом сообщении.

class maxo.types.Message[исходный код]#

Базовые классы: MaxoType, MessageMethodsFacade

Сообщение в чате

body: MessageBody#

Содержимое сообщения. Текст + вложения. Может быть null, если сообщение содержит только пересланное сообщение

recipient: Recipient#

Получатель сообщения. Может быть пользователем или чатом

timestamp: datetime#

Время создания сообщения в формате Unix-time

Пересланное или ответное сообщение

sender: User | Omitted#

Пользователь, отправивший сообщение

stat: MessageStat | None | Omitted#

Статистика сообщения. Возвращается только для постов в каналах

url: str | None | Omitted#

Публичная ссылка на пост в канале. Отсутствует для диалогов и групповых чатов

property message: Self#
property unsafe_sender: User#
property unsafe_stat: MessageStat#
property unsafe_url: str#
property generated_url: str | None#

Генерирует ссылку на сообщение.

Возвращает:

str | None: Ссылка на сообщение или None, если recipient.chat\_id не определен.

property unsafe_generated_url: str#

Генерирует ссылку на сообщение.

Если generated\_url не определен, вызывает :py:exc:~maxo.errors.AttributeIsEmptyError.

Возвращает:

str: Ссылка на сообщение.

class maxo.types.MessageBody[исходный код]#

Базовые классы: MaxoType

Схема, представляющая тело сообщения

mid: str#

Уникальный ID сообщения

seq: int#

ID последовательности сообщения в чате

attachments: list[PhotoAttachment | VideoAttachment | AudioAttachment | FileAttachment | StickerAttachment | ContactAttachment | InlineKeyboardAttachment | ShareAttachment | LocationAttachment] | None#

Вложения сообщения. Могут быть одним из типов Attachment. Смотрите описание схемы

text: str | None#

Новый текст сообщения

markup: list[EmphasizedMarkup | HeadingMarkup | HighlightedMarkup | LinkMarkup | MonospacedMarkup | QuoteMarkup | StrikethroughMarkup | StrongMarkup | UnderlineMarkup | UserMentionMarkup] | None | Omitted#

//dev.max.ru/docs-api#Форматирование%20текста%20в%20сообщениях)

Type:

Разметка текста сообщения. Для подробной информации загляните в раздел [Форматирование](https

property id: str#
property keyboard: Keyboard | None#
property reply_markup: Keyboard | None#
property photo: list[PhotoAttachment]#
property video: list[VideoAttachment]#
property audio: AudioAttachment | None#
property file: FileAttachment | None#
property sticker: StickerAttachment | None#
property contact: ContactAttachment | None#
property share: ShareAttachment | None#
property location: LocationAttachment | None#
property html_text: str#
property md_text: str#
property unsafe_attachments: list[PhotoAttachment | VideoAttachment | AudioAttachment | FileAttachment | StickerAttachment | ContactAttachment | InlineKeyboardAttachment | ShareAttachment | LocationAttachment]#
property unsafe_markup: list[EmphasizedMarkup | HeadingMarkup | HighlightedMarkup | LinkMarkup | MonospacedMarkup | QuoteMarkup | StrikethroughMarkup | StrongMarkup | UnderlineMarkup | UserMentionMarkup]#
property unsafe_text: str#
property attachment_type: AttachmentType#
property content_type: AttachmentType#
class maxo.types.MessageButton[исходный код]#

Базовые классы: Button

Кнопка для запуска мини-приложения

property unsafe_text: str#
class maxo.types.MessageCallback[исходный код]#

Базовые классы: MaxUpdate, CallbackMethodsFacade, MessageMethodsFacade

Вы получите это событие, как только пользователь нажмёт кнопку

type = 'message_callback'#
callback: Callback#
message: Message | None#

Изначальное сообщение, содержащее встроенную клавиатуру. Может быть null, если оно было удалено к моменту, когда бот получил это событие

user_locale: str | None | Omitted#

Текущий язык пользователя в формате IETF BCP 47

property unsafe_message: Message#
property unsafe_user_locale: str#
property callback_id: str#
property id: str#
property payload: str | Omitted#
property data: str | Omitted#
property user: User#
property from_user: User#
class maxo.types.MessageCreated[исходный код]#

Базовые классы: MaxUpdate, MessageMethodsFacade

Вы получите это событие, как только сообщение будет создано

type = 'message_created'#
message: Message#

Новое созданное сообщение

user_locale: str | None | Omitted#

Текущий язык пользователя в формате IETF BCP 47. Доступно только в диалогах

property unsafe_user_locale: str#
property text: str | None#
property user_id: int | None#
class maxo.types.MessageEdited[исходный код]#

Базовые классы: MaxUpdate, MessageMethodsFacade

Вы получите это событие, как только пользователь отредактирует сообщение

type = 'message_edited'#
message: Message#

Отредактированное сообщение

property text: str | None#
class maxo.types.MessageList[исходный код]#

Базовые классы: MaxoType

Пагинированный список сообщений

messages: list[Message]#

Массив сообщений

class maxo.types.MessageRemoved[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только сообщение будет удалено

type: ClassVar[UpdateType] = 'message_removed'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где сообщение было удалено. Как получить ID - в [разделе «Получение chat_id»](https

message_id: str#

ID удалённого сообщения

user_id: int#

Пользователь, удаливший сообщение

class maxo.types.MessageStat[исходный код]#

Базовые классы: MaxoType

Статистика сообщения. Возвращается только для постов в каналах

views: int#

Количество пользователей, которые увидели пост в канале. Просмотр засчитывается, когда пост попадает в область видимости экрана

class maxo.types.ModifyMembersResult[исходный код]#

Базовые классы: SimpleQueryResult

Результат запроса на изменение списка участников

failed_user_details: list[FailedUserDetails] | None | Omitted#

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

failed_user_ids: list[int] | None | Omitted#

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

property unsafe_failed_user_details: list[FailedUserDetails]#
property unsafe_failed_user_ids: list[int]#
class maxo.types.MonospacedMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет моноширинный или блок `код` в тексте

class maxo.types.NewMessageBody[исходный код]#

Базовые классы: MaxoType

attachments: list[PhotoAttachmentRequest | VideoAttachmentRequest | AudioAttachmentRequest | FileAttachmentRequest | StickerAttachmentRequest | ContactAttachmentRequest | InlineKeyboardAttachmentRequest | LocationAttachmentRequest | ShareAttachmentRequest | PhotoAttachment | VideoAttachment | AudioAttachment | FileAttachment | StickerAttachment | ContactAttachment | InlineKeyboardAttachment | ShareAttachment | LocationAttachment] | None#

Вложения сообщения. Если поле равно null, изменений не произойдет. Если пусто, все вложения будут удалены

Ссылка на сообщение

text: str | None#

Новый текст сообщения

format: TextFormat | None | Omitted#

//dev.max.ru/docs-api#Форматирование%20текста%20в%20сообщениях)

Type:

Если установлен, текст сообщения будет форматирован данным способом. Для подробной информации загляните в раздел [Форматирование](https

notify: bool | Omitted#

Если false, участники чата не будут уведомлены (по умолчанию true)

property unsafe_attachments: list[PhotoAttachmentRequest | VideoAttachmentRequest | AudioAttachmentRequest | FileAttachmentRequest | StickerAttachmentRequest | ContactAttachmentRequest | InlineKeyboardAttachmentRequest | LocationAttachmentRequest | ShareAttachmentRequest | PhotoAttachment | VideoAttachment | AudioAttachment | FileAttachment | StickerAttachment | ContactAttachment | InlineKeyboardAttachment | ShareAttachment | LocationAttachment]#
property unsafe_format: TextFormat#
property unsafe_notify: bool#
property unsafe_text: str#

Базовые классы: MaxoType

mid: str#

ID исходного сообщения

type: MessageLinkType#

Тип ссылки сообщения

class maxo.types.OpenAppButton[исходный код]#

Базовые классы: Button

Кнопка для запуска мини-приложения

contact_id: int | Omitted#

Идентификатор бота, чьё мини-приложение надо запустить

payload: str | Omitted#

//dev.max.ru/docs/webapps/bridge#WebAppData) мини-приложения

Type:

Параметр запуска, который будет передан в [initData](https

web_app: str | Omitted#

Публичное имя (username) бота или ссылка на него, чьё мини-приложение надо запустить

property unsafe_contact_id: int#
property unsafe_payload: str#
property unsafe_web_app: str#
class maxo.types.PhotoAttachment[исходный код]#

Базовые классы: Attachment

Вложение изображения

payload: PhotoAttachmentPayload#
classmethod factory(photo_id, token, url)[исходный код]#

Фабричный метод.

Параметры:
Тип результата:

Self

to_request()[исходный код]#
Тип результата:

PhotoAttachmentRequest

class maxo.types.PhotoAttachmentPayload[исходный код]#

Базовые классы: MaxoType

photo_id: int#

Уникальный ID этого изображения

token: str#
url: str#

URL изображения

class maxo.types.PhotoAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

payload: PhotoAttachmentRequestPayload#
classmethod factory(*, url=<Omitted>, token=<Omitted>, photos=<Omitted>)[исходный код]#

Фабричный метод.

Все поля являются взаимоисключающими.

Параметры:
  • url (str | None | Omitted)

  • token (str | None | Omitted)

  • photos (list[str] | None | Omitted)

Тип результата:

Self

class maxo.types.PhotoAttachmentRequestPayload[исходный код]#

Базовые классы: MaxoType

Запрос на прикрепление изображения (все поля являются взаимоисключающими)

photos: list[PhotoToken] | None | Omitted#

Токены, полученные после загрузки изображений

token: str | None | Omitted#

Токен существующего вложения

url: str | None | Omitted#

Любой внешний URL изображения, которое вы хотите прикрепить

property unsafe_photos: list[PhotoToken]#
property unsafe_token: str#
property unsafe_url: str#
class maxo.types.PhotoToken[исходный код]#

Базовые классы: MaxoType

token: str#

Закодированная информация загруженного изображения

class maxo.types.QuoteMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет цитату

class maxo.types.Recipient[исходный код]#

Базовые классы: MaxoType

Новый получатель сообщения. Может быть пользователем или чатом

chat_type: ChatType#

Тип чата

chat_id: int | None#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата. Как получить ID - в [разделе «Получение chat_id»](https

user_id: int | None#

ID пользователя, если сообщение было отправлено пользователю

property unsafe_chat_id: int#
property unsafe_user_id: int#
class maxo.types.RequestContactButton[исходный код]#

Базовые классы: Button

После нажатия на такую кнопку клиент отправляет новое сообщение с вложением текущего контакта пользователя

class maxo.types.RequestGeoLocationButton[исходный код]#

Базовые классы: Button

После нажатия на такую кнопку клиент отправляет новое сообщение с вложением текущего географического положения пользователя

quick: bool | Omitted#

Если *true*, отправляет местоположение без запроса подтверждения пользователя

property unsafe_quick: bool#
class maxo.types.SendMessageResult[исходный код]#

Базовые классы: MaxoType

message: Message#
class maxo.types.ShareAttachment[исходный код]#

Базовые классы: Attachment

payload: ShareAttachmentPayload#
description: str | None | Omitted#

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

image_url: str | None | Omitted#

Изображение предпросмотра ссылки

title: str | None | Omitted#

Заголовок предпросмотра ссылки.

classmethod factory(url=<Omitted>, token=<Omitted>, title=<Omitted>, description=<Omitted>, image_url=<Omitted>)[исходный код]#
Параметры:
  • url (str | None | Omitted)

  • token (str | None | Omitted)

  • title (str | None | Omitted)

  • description (str | None | Omitted)

  • image_url (str | None | Omitted)

Тип результата:

Self

property unsafe_description: str#
property unsafe_image_url: str#
property unsafe_title: str#
to_request()[исходный код]#
Тип результата:

ShareAttachmentRequest

class maxo.types.ShareAttachmentPayload[исходный код]#

Базовые классы: MaxoType

Полезная нагрузка запроса ShareAttachmentRequest

token: str | None | Omitted#

Токен вложения

url: str | None | Omitted#

URL, прикрепленный к сообщению в качестве предпросмотра медиа

property unsafe_token: str#
property unsafe_url: str#
class maxo.types.ShareAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление предпросмотра медиафайла по внешнему URL

payload: ShareAttachmentPayload#
classmethod factory(*, url=<Omitted>, token=<Omitted>)[исходный код]#

Фабричный метод.

Параметры:
  • url (str | None | Omitted)

  • token (str | None | Omitted)

Тип результата:

Self

class maxo.types.SimpleQueryResult[исходный код]#

Базовые классы: MaxoType

Простой ответ на запрос

success: bool#

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

message: str | Omitted#

Объяснительное сообщение, если результат не был успешным

property unsafe_message: str#
class maxo.types.StickerAttachment[исходный код]#

Базовые классы: Attachment

height: int#

Высота стикера

payload: StickerAttachmentPayload#
width: int#

Ширина стикера

classmethod factory(url, code, width, height)[исходный код]#

Фабричный метод.

Параметры:
Тип результата:

Self

to_request()[исходный код]#
Тип результата:

StickerAttachmentRequest

class maxo.types.StickerAttachmentPayload[исходный код]#

Базовые классы: AttachmentPayload

code: str#

ID стикера

class maxo.types.StickerAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление стикера. ДОЛЖЕН быть единственным вложением в сообщении

payload: StickerAttachmentRequestPayload#
classmethod factory(code)[исходный код]#

Фабричный метод.

Параметры:

code (str)

Тип результата:

Self

class maxo.types.StickerAttachmentRequestPayload[исходный код]#

Базовые классы: MaxoType

code: str#

Код стикера

class maxo.types.StrikethroughMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет ~зачёркнутый~ текст

class maxo.types.StrongMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет **жирный** текст

class maxo.types.Subscription[исходный код]#

Базовые классы: MaxoType

Схема для описания подписки на WebHook

time: datetime#

Unix-время, когда была создана подписка

url: str#

URL вебхука

update_types: list[str] | None#

Типы событий, на которые подписан бот

property unsafe_update_types: list[str]#
class maxo.types.UnderlineMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет <ins>подчёркнутый</ins> текст

class maxo.types.UpdateContext[исходный код]#

Базовые классы: MaxoType

Контекст апдейта: идентификаторы чата и пользователя, при включённом обогащении - объекты чата и пользователя, полученные через Bot API.

chat_id: int | None#
user_id: int | None#
type: ChatType | None#
chat: Chat | None#
user: User | None#
property chat_type: ChatType | None#
class maxo.types.UpdateList[исходный код]#

Базовые классы: MaxoType

Список обновлений о событиях в чатах и каналах, в которые добавлен бот. Обратите внимание, чтобы получать события из групповых чатов и каналов, бот должен быть администратором

updates: list[BotAddedToChat | BotRemovedFromChat | BotStarted | BotStopped | ChatTitleChanged | DialogCleared | DialogMuted | DialogRemoved | DialogUnmuted | MessageCallback | MessageCreated | MessageEdited | MessageRemoved | UserAddedToChat | UserRemovedFromChat]#

//dev.max.ru/docs-api/objects/Update)

Type:

Список обновлений о событиях в чатах и каналах, в которые добавлен бот. Обратите внимание, чтобы получать события из групповых чатов и каналов, бот должен быть администратором. Подробнее о возможных событиях - [в описании объекта Update](https

marker: int | None#

Указатель на следующую страницу данных

property unsafe_marker: int#
class maxo.types.UploadEndpoint[исходный код]#

Базовые классы: MaxoType

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

url: str#

URL для загрузки медиафайла. Срок жизни ссылки не ограничен

token: str | Omitted#

//dev.max.ru/docs-api/methods/PUT/messages)

Type:

Токен для отправки медиафайла во вложении к сообщению с помощью [POST /messages](https

Type:

//dev.max.ru/docs-api/methods/POST/messages) или [PUT /messages](https

property unsafe_token: str#
class maxo.types.UploadMediaResult[исходный код]#

Базовые классы: MaxoType

UploadMediaResult(*, token: Union[str, unihttp.omitted.Omitted] = <Omitted>, photos: Union[dict[str, maxo.types.photo_token.PhotoToken], unihttp.omitted.Omitted] = <Omitted>, file_id: Union[int, unihttp.omitted.Omitted] = <Omitted>)

token: str | Omitted#
photos: dict[str, PhotoToken] | Omitted#
file_id: int | Omitted#
property last_token: str#
class maxo.types.UploadedInfo[исходный код]#

Базовые классы: MaxoType

Это информация, которую вы получите, как только аудио/видео будет загружено

token: str | Omitted#

Токен - уникальный ID загруженного медиафайла

property unsafe_token: str#
class maxo.types.User[исходный код]#

Базовые классы: MaxoType

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

  • [User](https://dev.max.ru/docs-api/objects/User) - объект содержит общую информацию о пользователе или боте без аватара

  • [UserWithPhoto](https://dev.max.ru/docs-api/objects/UserWithPhoto) - объект с общей информацией о пользователе или боте, дополнительно содержит URL аватара и описание

  • [BotInfo](https://dev.max.ru/docs-api/objects/BotInfo) - объект включает общую информацию о боте, URL аватара и описание. Дополнительно содержит список команд, поддерживаемых ботом. Возвращается только при вызове метода [GET /me](https://dev.max.ru/docs-api/methods/GET/me)

  • [ChatMember](https://dev.max.ru/docs-api/objects/ChatMember) - объект включает общую информацию о пользователе или боте, URL аватара и описание при его наличии. Дополнительно содержит данные для пользователей-участников чата. Возвращается только при вызове некоторых методов группы /chats, например [GET /chats/{chatId}/members](https://dev.max.ru/docs-api/methods/GET/chats/-chatId-/members)

first_name: str#

Отображаемое имя пользователя или бота

is_bot: bool#

true, если это бот

last_activity_time: datetime#

Время последней активности пользователя или бота в MAX (Unix-время в миллисекундах). Если пользователь отключил в настройках профиля мессенджера MAX возможность видеть, что он в сети онлайн, поле может не возвращаться

user_id: int#

Идентификатор пользователя или бота

username: str | None#

Никнейм бота или уникальное публичное имя пользователя. В случае с пользователем может быть null, если тот недоступен или имя не задано

last_name: str | None | Omitted#

Отображаемая фамилия пользователя. Для ботов это поле не возвращается

name: str | None | Omitted#

_Устаревшее поле, скоро будет удалено_

property id: int#
property fullname: str#
property full_name: str#
property unsafe_last_name: str#
property unsafe_name: str#
property unsafe_username: str#
class maxo.types.UserAddedToChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь будет добавлен в чат, где бот является администратором

type: ClassVar[UpdateType] = 'user_added'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#

Указывает, что пользователь добавлен в канал, а не в чат

user: User#

Пользователь, добавленный в чат

inviter_id: int | None | Omitted#

Пользователь, который добавил нового пользователя в чат. Может быть null, если пользователь присоединился к чату по ссылке

property unsafe_inviter_id: int#
class maxo.types.UserMentionMarkup[исходный код]#

Базовые классы: MarkupElement

Представляет упоминание пользователя в тексте. Упоминание может быть как по имени пользователя, так и по ID, если у пользователя нет имени

user_id: int | None | Omitted#

ID упомянутого пользователя без имени

@username упомянутого пользователя

property unsafe_user_id: int#
class maxo.types.UserRemovedFromChat[исходный код]#

Базовые классы: MaxUpdate, ChatMethodsFacade

Вы получите это событие, как только пользователь будет удалён из чата, где бот является администратором

type: ClassVar[UpdateType] = 'user_removed'#
chat_id: int#

//dev.max.ru/docs-api#Получение%20chat_id)

Type:

ID чата, где произошло событие. Как получить ID - в [разделе «Получение chat_id»](https

is_channel: bool#

Указывает, что пользователь удалён из канала, а не из чата

user: User#

Пользователь, удалённый из чата

admin_id: int | Omitted#

Администратор, который удалил пользователя из чата. Может быть null, если пользователь покинул чат сам

property unsafe_admin_id: int#
class maxo.types.UserWithPhoto[исходный код]#

Базовые классы: User

Объект с общей информацией о пользователе или боте. Является наследником [схемы User](https://dev.max.ru/docs-api/objects/User) - дополнительно к ней содержит URL аватара и описание

avatar_url: str | Omitted#

URL аватара пользователя или бота в уменьшенном размере

description: str | None | Omitted#

Описание пользователя или бота. В случае с пользователем может принимать значение null, если описание не заполнено

full_avatar_url: str | Omitted#

URL аватара пользователя или бота в полном размере

property unsafe_avatar_url: str#
property unsafe_description: str#
property unsafe_full_avatar_url: str#
class maxo.types.VideoAttachment[исходный код]#

Базовые классы: Attachment

payload: MediaAttachmentPayload#
duration: int | None | Omitted#

Длина видео в секундах

height: int | None | Omitted#

Высота видео

thumbnail: VideoThumbnail | None | Omitted#

Миниатюра видео

width: int | None | Omitted#

Ширина видео

classmethod factory(url, token, thumbnail_url=<Omitted>, width=<Omitted>, height=<Omitted>, duration=<Omitted>)[исходный код]#

Фабричный метод.

Параметры:
  • url (str)

  • token (str)

  • thumbnail_url (str | Omitted)

  • width (int | None | Omitted)

  • height (int | None | Omitted)

  • duration (int | None | Omitted)

Тип результата:

Self

property unsafe_duration: int#
property unsafe_height: int#
property unsafe_thumbnail: VideoThumbnail#
property unsafe_width: int#
to_request()[исходный код]#
Тип результата:

VideoAttachmentRequest

class maxo.types.VideoAttachmentDetails[исходный код]#

Базовые классы: MaxoType

duration: int#

Длина видео в секундах

height: int#

Высота видео

token: str#

Токен видео-вложения

width: int#

Ширина видео

thumbnail: PhotoAttachmentPayload | None | Omitted#

Миниатюра видео

urls: VideoUrls | None | Omitted#

URL-ы для скачивания или воспроизведения видео. Может быть null, если видео недоступно

property unsafe_thumbnail: PhotoAttachmentPayload#
property unsafe_urls: VideoUrls#
class maxo.types.VideoAttachmentRequest[исходный код]#

Базовые классы: AttachmentRequest

Запрос на прикрепление видео к сообщению

payload: UploadedInfo#
classmethod factory(token=<Omitted>)[исходный код]#

Фабричный метод.

Параметры:

token (str | Omitted)

Тип результата:

Self

class maxo.types.VideoThumbnail[исходный код]#

Базовые классы: MaxoType

url: str#

URL изображения

class maxo.types.VideoUrls[исходный код]#

Базовые классы: MaxoType

hls: str | None | Omitted#

URL трансляции, если доступна

mp4_1080: str | None | Omitted#

URL видео в разрешении 1080p, если доступно

mp4_144: str | None | Omitted#

URL видео в разрешении 144p, если доступно

mp4_240: str | None | Omitted#

URL видео в разрешении 240p, если доступно

mp4_360: str | None | Omitted#

URL видео в разрешении 360p, если доступно

mp4_480: str | None | Omitted#

URL видео в разрешении 480p, если доступно

mp4_720: str | None | Omitted#

URL видео в разрешении 720p, если доступно

property unsafe_hls: str#
property unsafe_mp4_1080: str#
property unsafe_mp4_144: str#
property unsafe_mp4_240: str#
property unsafe_mp4_360: str#
property unsafe_mp4_480: str#
property unsafe_mp4_720: str#