Document

class telegram.Document(file_id, file_unique_id, thumb=None, file_name=None, mime_type=None, file_size=None, thumbnail=None, *, api_kwargs=None)

Bases: telegram.TelegramObject

This object represents a general file (as opposed to photos, voice messages and audio files).

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their file_unique_id is equal.

Use In

• telegram.Bot.get_file()

• telegram.Bot.send_document()

Available In

telegram.Message.document

Parameters:

• file_id (str) – Identifier for this file, which can be used to download or reuse the file.

• file_unique_id (str) – Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

• thumb (telegram.PhotoSize, optional) –

  Document thumbnail as defined by sender.

  Deprecated since version 20.2: As of Bot API 6.6 this argument is deprecated in favor of thumbnail.

• file_name (str, optional) – Original filename as defined by sender.

• mime_type (str, optional) – MIME type of the file as defined by sender.

• file_size (int, optional) – File size in bytes.

• thumbnail (telegram.PhotoSize, optional) –

  Document thumbnail as defined by sender.

  New in version 20.2.

file_id

Identifier for this file, which can be used to download or reuse the file.

Type:

str

file_unique_id

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can’t be used to download or reuse the file.

Type:

str

file_name

Optional. Original filename as defined by sender.

Type:

str

mime_type

Optional. MIME type of the file as defined by sender.

Type:

str

file_size

Optional. File size in bytes.

Type:

int

thumbnail

Optional. Document thumbnail as defined by sender.

New in version 20.2.

Type:

telegram.PhotoSize

classmethod de_json(data, bot)

See telegram.TelegramObject.de_json().

async get_file(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)

Convenience wrapper over telegram.Bot.get_file()

For the documentation of the arguments, please see telegram.Bot.get_file().

Returns:

telegram.File

Raises:

telegram.error.TelegramError –

property thumb

Optional. Thumbnail as defined by sender.

Deprecated since version 20.2: As of Bot API 6.6 this attribute is deprecated in favor of thumbnail.

Type:

telegram.PhotoSize