Тип данных InlineQueryResultDocument

Объект, представляющий ссылку на PDF или ZIP файл для отправки через встроенный запрос в Telegram.

Описание

Представляет ссылку на файл. По умолчанию этот файл будет отправлен пользователем с необязательной подписью. В качестве альтернативы можно использовать input_message_content для отправки сообщения с указанным содержимым вместо файла. В настоящее время только файлы .PDF и .ZIP могут быть отправлены с помощью этого метода.

Поле Тип Описание
type String Тип результата, должен быть document
id String Уникальный идентификатор этого результата, 1-64 байта
title String Заголовок результата
caption String Необязательно. Подпись к отправляемому документу, 0-1024 символа после обработки сущностей
parse_mode String Необязательно. Режим обработки сущностей в подписи документа. Подробнее см. параметры форматирования.
caption_entities Array of MessageEntity Необязательно. Список специальных сущностей, встречающихся в подписи, которые можно указать вместо parse_mode
document_url String Действительный URL-адрес файла
mime_type String MIME-тип содержимого файла: «application/pdf» или «application/zip»
description String Необязательно. Краткое описание результата
reply_markup InlineKeyboardMarkup Необязательно. Встроенная клавиатура, прикреплённая к сообщению
input_message_content InputMessageContent Необязательно. Содержимое сообщения, которое будет отправлено вместо файла
thumbnail_url String Необязательно. URL-адрес миниатюры (только JPEG) для файла
thumbnail_width Integer Необязательно. Ширина миниатюры
thumbnail_height Integer Необязательно. Высота миниатюры

Примеры

json

{
  "type": "document",
  "id": "unique_doc_123",
  "title": "Sample PDF Document",
  "caption": "This is a *sample* PDF file with **bold** text",
  "parse_mode": "MarkdownV2",
  "caption_entities": [
    {
      "type": "bold",
      "offset": 28,
      "length": 4
    }
  ],
  "document_url": "https://example.com/document.pdf",
  "mime_type": "application/pdf",
  "description": "A sample PDF document for demonstration",
  "reply_markup": {
    "inline_keyboard": [
      [
        {
          "text": "Open Document",
          "url": "https://example.com/document.pdf"
        },
        {
          "text": "Share",
          "callback_data": "share_document_123"
        }
      ]
    ]
  },
  "input_message_content": {
    "message_text": "Here's the document you requested: Sample PDF Document",
    "parse_mode": "HTML"
  },
  "thumbnail_url": "https://example.com/thumbnail.jpg",
  "thumbnail_width": 200,
  "thumbnail_height": 150
}

История изменений

  • API 5.0. Обновлен объект InlineQueryResultDocument: Добавлена возможность ручного указания текстовых сущностей
  • API 6.6. Обновлен объект InlineQueryResultDocument: Переименованы поля thumb_url, thumb_width, thumb_height в thumbnail_url, thumbnail_width, thumbnail_height

Дополнительно

  • MessageEntity - Объект MessageEntity представляет специальную форматированную сущность в тексте сообщения, такую как упоминания, хэштеги, ссылки или стилизованный текст.
  • InlineKeyboardMarkup - Объект для создания встроенной клавиатуры, которая отображается непосредственно в сообщении.
  • InputMessageContent - Объект, представляющий содержимое сообщения для отправки через инлайн-запрос, поддерживающий пять различных типов контента.
Комментарии