sendDice()

Use this method to send an animated emoji that will display a random value. On success, the sent Message is returned.

parameters

parameter	type	required	description
`business_connection_id`	string	optional	Unique identifier of the business connection on behalf of which the message will be sent
`chat_id`	number \| string	required	Unique identifier for the target chat or username of the target bot, supergroup or channel in the format `@username`
`message_thread_id`	number	optional	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
`direct_messages_topic_id`	number	optional	Identifier of the direct messages topic to which the message will be sent; required if the message is sent to a direct messages chat
`emoji`	string	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`	boolean	optional	Sends the message silently. Users will receive a notification with no sound.
`protect_content`	boolean	optional	Protects the contents of the sent message from forwarding
`allow_paid_broadcast`	boolean	optional	Pass 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.
`message_effect_id`	string	optional	Unique identifier of the message effect to be added to the message; for private chats only
`suggested_post_parameters`	SuggestedPostParameters	optional	A 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.
`reply_parameters`	ReplyParameters	optional	Description of the message to reply to
`reply_markup`	InlineKeyboardMarkup \| ReplyKeyboardMarkup \| ReplyKeyboardRemove \| ForceReply	optional	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

Message

usage in yaebal

sendDice is directly typed on Api — call it straight off bot.api.

bot.ts

import type { SendDiceParams } from "@yaebal/types";

await bot.api.sendDice({
  chat_id: 123456789,
} satisfies SendDiceParams);

context shortcut

also available as ctx.sendDice() on 16 context types — see @yaebal/contexts.

context shortcut

/** Use this method to send a native poll. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. */ sendPoll(question: string, options: readonly (string | t.InputPollOption)[], params?: Omit<t.SendPollParams, "chat_id" | "message_thread_id" | "question" | "options">): Promise<t.Message>; sendPoll(params: Omit<t.SendPollParams, "chat_id" | "message_thread_id">): Promise<t.Message>; sendPoll(a: string | Omit<t.SendPollParams, "chat_id" | "message_thread_id">, b?: readonly (string | t.InputPollOption)[], c?: Omit<t.SendPollParams, "chat_id" | "message_thread_id" | "question" | "options">): Promise<t.Message> { const params = typeof a === "string" ? ({ question: a, options: (b ?? []).map((o) => (typeof o === "string" ? { text: o } : o)), ...c } as unknown as Omit<t.SendPollParams, "chat_id" | "message_thread_id">) : a; return this.api.call<t.Message>("sendPoll", { chat_id: this.chat.id, ...(((this.message_thread_id) === undefined) ? {} : { message_thread_id: this.message_thread_id }), ...params }); } /** Use this method to send an animated emoji that will display a random value. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. */
ctx.sendDice(emoji: string, params?: Omit<SendDiceParams, "chat_id" | "message_thread_id" | "direct_messages_topic_id" | "emoji">)

official Bot API docs: https://core.telegram.org/bots/api/#senddice