telegram.Document

class telegram.Document(*args, **kwargs)[source]

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.

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.

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

  • bot (telegram.Bot, optional) – The Bot to use for instance methods.

  • **kwargs (dict) – Arbitrary keyword arguments.

file_id[source]

File identifier.

Type

str

file_unique_id[source]

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

thumb[source]

Optional. Document thumbnail.

Type

telegram.PhotoSize

file_name[source]

Original filename.

Type

str

mime_type[source]

Optional. MIME type of the file.

Type

str

file_size[source]

Optional. File size in bytes.

Type

int

bot[source]

Optional. The Bot to use for instance methods.

Type

telegram.Bot

classmethod de_json(data, bot)[source]

See telegram.TelegramObject.de_json().

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

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