{ "meta": {}, "group": { "title": "Available methods", "anchor": "available-methods" }, "object": { "anchor": "senddice", "name": "sendDice", "description": "Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.", "html_description": "

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

", "rst_description": "Use this method to send an animated emoji that will display a random value. 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": "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": "Integer", "required": false, "description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat", "html_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat", "rst_description": "Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat\n", "name": "direct_messages_topic_id" }, { "type": "String", "required": false, "description": "Emoji on which the dice throw animation is based. Currently, must be one of '', '', '', '', '', or ''. Dice can have values 1-6 for '', '' and '', values 1-5 for '' and '', and values 1-64 for ''. Defaults to ''", "html_description": "Emoji on which the dice throw animation is based. Currently, must be one of “\"🎲\"/”, “\"🎯\"/”, “\"🏀\"/”, “\"⚽\"/”, “\"🎳\"/”, or “\"🎰\"/”. Dice can have values 1-6 for “\"🎲\"/”, “\"🎯\"/” and “\"🎳\"/”, values 1-5 for “\"🏀\"/” and “\"⚽\"/”, and values 1-64 for “\"🎰\"/”. Defaults to “\"🎲\"/”", "rst_description": "Emoji on which the dice throw animation is based. Currently, must be one of '🎲', '🎯', '🏀', '⚽', '🎳', or '🎰'. Dice can have values 1-6 for '🎲', '🎯' and '🎳', values 1-5 for '🏀' and '⚽', and values 1-64 for '🎰'. Defaults to '🎲'\n", "name": "emoji" }, { "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", "html_description": "Protects the contents of the sent message from forwarding", "rst_description": "Protects the contents of the sent message from forwarding\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": "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", "rst_description": "Pass :code:`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\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": "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": "SuggestedPostParameters", "required": false, "description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.", "html_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.", "rst_description": "A JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.\n", "name": "suggested_post_parameters" }, { "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" } }