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

• title (str) – Title of the checklist.

• tasks (List of str) – List of tasks in the checklist, 1-30 tasks.

• parse_mode (ParseMode, optional) – The parse mode to use for the checklist.

• entities (List of MessageEntity, optional) – List of special entities that appear in the checklist title.

• others_can_add_tasks (bool, optional) – True, if other users can add tasks to the list.

• others_can_mark_tasks_as_done (bool, optional) – True, if other users can mark tasks as done or not done.

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

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

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")
    ]
)