send_dice()

Client.send_dice()

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

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 “⚽️”. 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 (int, optional) – Date when the message will be automatically sent. Unix time.

• 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
app.send_dice("pyrogramlounge")

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

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