Interface InlineQueryResultDocument

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.

Note: This will only work in Telegram versions released after 9 April, 2016. Older clients will ignore them.

interface InlineQueryResultDocument {
    caption?: string;
    caption_entities?: MessageEntity[];
    description?: string;
    document_url: string;
    id: string;
    input_message_content?: InputMessageContent;
    mime_type: "application/pdf" | "application/zip";
    parse_mode?: ParseMode;
    reply_markup?: InlineKeyboardMarkup;
    thumbnail_height?: number;
    thumbnail_url?: string;
    thumbnail_width?: number;
    title: string;
    type: "document";
}

Properties

caption?: string

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

caption_entities?: MessageEntity[]

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

description?: string

Short description of the result

document_url: string

A valid URL for the file

id: string

Unique identifier for this result, 1-64 bytes

input_message_content?: InputMessageContent

Content of the message to be sent instead of the file

mime_type: "application/pdf" | "application/zip"

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

parse_mode?: ParseMode

Mode for parsing entities in the document caption. See formatting options for more details.

reply_markup?: InlineKeyboardMarkup

Inline keyboard attached to the message

thumbnail_height?: number

Thumbnail height

thumbnail_url?: string

URL of the thumbnail (JPEG only) for the file

thumbnail_width?: number

Thumbnail width

title: string

Title for the result

type: "document"

Type of the result, must be document