aiogram/.butcher/methods/sendDice/entity.json

{
  "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": "<p>Use this method to send an animated emoji that will display a random value. On success, the sent <a href=\"#message\">Message</a> is returned.</p>",
    "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": "<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": "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": "<td>Emoji on which the dice throw animation is based. Currently, must be one of &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"&#127922;\"/>&#8221;, &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EAF.png\" width=\"20\" height=\"20\" alt=\"&#127919;\"/>&#8221;, &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8F80.png\" width=\"20\" height=\"20\" alt=\"&#127936;\"/>&#8221;, &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/E29ABD.png\" width=\"20\" height=\"20\" alt=\"&#9917;\"/>&#8221;, &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB3.png\" width=\"20\" height=\"20\" alt=\"&#127923;\"/>&#8221;, or &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB0.png\" width=\"20\" height=\"20\" alt=\"&#127920;\"/>&#8221;. Dice can have values 1-6 for &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"&#127922;\"/>&#8221;, &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EAF.png\" width=\"20\" height=\"20\" alt=\"&#127919;\"/>&#8221; and &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB3.png\" width=\"20\" height=\"20\" alt=\"&#127923;\"/>&#8221;, values 1-5 for &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8F80.png\" width=\"20\" height=\"20\" alt=\"&#127936;\"/>&#8221; and &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/E29ABD.png\" width=\"20\" height=\"20\" alt=\"&#9917;\"/>&#8221;, and values 1-64 for &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB0.png\" width=\"20\" height=\"20\" alt=\"&#127920;\"/>&#8221;. Defaults to &#8220;<img class=\"emoji\" src=\"//telegram.org/img/emoji/40/F09F8EB2.png\" width=\"20\" height=\"20\" alt=\"&#127922;\"/>&#8221;</td>",
        "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": "<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",
        "html_description": "<td>Protects the contents of the sent message from forwarding</td>",
        "rst_description": "Protects the contents of the sent message from forwarding\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"
  }
}