sendWidget¶
Returns: Message
- class aiogram.methods.send_widget.SendWidget(*, chat_id: int | str, html: str, message_thread_id: int | None = None, width: int | None = None, height: int | None = None, public_data: str | None = None, chat_data: str | None = None, caption: str | None = None, parse_mode: str | ~aiogram.client.default.Default | None = <Default('parse_mode')>, caption_entities: list[~aiogram.types.message_entity.MessageEntity] | None = None, show_caption_above_media: bool | ~aiogram.client.default.Default | None = <Default('show_caption_above_media')>, allow_queries: bool | None = None, is_shared: bool | None = None, disable_notification: bool | None = None, protect_content: bool | ~aiogram.client.default.Default | None = <Default('protect_content')>, allow_paid_broadcast: bool | None = None, message_effect_id: str | None = None, reply_parameters: ~aiogram.types.reply_parameters.ReplyParameters | None = None, reply_markup: ~aiogram.types.inline_keyboard_markup.InlineKeyboardMarkup | ~aiogram.types.reply_keyboard_markup.ReplyKeyboardMarkup | ~aiogram.types.reply_keyboard_remove.ReplyKeyboardRemove | ~aiogram.types.force_reply.ForceReply | None = None, **extra_data: ~typing.Any)[source]¶
Use this method to send a message with an HTML widget. Currently, in the production environment, widgets can be sent only to private chats, and sent widgets automatically have protected content and therefore can’t be forwarded. On success, the sent
aiogram.types.message.Messageis returned.Source: https://core.telegram.org/bots/api#sendwidget
- chat_id: int | str¶
Unique identifier for the target chat or username of the target supergroup in the format
@username
- html: str¶
HTML code of the widget, 1-32768 bytes. The code must not exceed 4096 bytes when compressed by zlib with the maximum compression level
- message_thread_id: int | None¶
Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
- width: int | None¶
Width of the widget in logical pixels; omit if the widget must occupy the whole width of the message bubble. The width is clamped by the app to the range from 200 to the maximum width of the message bubble
- height: int | None¶
Height of the widget in logical pixels; omit if the height of the widget isn’t fixed. The height is clamped by the app to the range 50-600
- public_data: str | None¶
Public data of the widget, 0-1024 bytes, which will be available wherever the widget is shown. If the widget is shared, then all messages with it will have the same public data
- chat_data: str | None¶
Data of the widget, which is specific to the message, 0-1024 bytes
- caption: str | None¶
Widget caption, 0-1024 characters after entities parsing
- parse_mode: str | Default | None¶
Mode for parsing entities in the widget caption. See formatting options for more details
- caption_entities: list[MessageEntity] | None¶
A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode
- show_caption_above_media: bool | Default | None¶
Pass
Trueif the caption must be shown above the widget
- allow_queries: bool | None¶
Pass
Trueto allow the widget to send queries to the bot
Pass
Trueto create a shared widget, which can be sent again using the methodaiogram.methods.send_shared_widget.SendSharedWidget
- disable_notification: bool | None¶
Sends the message silently. Users will receive a notification with no sound
- protect_content: bool | Default | None¶
Protects the contents of the sent message from forwarding and saving
- allow_paid_broadcast: bool | None¶
Pass
Trueto allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot’s balance
- message_effect_id: str | None¶
Unique identifier of the message effect to be added to the message; for private chats only
- reply_parameters: ReplyParameters | None¶
Description of the message to reply to
- reply_markup: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | None¶
Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user
Usage¶
As bot method¶
result: Message = await bot.send_widget(...)
Method as object¶
Imports:
from aiogram.methods.send_widget import SendWidgetalias:
from aiogram.methods import SendWidget
With specific bot¶
result: Message = await bot(SendWidget(...))
As reply into Webhook in handler¶
return SendWidget(...)