MessageCallback¶
Message
¶
Bases: BaseModel, BotMixin, PeerShortcutMixin, ChatActionShortcutMixin
Модель сообщения.
Attributes:
| Name | Type | Description |
|---|---|---|
sender |
User | None
|
Отправитель сообщения, может быть None, если сообщение отправлено каналом https://github.com/love-apples/maxapi/discussions/14. |
recipient |
Recipient
|
Получатель сообщения. |
timestamp |
int
|
Временная метка сообщения. |
link |
LinkedMessage | None
|
Связанное сообщение. Может быть None. |
body |
MessageBody | None
|
Содержимое сообщения. Текст + вложения. Может быть None, если сообщение содержит только пересланное сообщение |
stat |
MessageStat | None
|
Статистика сообщения. Может быть None. |
url |
str | None
|
URL сообщения. Может быть None. |
bot |
Any | None
|
Объект бота, исключается из сериализации. |
url
property
¶
Прямая ссылка на сообщение в интерфейсе MAX.
Для каналов возвращается ссылка, полученная от API. Для диалогов и
групповых чатов ссылка строится из body.mid.
answer(text=None, attachments=None, link=None, format=None, parse_mode=None, *, notify=None, disable_link_preview=None, sleep_after_input_media=True)
async
¶
Отправляет сообщение (автозаполнение chat_id, user_id).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str | None
|
Текст ответа. Может быть None. |
None
|
attachments
|
list[Attachment | InputMedia | InputMediaBuffer | AttachmentUpload] | None
|
Список вложений. Может быть None. |
None
|
link
|
NewMessageLink | None
|
Связь с другим сообщением. Может быть None. |
None
|
format
|
TextFormat | None
|
Режим форматирования текста. Может быть None. |
None
|
parse_mode
|
ParseMode | None
|
Режим форматирования текста. Может быть None. |
None
|
notify
|
bool | None
|
Флаг отправки уведомления. По умолчанию True. |
None
|
disable_link_preview
|
bool | None
|
Флаг генерации превью. |
None
|
sleep_after_input_media
|
bool | None
|
Флаг задержки после отправки вложений типа InputMedia. По умолчанию True. |
True
|
Returns:
| Type | Description |
|---|---|
SendedMessage | None
|
Optional[SendedMessage]: Результат выполнения метода send_message бота. |
Source code in maxapi/types/message.py
reply(text=None, attachments=None, format=None, parse_mode=None, *, notify=None, disable_link_preview=None, sleep_after_input_media=True)
async
¶
Отправляет ответное сообщение (автозаполнение chat_id, user_id, link).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str | None
|
Текст ответа. Может быть None. |
None
|
attachments
|
list[Attachment | InputMedia | InputMediaBuffer | AttachmentUpload] | None
|
Список вложений. Может быть None. |
None
|
notify
|
bool | None
|
Флаг отправки уведомления. По умолчанию True. |
None
|
format
|
TextFormat | None
|
Режим форматирования текста. Может быть None. |
None
|
parse_mode
|
ParseMode | None
|
Режим форматирования текста. Может быть None. |
None
|
disable_link_preview
|
bool | None
|
Флаг генерации превью. |
None
|
sleep_after_input_media
|
bool | None
|
Флаг задержки после отправки вложений типа InputMedia. По умолчанию True. |
True
|
Returns:
| Type | Description |
|---|---|
SendedMessage | None
|
Optional[SendedMessage]: Результат выполнения метода send_message бота. |
Source code in maxapi/types/message.py
forward(chat_id, user_id=None, attachments=None, format=None, parse_mode=None, *, notify=None, disable_link_preview=None, sleep_after_input_media=True)
async
¶
Пересылает отправленное сообщение в указанный чат. (автозаполнение link)
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
chat_id
|
int | None
|
ID чата для отправки (обязателен, если не указан user_id) |
required |
user_id
|
int | None
|
ID пользователя для отправки (обязателен, если не указан chat_id). По умолчанию None |
None
|
attachments
|
list[Attachment | InputMedia | InputMediaBuffer | AttachmentUpload] | None
|
Список вложений. Может быть None. |
None
|
notify
|
bool | None
|
Флаг отправки уведомления. По умолчанию True. |
None
|
format
|
TextFormat | None
|
Режим форматирования текста. Может быть None. |
None
|
parse_mode
|
ParseMode | None
|
Режим форматирования текста. Может быть None. |
None
|
disable_link_preview
|
bool | None
|
Флаг генерации превью. |
None
|
sleep_after_input_media
|
bool | None
|
Флаг задержки после отправки вложений типа InputMedia. По умолчанию True. |
True
|
Returns:
| Type | Description |
|---|---|
SendedMessage | None
|
Optional[SendedMessage]: Результат выполнения метода send_message бота. |
Source code in maxapi/types/message.py
edit(text=None, attachments=None, link=None, format=None, parse_mode=None, *, notify=True, sleep_after_input_media=True)
async
¶
Редактирует текущее сообщение.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str | None
|
Новый текст сообщения. Может быть None. |
None
|
attachments
|
list[Attachment | InputMedia | InputMediaBuffer | AttachmentUpload] | list[Attachments] | None
|
Новые вложения. Может быть None. |
None
|
link
|
NewMessageLink | None
|
Новая связь с сообщением. Может быть None. |
None
|
format
|
TextFormat | None
|
Режим форматирования текста. Может быть None. |
None
|
parse_mode
|
ParseMode | None
|
Режим форматирования текста. Может быть None. |
None
|
notify
|
bool
|
Флаг отправки уведомления. По умолчанию True. |
True
|
sleep_after_input_media
|
bool | None
|
Флаг задержки после отправки вложений типа InputMedia. По умолчанию True. |
True
|
Returns: Optional[EditedMessage]: Результат выполнения метода edit_message бота.
Source code in maxapi/types/message.py
delete()
async
¶
Удаляет текущее сообщение.
Returns:
| Name | Type | Description |
|---|---|---|
DeletedMessage |
DeletedMessage
|
Результат выполнения метода delete_message бота. |
Source code in maxapi/types/message.py
pin(*, notify=True)
async
¶
Закрепляет текущее сообщение в чате.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
notify
|
bool
|
Флаг отправки уведомления. По умолчанию True. |
True
|
Returns:
| Name | Type | Description |
|---|---|---|
PinnedMessage |
PinnedMessage
|
Результат выполнения метода pin_message бота. |
Source code in maxapi/types/message.py
unpin()
async
¶
Снимает закрепленное сообщение в чате текущего сообщения.
Returns:
| Name | Type | Description |
|---|---|---|
DeletedPinMessage |
DeletedPinMessage
|
Результат выполнения метода delete_pin_message. |
Source code in maxapi/types/message.py
MessageForCallback
¶
Bases: BaseModel
Модель сообщения для ответа на callback-запрос.
Attributes:
| Name | Type | Description |
|---|---|---|
text |
str | None
|
Текст сообщения. |
attachments |
list[AttachmentInput] | None
|
Список вложений. None означает, что поле не будет отправлено в callback-ответе; пустой список очищает вложения. |
link |
NewMessageLink | None
|
Связь с другим сообщением. |
notify |
bool | None
|
Отправлять ли уведомление. |
format |
ParseMode | None
|
Режим разбора текста. |
MessageCallback
¶
Bases: BaseUpdate
Обновление с callback-событием сообщения.
Attributes:
| Name | Type | Description |
|---|---|---|
message |
Message | None
|
Изначальное сообщение, содержащее встроенную клавиатуру. Может быть None, если оно было удалено к моменту, когда бот получил это обновление. |
user_locale |
str | None
|
Локаль пользователя. |
callback |
Callback
|
Объект callback. |
get_ids()
¶
Возвращает кортеж идентификаторов (chat_id, user_id).
Returns:
| Type | Description |
|---|---|
tuple[int | None, int]
|
tuple[Optional[int], int]: Идентификаторы чата и пользователя. |
Source code in maxapi/types/updates/message_callback.py
ack(notification=None)
async
¶
Подтвердить callback без изменения исходного сообщения.
Source code in maxapi/types/updates/message_callback.py
defer(notification=None)
async
¶
edit(text=None, attachments=None, link=None, format=None, *, notification=None, notify=True, raise_if_not_exists=True)
async
¶
Изменить сообщение, связанное с callback.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
text
|
str | None
|
Новый текст сообщения. |
None
|
attachments
|
Sequence[AttachmentInput] | None
|
Вложения для сообщения. None сохраняет вложения исходного сообщения, пустой список очищает их, непустой список заменяет существующие вложения. |
None
|
link
|
NewMessageLink | None
|
Связь с другим сообщением. |
None
|
format
|
ParseMode | None
|
Режим разбора текста. |
None
|
notification
|
str | None
|
Текст уведомления. |
None
|
notify
|
bool
|
Отправлять ли уведомление. |
True
|
raise_if_not_exists
|
bool
|
Выдавать ошибку при отсутствии сообщения, если пытаются изменить его содержимое. |
True
|
Returns:
| Name | Type | Description |
|---|---|---|
SendedCallback |
SendedCallback
|
Результат вызова send_callback бота. |
Source code in maxapi/types/updates/message_callback.py
send(text=None, attachments=None, link=None, format=None, parse_mode=None, *, notify=None, disable_link_preview=None, sleep_after_input_media=True)
async
¶
Отправить новое сообщение в тот же peer, откуда пришел callback.
Source code in maxapi/types/updates/message_callback.py
reply(text=None, attachments=None, format=None, parse_mode=None, *, notify=None, disable_link_preview=None, sleep_after_input_media=True)
async
¶
Отправить reply на исходное сообщение callback.
Source code in maxapi/types/updates/message_callback.py
delete()
async
¶
pin(*, notify=True)
async
¶
unpin()
async
¶
answer(notification=None, new_text=None, attachments=None, link=None, format=None, *, notify=True, raise_if_not_exists=True)
async
¶
Отправляет ответ на callback с возможностью изменить текст и параметры уведомления.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
notification
|
str | None
|
Текст уведомления. |
None
|
new_text
|
str | None
|
Новый текст сообщения. |
None
|
attachments
|
Sequence[AttachmentInput] | None
|
Вложения для сообщения. None сохраняет вложения исходного сообщения, пустой список очищает их, непустой список заменяет существующие вложения. |
None
|
link
|
NewMessageLink | None
|
Связь с другим сообщением. |
None
|
notify
|
bool
|
Отправлять ли уведомление. |
True
|
format
|
ParseMode | None
|
Режим разбора текста. |
None
|
raise_if_not_exists
|
bool
|
Выдавать ошибку при отсутствии сообщения, если пытаются изменить его содержимое (new_text/link/format). |
True
|
Returns:
| Name | Type | Description |
|---|---|---|
SendedCallback |
SendedCallback
|
Результат вызова send_callback бота. |