send_animation()

Client.send_animation()

Send animation files (animation or H.264/MPEG-4 AVC video without sound).

Usable by Users Bots
Parameters:

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str). You can also use chat public link in form of t.me/<username> (str).

  • animation (str | BinaryIO) – Animation to send. Pass a file_id as string to send an animation that exists on the Telegram servers, pass an HTTP URL as a string for Telegram to get an animation from the Internet, pass a file path as string to upload a new animation that exists on your local machine, or pass a binary file-like object with its attribute “.name” set for in-memory uploads.

  • caption (str, optional) – Animation caption, 0-1024 characters.

  • unsave (bool, optional) – By default, the server will save into your own collection any new animation you send. Pass True to automatically unsave the sent animation. Defaults to False.

  • parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • caption_entities (List of MessageEntity) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

  • has_spoiler (bool, optional) – Pass True if the animation needs to be covered with a spoiler animation.

  • duration (int, optional) – Duration of sent animation in seconds.

  • width (int, optional) – Animation width.

  • height (int, optional) – Animation height.

  • thumb (str | BinaryIO, optional) – Thumbnail of the animation file sent. The thumbnail should be in JPEG format and less than 200 KB in size. A thumbnail’s width and height should not exceed 320 pixels. Thumbnails can’t be reused and can be only uploaded as a new file.

  • file_name (str, optional) – File name of the animation sent. Defaults to file’s path basename.

  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.

  • message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum. for forum supergroups only.

  • business_connection_id (str, optional) – Unique identifier for the target business connection. for business bots only.

  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.

  • reply_to_story_id (int, optional) – Unique identifier for the target story.

  • reply_to_chat_id (int | str, optional) – Unique identifier for the origin chat. for reply to message from another chat. You can also use chat public link in form of t.me/<username> (str).

  • quote_text (str, optional) – Text to quote. for reply_to_message only.

  • quote_entities (List of MessageEntity, optional) – List of special entities that appear in quote_text, which can be specified instead of parse_mode. for reply_to_message only.

  • message_effect_id (int 64-bit, optional) – Unique identifier of the message effect to be added to the message; for private chats only.

  • schedule_date (datetime, optional) – Date when the message will be automatically sent.

  • protect_content (bool, optional) – Protects the contents of the sent message from forwarding and saving.

  • invert_media (bool, optional) – Inverts the position of the animation and caption.

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • progress (Callable, optional) – Pass a callback function to view the file transmission progress. The function must take (current, total) as positional arguments (look at Other Parameters below for a detailed description) and will be called back each time a new file chunk has been successfully transmitted.

  • progress_args (tuple, optional) – Extra custom arguments for the progress callback function. You can pass anything you need to be available in the progress callback scope; for example, a Message object or a Client instance in order to edit the message with the updated progress status.

Other Parameters:

  • current (int) – The amount of bytes transmitted so far.

  • total (int) – The total size of the file.

  • *args (tuple, optional) – Extra custom arguments as defined in the progress_args parameter. You can either keep *args or add every single extra argument in your function signature.

Returns:

Message | None – On success, the sent animation message is returned, otherwise, in case the upload is deliberately stopped with stop_transmission(), None is returned.

Example

# Send animation by uploading from local file
await app.send_animation("me", "animation.gif")

# Add caption to the animation
await app.send_animation("me", "animation.gif", caption="animation caption")

# Unsave the animation once is sent
await app.send_animation("me", "animation.gif", unsave=True)

# Keep track of the progress while uploading
async def progress(current, total):
    print(f"{current * 100 / total:.1f}%")

await app.send_animation("me", "animation.gif", progress=progress)