InlineQueryResultDocument

class telegram.InlineQueryResultDocument(id, document_url, title, mime_type, caption=None, description=None, reply_markup=None, input_message_content=None, parse_mode=None, caption_entities=None, thumbnail_url=None, thumbnail_width=None, thumbnail_height=None, *, api_kwargs=None)

Bases: telegram.InlineQueryResult

Represents a link to a file. By default, this file will be sent by the user with an optional caption. Alternatively, you can use input_message_content to send a message with the specified content instead of the file. Currently, only .PDF and .ZIP files can be sent using this method.

See also

Working with Files and Media

Use In

• telegram.Bot.answer_inline_query()

• telegram.Bot.answer_web_app_query()

• telegram.Bot.save_prepared_inline_message()

Changed in version 20.5: Removed the deprecated arguments and attributes thumb_*.

Parameters:

• id (str) – Unique identifier for this result, 1- 64 Bytes.

• title (str) – Title for the result.

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

• parse_mode (str, optional) – Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

• caption_entities (Sequence[telegram.MessageEntity], optional) –

  Sequence of special entities that appear in the caption, which can be specified instead of parse_mode.

  Changed in version 20.0: Accepts any collections.abc.Sequence as input instead of just a list. The input is converted to a tuple.

• document_url (str) – A valid URL for the file.

• mime_type (str) – Mime type of the content of the file, either “application/pdf” or “application/zip”.

• description (str, optional) – Short description of the result.

• reply_markup (telegram.InlineKeyboardMarkup, optional) – Inline keyboard attached to the message.

• input_message_content (telegram.InputMessageContent, optional) – Content of the message to be sent instead of the file.

• thumbnail_url (str, optional) –

  URL of the thumbnail (JPEG only) for the file.

  Added in version 20.2.

• thumbnail_width (int, optional) –

  Thumbnail width.

  Added in version 20.2.

• thumbnail_height (int, optional) –

  Thumbnail height.

  Added in version 20.2.

type

'document'.

Type:

str

id

Unique identifier for this result, 1- 64 Bytes.

Type:

str

title

Title for the result.

Type:

str

caption

Optional. Caption of the document to be sent, 0-1024 characters after entities parsing.

Type:

str

parse_mode

Optional. Mode for parsing entities. See telegram.constants.ParseMode and formatting options for more details.

Type:

str

caption_entities

Optional. Tuple of special entities that appear in the caption, which can be specified instead of parse_mode.

Changed in version 20.0:

• This attribute is now an immutable tuple.

• This attribute is now always a tuple, that may be empty.

Type:

tuple[telegram.MessageEntity]

document_url

A valid URL for the file.

Type:

str

mime_type

Mime type of the content of the file, either “application/pdf” or “application/zip”.

Type:

str

description

Optional. Short description of the result.

Type:

str

reply_markup

Optional. Inline keyboard attached to the message.

Type:

telegram.InlineKeyboardMarkup

input_message_content

Optional. Content of the message to be sent instead of the file.

Type:

telegram.InputMessageContent

thumbnail_url

Optional. URL of the thumbnail (JPEG only) for the file.

Added in version 20.2.

Type:

str

thumbnail_width

Optional. Thumbnail width.

Added in version 20.2.

Type:

int

thumbnail_height

Optional. Thumbnail height.

Added in version 20.2.

Type:

int