telegram.InlineQueryResultDocument

class telegram.InlineQueryResultDocument(id, document_url, title, mime_type, caption=None, description=None, reply_markup=None, input_message_content=None, thumb_url=None, thumb_width=None, thumb_height=None, parse_mode=None, caption_entities=None, **_kwargs)

Bases: telegram.inline.inlinequeryresult.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.

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) – Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.

  • caption_entities (List[telegram.MessageEntity], optional) – List of special entities that appear in the caption, which can be specified instead of parse_mode.

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

  • thumb_url (str, optional) – URL of the thumbnail (jpeg only) for the file.

  • thumb_width (int, optional) – Thumbnail width.

  • thumb_height (int, optional) – Thumbnail height.

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

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. Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or inline URLs in the media caption. See the constants in telegram.ParseMode for the available modes.

Type

str

caption_entities

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

Type

List[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

thumb_url

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

Type

str

thumb_width

Optional. Thumbnail width.

Type

int

thumb_height

Optional. Thumbnail height.

Type

int