telegram.Document

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

Bases: telegram.base.TelegramObject

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

file_id

Unique file identifier.

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
thumb

Optional. Document thumbnail.

Type:telegram.PhotoSize
file_name

Original filename.

Type:str
mime_type

Optional. MIME type of the file.

Type:str
file_size

Optional. File size.

Type:int
bot

Optional. The Bot to use for instance methods.

Type:telegram.Bot
Parameters:
  • file_id (str) – Identifier for this file, which can be used to download or reuse the file.
  • file_unique_id (str) – Unique and the same over time and for different bots file identifier.
  • 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.
  • bot (telegram.Bot, optional) – The Bot to use for instance methods.
  • **kwargs (dict) – Arbitrary keyword arguments.
get_file(timeout=None, **kwargs)

Convenience wrapper over telegram.Bot.get_file

Parameters:
  • timeout (int | float, optional) – If this value is specified, use it as the read timeout from the server (instead of the one specified during creation of the connection pool).
  • **kwargs (dict) – Arbitrary keyword arguments.
Returns:

telegram.File

Raises:

telegram.TelegramError