telegram.InputMediaDocument

class telegram.InputMediaDocument(media, thumb=None, caption=None, parse_mode=None, disable_content_type_detection=None, caption_entities=None, filename=None)

Bases: telegram.files.inputmedia.InputMedia

Represents a general file to be sent.

Parameters

  • media (str | filelike object | bytes | pathlib.Path | telegram.Document) –

    File to send. Pass a file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP URL for Telegram to get a file from the Internet. Lastly you can pass an existing telegram.Document object to send.

    Changed in version 13.2: Accept bytes as input.

  • filename (str, optional) –

    Custom file name for the document, when uploading a new file. Convenience parameter, useful e.g. when sending files generated by the tempfile module.

    New in version 13.1.

  • caption (str, optional) – Caption of the document to be sent, 0-1024 characters after entities parsing.

  • parse_mode (str, optional) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.

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

  • thumb (filelike object | bytes | pathlib.Path, optional) –

    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.

    Changed in version 13.2: Accept bytes as input.

  • disable_content_type_detection (bool, optional) – Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album.

type

document.

Type

str

media

File to send.

Type

str | telegram.InputFile

caption

Optional. Caption of the document to be sent.

Type

str

parse_mode

Optional. The parse mode to use for text formatting.

Type

str

caption_entities

Optional. List of special entities that appear in the caption.

Type

List[telegram.MessageEntity]

thumb

Optional. Thumbnail of the file to send.

Type

telegram.InputFile

disable_content_type_detection

Optional. Disables automatic server-side content type detection for files uploaded using multipart/form-data. Always true, if the document is sent as part of an album.

Type

bool