messages.getDialogs

Returns the current user dialog list.

API section: Working with dialogs

messages.getDialogs#a0f4cb4f flags:# exclude_pinned:flags.0?true folder_id:flags.1?int offset_date:int offset_id:int offset_peer:InputPeer limit:int hash:long = messages.Dialogs;

Parameters

NameTypeDescription
flags # Bit mask: a field written flags.N?T is present only when bit N is set.
exclude_pinned flags.0?true
folder_id flags.1?int Folder number: 0 is the main list, 1 is the archive.
offset_date int Date to continue the selection from.
offset_id int Identifier to continue the selection from.
offset_peer InputPeer Peer to continue the selection from.
limit int Maximum number of records to return.
hash long Hash of what the client already has. If it matches, the server answers "not modified" and sends nothing again.

Result

messages.Dialogs

Possible errors

This method has no errors of its own: it either answers or fails on the shared checks below.

Common to every call

CodeTypeWhat it means
401 AUTH_KEY_UNREGISTERED The server does not know this session: the key was revoked, expired, or the call was made before authorisation.
401 API_ID_INVALID This api_id was never issued or has been blocked. Keys come from my.ansible.su.
400 CONNECTION_LAYER_INVALID The client did not declare a layer, or declared one the server does not know.
420 FLOOD_WAIT_X Too often. Do not retry for X seconds — the number arrives in the error text.
500 INTERNAL A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours.

This call counts as expensive: its cost grows with the amount of data, so under peak load it goes through admission control and may answer FLOOD_WAIT where cheap calls always pass. Build retries with a backoff.

Related pages

Types used here