aiogram/.butcher/methods/sendMediaGroup/entity.json
Alex Root Junior ab8af773cf
Added full support for the Bot API 9.2 (#1720)
* Added full support for the Bot API 9.2

* Mark butcher tool output files as linguist-generated in .gitattributes

* Switch `send_date` type from `int` to `DateTime` in suggested post models
2025-08-17 19:07:58 +03:00

121 lines
7.4 KiB
JSON
Generated

{
"meta": {},
"group": {
"title": "Available methods",
"anchor": "available-methods"
},
"object": {
"anchor": "sendmediagroup",
"name": "sendMediaGroup",
"description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of Message objects that were sent is returned.",
"html_description": "<p>Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of <a href=\"#message\">Message</a> objects that were sent is returned.</p>",
"rst_description": "Use this method to send a group of photos, videos, documents or audios as an album. Documents and audio files can be only grouped in an album with messages of the same type. On success, an array of :class:`aiogram.types.message.Message` objects that were sent 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": "Integer",
"required": false,
"description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat",
"html_description": "<td>Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat</td>",
"rst_description": "Identifier of the direct messages topic to which the messages will be sent; required if the messages are sent to a direct messages chat\n",
"name": "direct_messages_topic_id"
},
{
"type": "Array of InputMediaAudio, InputMediaDocument, InputMediaPhoto and InputMediaVideo",
"required": true,
"description": "A JSON-serialized array describing messages to be sent, must include 2-10 items",
"html_description": "<td>A JSON-serialized array describing messages to be sent, must include 2-10 items</td>",
"rst_description": "A JSON-serialized array describing messages to be sent, must include 2-10 items\n",
"name": "media"
},
{
"type": "Boolean",
"required": false,
"description": "Sends messages silently. Users will receive a notification with no sound.",
"html_description": "<td>Sends messages <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 messages `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 messages from forwarding and saving",
"html_description": "<td>Protects the contents of the sent messages from forwarding and saving</td>",
"rst_description": "Protects the contents of the sent messages from forwarding and saving\n",
"name": "protect_content"
},
{
"type": "Boolean",
"required": false,
"description": "Pass True to allow up to 1000 messages per second, ignoring broadcasting limits for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance",
"html_description": "<td>Pass <em>True</em> to allow up to 1000 messages per second, ignoring <a href=\"https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once\">broadcasting limits</a> for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance</td>",
"rst_description": "Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance\n",
"name": "allow_paid_broadcast"
},
{
"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": "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 messages are a reply, ID of the original message",
"html_description": "<td>If the messages are a reply, ID of the original message</td>",
"rst_description": "If the messages are a reply, ID of the original message\n",
"name": "reply_to_message_id",
"deprecated": {
"version": "7.0",
"release_date": "2023-12-29"
}
}
],
"category": "methods"
}
}