sendChecklist()

Use this method to send a checklist on behalf of a connected business account. On success, the sent Message is returned.

parameters

parameter	type	required	description
`business_connection_id`	string	required	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 in the format `@username`
`checklist`	InputChecklist	required	A JSON-serialized object for the checklist to send
`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 and saving
`message_effect_id`	string	optional	Unique identifier of the message effect to be added to the message
`reply_parameters`	ReplyParameters	optional	A JSON-serialized object for description of the message to reply to
`reply_markup`	InlineKeyboardMarkup	optional	A JSON-serialized object for an inline keyboard

returns

Message

usage in yaebal

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

bot.ts

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

await bot.api.sendChecklist({
  business_connection_id: "...",
  chat_id: 123456789,
  checklist: {} /* InputChecklist */,
} satisfies SendChecklistParams);

context shortcut

also available as ctx.sendChecklist() on 4 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, "business_connection_id" | "chat_id" | "message_thread_id" | "question" | "options">): Promise<t.Message>; sendPoll(params: Omit<t.SendPollParams, "business_connection_id" | "chat_id" | "message_thread_id">): Promise<t.Message>; sendPoll(a: string | Omit<t.SendPollParams, "business_connection_id" | "chat_id" | "message_thread_id">, b?: readonly (string | t.InputPollOption)[], c?: Omit<t.SendPollParams, "business_connection_id" | "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, "business_connection_id" | "chat_id" | "message_thread_id">) : a; return this.api.call<t.Message>("sendPoll", { ...(((this.business_connection_id) === undefined) ? {} : { business_connection_id: this.business_connection_id }), chat_id: this.chat.id, ...(((this.message_thread_id) === undefined) ? {} : { message_thread_id: this.message_thread_id }), ...params }); } /** Use this method to send a checklist on behalf of a connected business account. On success, the sent [Message](https://core.telegram.org/bots/api/#message) is returned. */
ctx.sendChecklist(params: Omit<SendChecklistParams, "business_connection_id" | "chat_id"> & { business_connection_id?: string })

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