mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-15 20:02:22 +00:00
153 lines
9.8 KiB
JSON
153 lines
9.8 KiB
JSON
{
|
|
"meta": {},
|
|
"group": {
|
|
"title": "Available methods",
|
|
"anchor": "available-methods"
|
|
},
|
|
"object": {
|
|
"anchor": "sendphoto",
|
|
"name": "sendPhoto",
|
|
"description": "Use this method to send photos. On success, the sent Message is returned.",
|
|
"html_description": "<p>Use this method to send photos. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
|
|
"rst_description": "Use this method to send photos. On success, the sent :class:`aiogram.types.message.Message` is returned.",
|
|
"annotations": [
|
|
{
|
|
"type": "String",
|
|
"required": false,
|
|
"description": "Unique identifier of the business connection on behalf of which the message will be sent",
|
|
"html_description": "<td>Unique identifier of the business connection on behalf of which the message will be sent</td>",
|
|
"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": "<td>Unique identifier for the target chat or username of the target channel (in the format <code>@channelusername</code>)</td>",
|
|
"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": "<td>Unique identifier for the target message thread (topic) of the forum; for forum supergroups only</td>",
|
|
"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": "Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. More information on Sending Files",
|
|
"html_description": "<td>Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. <a href=\"#sending-files\">More information on Sending Files »</a></td>",
|
|
"rst_description": "Photo to send. Pass a file_id as String to send a photo that exists on the Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get a photo from the Internet, or upload a new photo using multipart/form-data. The photo must be at most 10 MB in size. The photo's width and height must not exceed 10000 in total. Width and height ratio must be at most 20. :ref:`More information on Sending Files » <sending-files>`\n",
|
|
"name": "photo"
|
|
},
|
|
{
|
|
"type": "String",
|
|
"required": false,
|
|
"description": "Photo caption (may also be used when resending photos by file_id), 0-1024 characters after entities parsing",
|
|
"html_description": "<td>Photo caption (may also be used when resending photos by <em>file_id</em>), 0-1024 characters after entities parsing</td>",
|
|
"rst_description": "Photo caption (may also be used when resending photos by *file_id*), 0-1024 characters after entities parsing\n",
|
|
"name": "caption"
|
|
},
|
|
{
|
|
"type": "String",
|
|
"required": false,
|
|
"description": "Mode for parsing entities in the photo caption. See formatting options for more details.",
|
|
"html_description": "<td>Mode for parsing entities in the photo caption. See <a href=\"#formatting-options\">formatting options</a> for more details.</td>",
|
|
"rst_description": "Mode for parsing entities in the photo caption. See `formatting options <https://core.telegram.org/bots/api#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": "<td>A JSON-serialized list of special entities that appear in the caption, which can be specified instead of <em>parse_mode</em></td>",
|
|
"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": "Pass True, if the caption must be shown above the message media",
|
|
"html_description": "<td>Pass <em>True</em>, if the caption must be shown above the message media</td>",
|
|
"rst_description": "Pass :code:`True`, if the caption must be shown above the message media\n",
|
|
"name": "show_caption_above_media"
|
|
},
|
|
{
|
|
"type": "Boolean",
|
|
"required": false,
|
|
"description": "Pass True if the photo needs to be covered with a spoiler animation",
|
|
"html_description": "<td>Pass <em>True</em> if the photo needs to be covered with a spoiler animation</td>",
|
|
"rst_description": "Pass :code:`True` if the photo needs to be covered with a spoiler animation\n",
|
|
"name": "has_spoiler"
|
|
},
|
|
{
|
|
"type": "Boolean",
|
|
"required": false,
|
|
"description": "Sends the message silently. Users will receive a notification with no sound.",
|
|
"html_description": "<td>Sends the message <a href=\"https://telegram.org/blog/channels-2-0#silent-messages\">silently</a>. Users will receive a notification with no sound.</td>",
|
|
"rst_description": "Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. 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": "<td>Protects the contents of the sent message from forwarding and saving</td>",
|
|
"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": "<td>Unique identifier of the message effect to be added to the message; for private chats only</td>",
|
|
"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": "<td>Description of the message to reply to</td>",
|
|
"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": "<td>Additional interface options. A JSON-serialized object for an <a href=\"/bots/features#inline-keyboards\">inline keyboard</a>, <a href=\"/bots/features#keyboards\">custom reply keyboard</a>, instructions to remove a reply keyboard or to force a reply from the user</td>",
|
|
"rst_description": "Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, 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": "<td>Pass <em>True</em> if the message should be sent even if the specified replied-to message is not found</td>",
|
|
"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": "<td>If the message is a reply, ID of the original message</td>",
|
|
"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"
|
|
}
|
|
}
|