send_dice()#
- 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_parameters (
ReplyParameters
, optional) – Description of the message to reply tomessage_thread_id (
int
, optional) – If the message is in a thread, ID of the original message.business_connection_id (
str
, optional) – Unique identifier of the business connection on behalf of which the message will be sent.schedule_date (
datetime
, optional) – Date when the message will be automatically sent.protect_content (
bool
, optional) – Pass True if the content of the message must be protected from forwarding and saving; for bots only.message_effect_id (
int
64-bit
, optional) – Unique identifier of the message effect to be added to the message; for private chats only.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.
- 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, "🏀")