{ "meta": {}, "group": { "title": "Available methods", "anchor": "available-methods" }, "object": { "anchor": "senddocument", "name": "sendDocument", "description": "Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.", "html_description": "

Use this method to send general files. On success, the sent Message is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.

", "rst_description": "Use this method to send general files. On success, the sent :class:`aiogram.types.message.Message` is returned. Bots can currently send files of any type of up to 50 MB in size, this limit may be changed in the future.", "annotations": [ { "type": "String", "required": false, "description": "Unique identifier of the business connection on behalf of which the message will be sent", "html_description": "Unique identifier of the business connection on behalf of which the message will be sent", "rst_description": "Unique identifier of the business connection on behalf of which the message will be sent\n", "name": "business_connection_id" }, { "type": "Integer or String", "required": true, "description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)", "html_description": "Unique identifier for the target chat or username of the target channel (in the format @channelusername)", "rst_description": "Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)\n", "name": "chat_id" }, { "type": "Integer", "required": false, "description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only", "html_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only", "rst_description": "Unique identifier for the target message thread (topic) of the forum; for forum supergroups only\n", "name": "message_thread_id" }, { "type": "InputFile or String", "required": true, "description": "File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files", "html_description": "File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. More information on Sending Files »", "rst_description": "File to send. Pass a file_id as String to send a file that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a file from the Internet, or upload a new one using multipart/form-data. :ref:`More information on Sending Files » `\n", "name": "document" }, { "type": "InputFile or String", "required": false, "description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . More information on Sending Files", "html_description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass “attach://<file_attach_name>” if the thumbnail was uploaded using multipart/form-data under <file_attach_name>. More information on Sending Files »", "rst_description": "Thumbnail of the file sent; can be ignored if thumbnail generation for the file is supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size. A thumbnail's width and height should not exceed 320. Ignored if the file is not uploaded using multipart/form-data. Thumbnails can't be reused and can be only uploaded as a new file, so you can pass 'attach://' if the thumbnail was uploaded using multipart/form-data under . :ref:`More information on Sending Files » `\n", "name": "thumbnail" }, { "type": "String", "required": false, "description": "Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing", "html_description": "Document caption (may also be used when resending documents by file_id), 0-1024 characters after entities parsing", "rst_description": "Document caption (may also be used when resending documents by *file_id*), 0-1024 characters after entities parsing\n", "name": "caption" }, { "type": "String", "required": false, "description": "Mode for parsing entities in the document caption. See formatting options for more details.", "html_description": "Mode for parsing entities in the document caption. See formatting options for more details.", "rst_description": "Mode for parsing entities in the document caption. See `formatting options `_ for more details.\n", "name": "parse_mode" }, { "type": "Array of MessageEntity", "required": false, "description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode", "html_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of parse_mode", "rst_description": "A JSON-serialized list of special entities that appear in the caption, which can be specified instead of *parse_mode*\n", "name": "caption_entities" }, { "type": "Boolean", "required": false, "description": "Disables automatic server-side content type detection for files uploaded using multipart/form-data", "html_description": "Disables automatic server-side content type detection for files uploaded using multipart/form-data", "rst_description": "Disables automatic server-side content type detection for files uploaded using multipart/form-data\n", "name": "disable_content_type_detection" }, { "type": "Boolean", "required": false, "description": "Sends the message silently. Users will receive a notification with no sound.", "html_description": "Sends the message silently. Users will receive a notification with no sound.", "rst_description": "Sends the message `silently `_. Users will receive a notification with no sound.\n", "name": "disable_notification" }, { "type": "Boolean", "required": false, "description": "Protects the contents of the sent message from forwarding and saving", "html_description": "Protects the contents of the sent message from forwarding and saving", "rst_description": "Protects the contents of the sent message from forwarding and saving\n", "name": "protect_content" }, { "type": "String", "required": false, "description": "Unique identifier of the message effect to be added to the message; for private chats only", "html_description": "Unique identifier of the message effect to be added to the message; for private chats only", "rst_description": "Unique identifier of the message effect to be added to the message; for private chats only\n", "name": "message_effect_id" }, { "type": "ReplyParameters", "required": false, "description": "Description of the message to reply to", "html_description": "Description of the message to reply to", "rst_description": "Description of the message to reply to\n", "name": "reply_parameters" }, { "type": "InlineKeyboardMarkup or ReplyKeyboardMarkup or ReplyKeyboardRemove or ForceReply", "required": false, "description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user", "html_description": "Additional interface options. A JSON-serialized object for an inline keyboard, custom reply keyboard, instructions to remove a reply keyboard or to force a reply from the user", "rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard `_, `custom reply keyboard `_, instructions to remove a reply keyboard or to force a reply from the user\n", "name": "reply_markup" }, { "type": "Boolean", "required": false, "description": "Pass True if the message should be sent even if the specified replied-to message is not found", "html_description": "Pass True if the message should be sent even if the specified replied-to message is not found", "rst_description": "Pass :code:`True` if the message should be sent even if the specified replied-to message is not found\n", "name": "allow_sending_without_reply", "deprecated": { "version": "7.0", "release_date": "2023-12-29" } }, { "type": "Integer", "required": false, "description": "If the message is a reply, ID of the original message", "html_description": "If the message is a reply, ID of the original message", "rst_description": "If the message is a reply, ID of the original message\n", "name": "reply_to_message_id", "deprecated": { "version": "7.0", "release_date": "2023-12-29" } } ], "category": "methods" } }