Перейти к содержанию

Package: maxapi.types.attachments

maxapi.types.attachments

attachment

StickerAttachmentPayload

Bases: BaseModel

Данные для вложения типа стикер.

Attributes:

Name Type Description
url str

URL стикера.
code str

Код стикера.

PhotoAttachmentPayload

Bases: BaseModel

Данные для фото-вложения.

Attributes:

Name Type Description
photo_id int

Идентификатор фотографии.
token str

Токен для доступа к фото.
url str

URL фотографии.

OtherAttachmentPayload

Bases: BaseModel

Данные для общих типов вложений (файлы и т.п.).

Attributes:

Name Type Description
url str

URL вложения.
token Optional[str]

Опциональный токен доступа.

ContactAttachmentPayload

Bases: BaseModel

Данные для контакта.

Attributes:

Name Type Description
vcf_info Optional[str]

Информация в формате vcf.
max_info Optional[User]

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

ButtonsPayload

Bases: BaseModel

Данные для вложения с кнопками.

Attributes:

Name Type Description
buttons List[List[InlineButtonUnion]]

Двумерный список inline-кнопок.

Attachment

Bases: BaseModel

Универсальный класс вложения с типом и полезной нагрузкой.

Attributes:

Name Type Description
type AttachmentType

Тип вложения.
payload Optional[Union[...]]

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

audio

Audio

Bases: Attachment

Вложение с типом аудио.

Attributes:

Name Type Description
transcription Optional[str]

Транскрипция аудио (если есть).

buttons

attachment_button

AttachmentButton

Bases: Attachment

Модель кнопки вложения для сообщения.

Attributes:

Name Type Description
type Literal[INLINE_KEYBOARD]

Тип кнопки, фиксированное значение 'inline_keyboard'
payload Optional[Union[AttachmentUpload, PhotoAttachmentPayload, OtherAttachmentPayload, ButtonsPayload, ContactAttachmentPayload, StickerAttachmentPayload]]

Полезная нагрузка кнопки (массив рядов кнопок)

button

Button

Bases: BaseModel

Базовая модель кнопки для сообщений.

Attributes:

Name Type Description
type ButtonType

Тип кнопки (определяет её поведение и функционал)
text str

Текст, отображаемый на кнопке (1-64 символа)

callback_button

CallbackButton

Bases: Button

Кнопка с callback-действием.

Attributes:

Name Type Description
type ButtonType

Тип кнопки (фиксированное значение ButtonType.CALLBACK)
text str

Текст, отображаемый на кнопке (наследуется от Button)
payload Optional[str]

Дополнительные данные (до 256 символов), передаваемые при нажатии
intent Intent

Намерение кнопки (визуальный стиль и поведение)

chat_button

ChatButton(**data)

Bases: Button

.. deprecated:: 0.9.14 Используйте другие типы кнопок.

Attributes:

Name Type Description
text str

Текст кнопки (наследуется от Button)
chat_title str

Название чата (до 128 символов)
chat_description Optional[str]

Описание чата (до 256 символов)
start_payload Optional[str]

Данные, передаваемые при старте чата (до 512 символов)
uuid Optional[int]

Уникальный идентификатор чата
Source code in maxapi/types/attachments/buttons/chat_button.py 
27
28
29
30
31
32
33
34
def __init__(self, **data):
    super().__init__(**data)
    warnings.warn(
        "ChatButton устарел и будет удален в будущих версиях. "
        "Используйте другие типы кнопок.",
        DeprecationWarning,
        stacklevel=2,
    )

Bases: Button

Кнопка с внешней ссылкой.

Attributes:

Name Type Description
url Optional[str]

Ссылка для перехода (должна содержать http/https)

message_button

MessageButton

Bases: Button

Кнопка для отправки текста

Attributes:

Name Type Description
type ButtonType

Тип кнопки (определяет её поведение и функционал)
text str

Отправляемый текст

open_app_button

OpenAppButton

Bases: Button

Кнопка для открытия приложения

Attributes:

Name Type Description
text str

Видимый текст кнопки
web_app Optional[str]

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

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

Параметр запуска, который будет передан в initData мини-приложения

request_contact

RequestContactButton

Bases: Button

Кнопка с контактом

Attributes:

Name Type Description
text str

Текст кнопки

request_geo_location_button

RequestGeoLocationButton

Bases: Button

Кнопка запроса геолокации пользователя.

Attributes:

Name Type Description
quick bool

Если True, запрашивает геолокацию без дополнительного подтверждения пользователя (по умолчанию False)

contact

Contact

Bases: Attachment

Вложение с типом контакта.

file

File

Bases: Attachment

Вложение с типом файла.

Attributes:

Name Type Description
filename Optional[str]

Имя файла.
size Optional[int]

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

image

PhotoAttachmentRequestPayload

Bases: BaseModel

Полезная нагрузка для запроса фото-вложения.

Attributes:

Name Type Description
url Optional[str]

URL изображения.
token Optional[str]

Токен доступа к изображению.
photos Optional[str]

Дополнительные данные о фотографиях.

Image

Bases: Attachment

Вложение с типом изображения.

Attributes:

Name Type Description
type Literal['image']

Тип вложения, всегда 'image'.

location

Location

Bases: Attachment

Вложение с типом геолокации.

Attributes:

Name Type Description
latitude Optional[float]

Широта.
longitude Optional[float]

Долгота.

share

Share

Bases: Attachment

Вложение с типом "share" (поделиться).

Attributes:

Name Type Description
title Optional[str]

Заголовок для шаринга.
description Optional[str]

Описание.
image_url Optional[str]

URL изображения для предпросмотра.

sticker

Sticker

Bases: Attachment

Вложение с типом стикера.

Attributes:

Name Type Description
width Optional[int]

Ширина стикера в пикселях.
height Optional[int]

Высота стикера в пикселях.

upload

AttachmentPayload

Bases: BaseModel

Полезная нагрузка вложения с токеном.

Attributes:

Name Type Description
token str

Токен для доступа или идентификации вложения.

AttachmentUpload

Bases: BaseModel

Вложение с полезной нагрузкой для загрузки на сервера MAX.

Attributes:

Name Type Description
type UploadType

Тип вложения (например, image, video, audio).
payload AttachmentPayload

Полезная нагрузка с токеном.

video

VideoUrl

Bases: BaseModel

URLs различных разрешений видео.

Attributes:

Name Type Description
mp4_1080 Optional[str]

URL видео в 1080p.
mp4_720 Optional[str]

URL видео в 720p.
mp4_480 Optional[str]

URL видео в 480p.
mp4_360 Optional[str]

URL видео в 360p.
mp4_240 Optional[str]

URL видео в 240p.
mp4_144 Optional[str]

URL видео в 144p.
hls Optional[str]

URL HLS потока.

VideoThumbnail

Bases: BaseModel

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

Attributes:

Name Type Description
url str

URL миниатюры.

Video

Bases: Attachment

Вложение с типом видео.

Attributes:

Name Type Description
token Optional[str]

Токен видео.
urls Optional[VideoUrl]

URLs видео разных разрешений.
thumbnail VideoThumbnail

Миниатюра видео.
width Optional[int]

Ширина видео.
height Optional[int]

Высота видео.
duration Optional[int]

Продолжительность видео в секундах.
bot Optional[Any]

Ссылка на экземпляр бота, не сериализуется.