peyk.platforms.telegram.methods.send_document

async peyk.platforms.telegram.methods.send_document(self, chat_id: int | str, document: str | bytes | FilePayload, *, caption: str | None = None, parse_mode: str | None = None, caption_entities: Sequence[MessageEntity | Mapping[str, object]] | None = None, thumbnail: str | bytes | FilePayload | None = None, disable_content_type_detection: bool | None = None, message_thread_id: int | None = None, disable_notification: bool | None = None, protect_content: bool | None = None, reply_parameters: ReplyParameters | Mapping[str, object] | None = None, reply_markup: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Mapping[str, object] | None = None) → Message[source]

Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

Parameters:

  • chat_id – Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username

  • document – File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files

  • caption – Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing

  • parse_mode – Mode for parsing entities in the document caption. See formatting options for more details.

  • caption_entities – A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode

  • thumbnail – Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail’s width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new file, so you can pass ‘attach://’ if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files

  • disable_content_type_detection – Disables automatic server-side content type detection for files uploaded using multipart/form-data

  • message_thread_id – 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

  • disable_notification – Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • reply_parameters – Description of the message to reply to

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

Returns:

Result returned by Telegram on successful execution.

Return type:

Message