sendChatAction#

Returns: bool

class aiogram.methods.send_chat_action.SendChatAction(*, chat_id: int | str, action: str, message_thread_id: int | None = None, **extra_data: Any)[source]#

Use this method when you need to tell the user that something is happening on the bot’s side. The status is set for 5 seconds or less (when a message arrives from your bot, Telegram clients clear its typing status). Returns True on success.

Example: The ImageBot needs some time to process a request and upload the image. Instead of sending a text message along the lines of „Retrieving image, please wait…“, the bot may use aiogram.methods.send_chat_action.SendChatAction with action = upload_photo. The user will see a „sending photo“ status for the bot.

We only recommend using this method when a response from the bot will take a noticeable amount of time to arrive.

Source: https://core.telegram.org/bots/api#sendchataction

chat_id: int | str#

Unique identifier for the target chat or username of the target channel (in the format @channelusername)

action: str#

Type of action to broadcast. Choose one, depending on what the user is about to receive: typing for text messages, upload_photo for photos, record_video or upload_video for videos, record_voice or upload_voice for voice notes, upload_document for general files, choose_sticker for stickers, find_location for location data, record_video_note or upload_video_note for video notes.

model_computed_fields: ClassVar[dict[str, ComputedFieldInfo]] = {}#

A dictionary of computed field names and their corresponding ComputedFieldInfo objects.

message_thread_id: int | None#

Unique identifier for the target message thread; supergroups only

Usage#

As bot method#

result: bool = await bot.send_chat_action(...)

Method as object#

Imports:

  • from aiogram.methods.send_chat_action import SendChatAction

  • alias: from aiogram.methods import SendChatAction

With specific bot#

result: bool = await bot(SendChatAction(...))

As reply into Webhook in handler#

return SendChatAction(...)

As shortcut from received object#