messages.getDialogs

Returns the current user dialog list.

messages.dialogs#15ba6c40 dialogs:Vector<Dialog> messages:Vector<Message> chats:Vector<Chat> users:Vector<User> = messages.Dialogs;
messages.dialogsSlice#71e094f3 count:int dialogs:Vector<Dialog> messages:Vector<Message> chats:Vector<Chat> users:Vector<User> = messages.Dialogs;
messages.dialogsNotModified#f0e3e596 count:int = messages.Dialogs;
---functions---
messages.getDialogs#a0ee3b73 flags:# exclude_pinned:flags.0?true folder_id:flags.1?int offset_date:int offset_id:int offset_peer:InputPeer limit:int hash:int = messages.Dialogs;

Parameters

Name Type Description
flags # Flags, see TL conditional fields
exclude_pinned flags.0?true Exclude pinned dialogs
folder_id flags.1?int Folder ID
offset_date int Offsets for pagination, for more info click here
offset_id int Offsets for pagination, for more info click here
offset_peer InputPeer Offset peer for pagination
limit int Number of list elements to be returned
hash int Hash for pagination, for more info click here

Result

messages.Dialogs

Possible errors

Code Type Description
400 BOT_METHOD_INVALID This method can't be used by a bot
400 INPUT_CONSTRUCTOR_INVALID The provided constructor is invalid
400 OFFSET_PEER_ID_INVALID The provided offset peer is invalid
401 SESSION_PASSWORD_NEEDED 2FA is enabled, use a password to login
-503 Timeout Timeout while fetching data

Related pages

Pagination in the API

How to fetch results from large lists of objects.