send_document()

async Client.send_document()

Send generic files.

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

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

  • caption (str, optional) – Document 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.

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

  • force_document (bool, optional) – Pass True to force sending files as document. Useful for video files that need to be sent as document messages instead of video messages. Defaults to False.

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

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

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

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

  • ephemeral_message_parameters (EphemeralMessageParameters, optional) – Send the message as an ephemeral message, visible only to the user it names and absent from the chat’s history, rather than as an ordinary one. The ephemeral RPC has no field for silent, background, clear_draft, schedule_date, repeat_period, send_as, effect_id, quick_reply_shortcut, allow_paid_broadcast, paid_message_star_count, suggested_post_parameters or update_stickersets_order; any of those that is set is logged and dropped.

  • reply_to_chat_id (int | str, optional) – Unique identifier for the chat to which the replied message belongs. Only applicable in combination with reply_to_message_id.

  • message_thread_id (int, optional) – Unique identifier for a message thread in a forum topic.

  • 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 effect to apply to the message.

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

  • repeat_period (int, optional) – New period in seconds for the message to be sent repeatedly.

  • business_connection_id (str, optional) – Unique identifier of the business connection.

  • 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) – Parameters of the suggested post.

  • quote_text (str, optional) – Text of the quote to reply to.

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

  • background (bool, optional) – Send the message in background.

  • clear_draft (bool, optional) – Clear the draft of the chat.

  • update_stickersets_order (bool, optional) – Move the sticker set to the top of the list.

  • send_as (int | str, optional) – Unique identifier (int) or username (str) of the chat or channel to send the message as.

  • quick_reply_shortcut (int, optional) – Unique identifier of the quick reply shortcut the message belongs to.

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

Example

# Send document by uploading from local file
await app.send_document("me", "document.zip")

# Add caption to the document file
await app.send_document("me", "document.zip", caption="document caption")

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

await app.send_document("me", "document.zip", progress=progress)