send_video()

Client.send_video()

Send video files.

Note

Starting December 1, 2024 messages with video that are sent, copied or forwarded to groups and channels with a sufficiently large audience can be automatically scheduled by the server until the respective video is reencoded. Such messages will have scheduled property set and beware of using the correct message identifiers when using such Message objects.

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).

  • video (str | BinaryIO) – Video to send. Pass a file_id as string to send a video that exists on the Telegram servers, pass an HTTP URL as a string for Telegram to get a video from the Internet, pass a file path as string to upload a new video 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) – Video caption, 0-1024 characters.

  • 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 video needs to be covered with a spoiler animation.

  • ttl_seconds (int, optional) – Self-Destruct Timer. If you set a timer, the video will self-destruct in ttl_seconds seconds after it was viewed.

  • view_once (bool, optional) – Self-Destruct Timer. If True, the photo will self-destruct after it was viewed.

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

  • width (int, optional) – Video width.

  • height (int, optional) – Video height.

  • video_start_timestamp (int, optional) – Video startpoint, in seconds.

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

  • thumb (str | BinaryIO, optional) – Thumbnail of the video 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 video sent. Defaults to file’s path basename.

  • supports_streaming (bool, optional) – Pass True, if the uploaded video is suitable for streaming. Defaults to True.

  • 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 forums only.

  • direct_messages_topic_id (int, optional) – Unique identifier of the topic in a channel direct messages chat administered by the current user. For directs only only.

  • effect_id (int, optional) – Unique identifier of the message effect. For private chats only.

  • show_caption_above_media (bool, optional) – Pass True, if the caption must be shown above the message media.

  • reply_parameters (ReplyParameters, optional) – Describes reply parameters for the message that is being sent.

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

  • repeat_period (int, optional) – Period after which the message will be sent again in seconds.

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

  • no_sound (bool, optional) – Pass True, if the uploaded video is a video message with no sound. Doesn’t work for external links.

  • business_connection_id (str, optional) – Unique identifier of the business connection on behalf of which the message will be sent.

  • allow_paid_broadcast (bool, optional) – If True, you will be allowed to send 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. For bots only.

  • paid_message_star_count (int, optional) – The number of Telegram Stars the user agreed to pay to send the messages.

  • suggested_post_parameters (SuggestedPostParameters, optional) – Information about the suggested post.

  • 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 video message is returned, otherwise, in case the upload is deliberately stopped with stop_transmission(), None is returned.

Example

# Send video by uploading from local file
await app.send_video("me", "video.mp4")

# Add caption to the video
await app.send_video("me", "video.mp4", caption="video caption")

# Send self-destructing video
await app.send_video("me", "video.mp4", ttl_seconds=10)

# Send view-once video
await app.send_video("me", "video.mp4", view_once=True)

# Add video_cover to the video
await app.send_video(channel_id, "video.mp4", video_cover="photo.jpg")

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

await app.send_video("me", "video.mp4", progress=progress)