Enums#

class maxo.enums.AttachmentRequestType[исходный код]#

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

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

AUDIO = 'audio'#
CONTACT = 'contact'#
FILE = 'file'#
IMAGE = 'image'#
INLINE_KEYBOARD = 'inline_keyboard'#
LOCATION = 'location'#
SHARE = 'share'#
STICKER = 'sticker'#
VIDEO = 'video'#
__new__(value)#
class maxo.enums.AttachmentType[исходный код]#

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

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

TEXT = 'text'#
UNKNOWN = 'unknown'#
AUDIO = 'audio'#
CONTACT = 'contact'#
FILE = 'file'#
IMAGE = 'image'#
INLINE_KEYBOARD = 'inline_keyboard'#
LOCATION = 'location'#
SHARE = 'share'#
STICKER = 'sticker'#
VIDEO = 'video'#
DOCUMENT = 'file'#
PHOTO = 'image'#
__new__(value)#
class maxo.enums.ButtonType[исходный код]#

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

CALLBACK = 'callback'#
CLIPBOARD = 'clipboard'#
MESSAGE = 'message'#
OPEN_APP = 'open_app'#
REQUEST_CONTACT = 'request_contact'#
REQUEST_GEO_LOCATION = 'request_geo_location'#
__new__(value)#
class maxo.enums.ChatAdminPermission[исходный код]#

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

Права администратора группового чата или канала

ADD_ADMINS = 'add_admins'#
ADD_REMOVE_MEMBERS = 'add_remove_members'#
CAN_CALL = 'can_call'#
CHANGE_CHAT_INFO = 'change_chat_info'#
DELETE = 'delete'#
DELETE_MESSAGE = 'delete_message'#
EDIT = 'edit'#
EDIT_MESSAGE = 'edit_message'#
PIN_MESSAGE = 'pin_message'#
POST_EDIT_DELETE_MESSAGE = 'post_edit_delete_message'#
READ_ALL_MESSAGES = 'read_all_messages'#
WRITE = 'write'#
VIEW_STATS = 'view_stats'#
__new__(value)#
class maxo.enums.ChatStatus[исходный код]#

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

Статус чата для текущего бота

ACTIVE = 'active'#
CLOSED = 'closed'#
LEFT = 'left'#
REMOVED = 'removed'#
__new__(value)#
class maxo.enums.ChatType[исходный код]#

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

Тип чата: диалог, чат

CHANNEL = 'channel'#
CHAT = 'chat'#
DIALOG = 'dialog'#
PRIVATE = 'dialog'#
GROUP = 'chat'#
SUPERGROUP = 'chat'#
__new__(value)#
maxo.enums.ContentType#

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

class maxo.enums.MarkupElementType[исходный код]#

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

EMPHASIZED = 'emphasized'#
HEADING = 'heading'#
HIGHLIGHTED = 'highlighted'#
MONOSPACED = 'monospaced'#
QUOTE = 'quote'#
STRIKETHROUGH = 'strikethrough'#
STRONG = 'strong'#
UNDERLINE = 'underline'#
USER_MENTION = 'user_mention'#
__new__(value)#
class maxo.enums.MessageLinkType[исходный код]#

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

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

FORWARD = 'forward'#
REPLY = 'reply'#
__new__(value)#
maxo.enums.ParseMode#

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

class maxo.enums.SenderAction[исходный код]#

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

Действие, отправляемое участникам чата. Возможные значения:

  • "typing\_on" - Бот набирает сообщение

  • "sending\_photo" - Бот отправляет фото

  • "sending\_video" - Бот отправляет видео

  • "sending\_audio" - Бот отправляет аудиофайл

  • "sending\_file" - Бот отправляет файл

SENDING_AUDIO = 'sending_audio'#
SENDING_FILE = 'sending_file'#
SENDING_PHOTO = 'sending_photo'#
SENDING_VIDEO = 'sending_video'#
TYPING_ON = 'typing_on'#
MARK_SEEN = 'mark_seen'#
__new__(value)#
class maxo.enums.TextFormat[исходный код]#

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

Формат текста сообщения

HTML = 'html'#
MARKDOWN = 'markdown'#
__new__(value)#
class maxo.enums.UpdateType[исходный код]#

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

Объект Update описывает возможные события в чате или канале. Может возвращаться в следующих случаях:

  • Вы подписались на обновления через Webhook - при наступлении события МАКС пришлёт [POST-запрос /subscriptions](https://dev.max.ru/docs-api/methods/POST/subscriptions), который содержит объект Update

  • Вы отправили [GET-запрос /updates](https://dev.max.ru/docs-api/methods/GET/updates) для получения обновлений через Long Polling - в ответ вернётся объект Update

>! Получение обновлений с помощью [Long Polling](https://dev.max.ru/docs-api/methods/GET/updates) ограничено по скорости и сроку хранения событий - этот способ не подходит для production-окружения. Рекомендуем на всех этапах работы использовать [Webhook](https://dev.max.ru/docs-api/methods/POST/subscriptions)

Типы событий#

  • bot\_added - бот добавлен в чат или канал

  • bot\_started - пользователь впервые начал общение с ботом или возобновил после остановки - нажал соответствующую кнопку в настройках бота в МАКС

  • bot\_stopped - пользователь остановил или удалил бота через настройки бота в МАКС. Во втором случае одновременно с bot\_stopped возвращается событие dialog\_removed

  • bot\_removed - бот удалён из чата или канала

  • chat\_title\_changed - пользователь изменил название чата или канала

  • dialog\_cleared - пользователь очистил историю диалога с ботом

  • dialog\_muted - пользователь отключил уведомления в диалоге с ботом

  • dialog\_unmuted - пользователь включил уведомления в диалоге с ботом

  • dialog\_removed - пользователь удалил диалог с ботом. Вместе с этим событием одновременно возвращается bot\_stopped - при удалении диалога бот останавливается автоматически

  • message\_callback - пользователь нажал на кнопку в чате или канале

  • message\_created - пользователь отправил новое сообщение или опубликовал пост

  • message\_edited - пользователь отредактировал сообщение в чате или канале

  • message\_removed - пользователь удалил сообщение из чата или канала

  • user\_added - в чат или канал добавлен или перешёл по ссылке новый пользователь

  • user\_removed - пользователь удалён или покинул чат или канал

Свойства объекта Update#

BOT_ADDED = 'bot_added'#
BOT_REMOVED = 'bot_removed'#
BOT_STARTED = 'bot_started'#
BOT_STOPPED = 'bot_stopped'#
CHAT_TITLE_CHANGED = 'chat_title_changed'#
DIALOG_CLEARED = 'dialog_cleared'#
DIALOG_MUTED = 'dialog_muted'#
DIALOG_REMOVED = 'dialog_removed'#
DIALOG_UNMUTED = 'dialog_unmuted'#
MESSAGE_CALLBACK = 'message_callback'#
MESSAGE_CREATED = 'message_created'#
MESSAGE_EDITED = 'message_edited'#
MESSAGE_REMOVED = 'message_removed'#
USER_ADDED = 'user_added'#
USER_REMOVED = 'user_removed'#
__new__(value)#
class maxo.enums.UploadType[исходный код]#

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

Тип загружаемого медиафайла. Возможные значения и поддерживаемые форматы:

  • image - изображение (JPG, JPEG, PNG, GIF, TIFF, BMP, HEIC)<br/> **Максимальный размер** одного изображения: до 50 МБ или не более 7680 x 7680 px - должны выполняться оба критерия. Например, отправить изображение 55 МБ и 7600 x 7600 px нельзя

  • video - видеофайл (MP4, MOV, MKV, WEBM)<br/> **Максимальный размер** одного видео: до 250 МБ

  • audio - аудиофайл (MP3, WAV, M4A и другие)<br/>**Максимальный размер** одного аудио: до 256 МБ или длительностью не более 60 мин - должны выполняться оба критерия. Например, отправить аудио размером 250 МБ и длительностью 70 минут нельзя

  • file - файл, поддерживаются распространённые форматы (например, TXT, DOC и другие) <br/>**Максимальный размер** одного файла: до 4 ГБ

При передаче неподдерживаемого типа файла вернётся ошибка File extension is forbidden

> Значение photo больше не поддерживается. Если вы использовали type=photo в ранее созданных интеграциях - замените его на type=image

AUDIO = 'audio'#
FILE = 'file'#
IMAGE = 'image'#
VIDEO = 'video'#
__new__(value)#