peyk.platforms.telegram.methods.send_checklist

async peyk.platforms.telegram.methods.send_checklist(self, business_connection_id: str, chat_id: int | str, checklist: InputChecklist, *, disable_notification: bool | None = None, protect_content: bool | None = None, message_effect_id: str | None = None, reply_parameters: ReplyParameters | None = None, reply_markup: InlineKeyboardMarkup | None = None) → Message

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

Parameters:

  • business_connection_id – Unique identifier of the business connection on behalf of which the message will be sent

  • chat_id – Unique identifier for the target chat or username of the target bot in the format @username

  • checklist – A JSON-serialized object for the checklist to send

  • disable_notification – Sends the message silently. Users will receive a notification with no sound.

  • protect_content – Protects the contents of the sent message from forwarding and saving

  • message_effect_id – Unique identifier of the message effect to be added to the message

  • reply_parameters – A JSON-serialized object for description of the message to reply to

  • reply_markup – A JSON-serialized object for an inline keyboard

Returns:

Result returned by Telegram on successful execution.

Return type:

Message