get_search_results_positions()

async Client.get_search_results_positions()

Get positions of search results within a chat history.

Usable by Users Bots
Parameters:
  • chat_id (int | str) – Unique identifier (int) or username (str) of the target chat.

  • filter (MessagesFilter) – The filter to search with.

  • offset_id (int, optional) – Only return messages starting from the specified id.

  • limit (int, optional) – Maximum number of results. Defaults to 100.

  • saved_peer_id (int | str, optional) – Peer for saved messages context.

Returns:

SearchResultsPositions – The positions of search results.

Example

positions = await app.get_search_results_positions(
    chat_id, raw.types.InputMessagesFilterVideo()
)