Skip to content
Back to top
View this page

# Document

class telegram.Document(file_id, file_unique_id, 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.BackgroundTypePattern.document`

  - `telegram.BackgroundTypeWallpaper.document`

  - `telegram.ExternalReplyInfo.document`

  - `telegram.InputMediaDocument.media`

  - `telegram.Message.document`

  - `telegram.Message.effective_attachment`

  - `telegram.PollMedia.document`

  Changed in version 20.5: Removed the deprecated argument and attribute `thumb`.

  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.

    - file_name (`str`, optional) – Original filename as defined by the sender.

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

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

    - thumbnail (`telegram.PhotoSize`, optional) –

      Document thumbnail as defined by the sender.

      Added 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 the sender.

    Type:

      `str`

  mime_type

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

    Type:

      `str`

  file_size

    Optional. File size in bytes.

    Type:

      `int`

  thumbnail

    Optional. Document thumbnail as defined by the sender.

    Added in version 20.2.

    Type:

      `telegram.PhotoSize`

  classmethod de_json(data, bot=None)

    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 –