search_messages_count()

Client.search_messages_count()

Get the count of messages resulting from a search inside a chat.

If you want to get the actual messages, see search_messages().

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). You can also use chat public link in form of t.me/<username> (str).

  • query (str, optional) – Text query string. Required for text-only messages, optional for media messages (see the filter argument). When passed while searching for media messages, the query will be applied to captions. Defaults to “” (empty string).

  • filter (MessagesFilter, optional) – Pass a filter in order to search for specific kind of messages only:

  • from_user (int | str, optional) – Unique identifier (int) or username (str) of the target user you want to search for messages from.

  • thread_id (int, optional) – Unique identifier of the thread (Message.message_thread_id or Message.reply_top_message_id) to search in.

Returns:

int – On success, the messages count is returned.