peyk.platforms.telegram.methods.send_dice¶
- async peyk.platforms.telegram.methods.send_dice(self, chat_id: int | str, *, message_thread_id: int | None = None, emoji: str | None = None, disable_notification: bool | None = None, protect_content: bool | None = None, reply_parameters: ReplyParameters | Mapping[str, object] | None = None, reply_markup: InlineKeyboardMarkup | ReplyKeyboardMarkup | ReplyKeyboardRemove | ForceReply | Mapping[str, object] | None = None) Message[source]¶
Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.
- Parameters:
chat_id – Unique identifier for the target chat or username of the target bot, supergroup or channel in the format @username
message_thread_id – Unique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only
emoji – 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 – Sends the message silently. Users will receive a notification with no sound.
protect_content – Protects the contents of the sent message from forwarding
reply_parameters – Description of the message to reply to
reply_markup – 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.
- Returns:
Result returned by Telegram on successful execution.
- Return type: