Message Listener

Listens for a message update

listen_message()

Parameters

  • chat_id (int ) – Unique identifier (int) of the target chat.

  • filters (filters, optional) – Pass one or more filters to allow only a subset of chosen inline results to be passed in your function.

  • timeout (int,optional) – To specify the timeout duration in seconds for a client to listen for a message.

Returns : Message

Example

await app.listen_message(chat_id=chat_id, filters=filters, timeout=timeout)

ask_message()

Parameters

  • chat_id (int ) – Unique identifier (int) of the target chat.

  • text (str) – Text of the message to be sent.

  • filters (filters, optional) – Pass one or more filters to allow only a subset of chosen inline results to be passed in your function.

  • timeout (int,optional) – To specify the timeout duration in seconds for a client to listen for a message.

  • parse_mode (ParseMode, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.

  • entities (List of MessageEntity) – List of special entities that appear in message text, which can be specified instead of parse_mode.

  • disable_web_page_preview (bool, optional) – Disables link previews for links in this message.

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

  • reply_to_message_id (int, optional) – If the message is a reply, ID of the original message.

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

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

  • 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

Example

await app.ask_message(chat_id=chat_id, text=text, filters=filters, timeout=timeout)

cancel_message_listener()

Parameters

  • chat_id (int ) – Unique identifier (int) of the target chat.

Returns : None

Example

await app.cancel_message_listener(chat_id=chat_id)

Last updated