get_dialogs()

Client.get_dialogs()

Get a user’s dialogs sequentially.

Usable by Users Bots
Parameters:

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

  • pinned_only (bool, optional) – Pass True if you want to get only pinned dialogs. Defaults to False.

  • chat_list (int, optional) – Chat list from which to get the dialogs; Only Main (0) and Archive (1) chat lists are supported. Defaults to (0) Main chat list.

Returns:

Generator – A generator yielding Dialog objects.

Example

# Iterate through all dialogs
async for dialog in app.get_dialogs():
    print(dialog.chat.first_name or dialog.chat.title)