send_checklist()

Client.send_checklist()

Send a new checklist.

Usable by Users Bots

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).

• checklist (InputChecklist) – Checklist to send.

• disable_notification (bool, optional) – Sends the message silently. Users will receive a notification with no sound.

• protect_content (bool, optional) – Protects the contents of the sent message from forwarding and saving.

• message_thread_id (int, optional) – Unique identifier for the target message thread (topic) of the forum. For supergroups only.

• effect_id (int, optional) – Unique identifier of the message effect. For private chats only.

• reply_parameters (ReplyParameters, optional) – Describes reply parameters for the message that is being sent.

• schedule_date (datetime, optional) – Date when the message will be automatically sent.

• repeat_period (int, optional) – Period after which the message will be sent again in seconds.

• business_connection_id (str, optional) – Unique identifier of the business connection on behalf of which the message will be sent.

• paid_message_star_count (int, optional) – The number of Telegram Stars the user agreed to pay to send the messages.

• 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 checklist message is returned.

Example

await client.send_checklist(
    chat_id=message.chat.id,
    title="To do",
    tasks=[
        types.InputChecklistTask(id=1, text="Task 1"),
        types.InputChecklistTask(id=2, text="Task 2")
    ]
)