search_messages()

Client.search_messages()

Search for text and media messages inside a specific chat.

If you want to get the messages count only, see search_messages_count().

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

  • offset (int, optional) – Sequential number of the first message to be returned. Defaults to 0.

  • filter (MessagesFilter, optional) – Pass a filter in order to search for specific kind of messages only. Defaults to any message (no filter).

  • limit (int, optional) – Limits the number of messages to be retrieved. By default, no limit is applied and all messages are returned.

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

Generator – A generator yielding Message objects.

Example

from pyrogram import enums

# Search for text messages in chat. Get the last 120 results
async for message in app.search_messages(chat_id, query="hello", limit=120):
    print(message.text)

# Search for pinned messages in chat
async for message in app.search_messages(chat_id, filter=enums.MessagesFilter.PINNED):
    print(message.text)

# Search for messages containing "hello" sent by yourself in chat
async for message in app.search_messages(chat, "hello", from_user="me"):
    print(message.text)