Skip to content

GramIO API Reference / gramio/dist / SendDiceParams

Interface: SendDiceParams

Defined in: @gramio/types/out/params.d.ts:1508

Params object for sendDice method

Properties

PropertyTypeDescriptionDefined in
allow_paid_broadcast?booleanPass True to allow 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@gramio/types/out/params.d.ts:1540
business_connection_id?stringUnique identifier of the business connection on behalf of which the message will be sent@gramio/types/out/params.d.ts:1512
chat_idstring | numberUnique identifier for the target chat or username of the target channel (in the format @channelusername)@gramio/types/out/params.d.ts:1516
direct_messages_topic_id?numberIdentifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat@gramio/types/out/params.d.ts:1524
disable_notification?booleanSends the message silently. Users will receive a notification with no sound.@gramio/types/out/params.d.ts:1532
emoji?SendDiceEmojiEmoji 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 “🎲@gramio/types/out/params.d.ts:1528
message_effect_id?stringUnique identifier of the message effect to be added to the message; for private chats only@gramio/types/out/params.d.ts:1544
message_thread_id?numberUnique identifier for the target message thread (topic) of a forum; for forum supergroups and private chats of bots with forum topic mode enabled only@gramio/types/out/params.d.ts:1520
protect_content?booleanProtects the contents of the sent message from forwarding@gramio/types/out/params.d.ts:1536
reply_markup?TelegramInlineKeyboardMarkup | TelegramReplyKeyboardMarkup | TelegramReplyKeyboardRemove | TelegramForceReply | { toJSON: TelegramInlineKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardMarkup; } | { toJSON: TelegramReplyKeyboardRemove; } | { toJSON: TelegramForceReply; }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@gramio/types/out/params.d.ts:1556
reply_parameters?TelegramReplyParametersDescription of the message to reply to@gramio/types/out/params.d.ts:1552
suggested_post_parameters?TelegramSuggestedPostParametersA JSON-serialized object containing the parameters of the suggested post to send; for direct messages chats only. If the message is sent as a reply to another suggested post, then that suggested post is automatically declined.@gramio/types/out/params.d.ts:1548