send_dice()

async Client.send_dice()

Send a dice with a random value from 1 to 6.

Usable by Users Bots
Parameters:

  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat. For your personal cloud (Saved Messages) you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).

  • emoji (str, optional) – 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 “🎲”.

  • disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.

  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.

  • schedule_date (datetime, optional) – Date when the message will be automatically sent.

  • protect_content (bool, optional) – Protects the contents of the sent message from forwarding and saving.

  • reply_markup (InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.

  • reply_to_chat_id (int | str, optional) – Unique identifier for the chat to which the replied message belongs. Only applicable in combination with reply_to_message_id.

  • quote_text (str, optional) – Text of the quote to reply to.

  • quote_entities (List of MessageEntity) – List of special entities that appear in quote_text, which can be specified instead of parse_mode.

  • reply_parameters (ReplyParameters, optional) – Describes reply parameters for the message that is being sent.

  • message_thread_id (int, optional) – Unique identifier for a message thread in a forum topic.

  • effect_id (int, optional) – Unique identifier of the effect to apply to the message.

  • repeat_period (int, optional) – New period in seconds for the message to be sent repeatedly.

  • business_connection_id (str, optional) – Unique identifier of the business connection.

  • allow_paid_broadcast (bool, optional) – If True, you will be allowed to send 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. For bots only.

  • paid_message_star_count (int, optional) – The number of Telegram Stars the user agreed to pay to send the messages.

  • suggested_post_parameters (SuggestedPostParameters, optional) – Parameters of the suggested post.

  • direct_messages_topic_id (int, optional) – Unique identifier of the topic in a channel direct messages chat administered by the current user. For directs only only.

  • show_caption_above_media (bool, optional) – Pass True, if the caption must be shown above the message media.

  • background (bool, optional) – Send the message in background.

  • clear_draft (bool, optional) – Clear the draft of the chat.

  • update_stickersets_order (bool, optional) – Move the sticker set to the top of the list.

  • send_as (int | str, optional) – Unique identifier (int) or username (str) of the chat or channel to send the message as.

  • quick_reply_shortcut (int, optional) – Unique identifier of the quick reply shortcut the message belongs to.

Returns:

Message – On success, the sent dice message is returned.

Example

# Send a dice
await app.send_dice(chat_id)

# Send a dart
await app.send_dice(chat_id, "🎯")

# Send a basketball
await app.send_dice(chat_id, "🏀")