MadelineProtoDocs/old_docs/API_docs_v82/methods/messages.getDialogs.md
2020-02-23 19:29:04 +01:00

2.3 KiB

title description image redirect_from
messages.getDialogs Returns the current user dialog list. https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png /API_docs/methods/messages_getDialogs.html

Method: messages.getDialogs

Back to methods index

Returns the current user dialog list.

Parameters:

Name Type Description Required
exclude_pinned Bool Exclude pinned dialogs Optional
offset_date int Offsets for pagination, for more info click here Yes
offset_id int Offsets for pagination, for more info click here Yes
offset_peer Username, chat ID, Update, Message or InputPeer Offset peer for pagination Optional
limit int Number of list elements to be returned Yes
hash Array of int IDs of previously fetched dialogs Optional

Return type: messages.Dialogs

Can bots use this method: NO

MadelineProto Example (now async for huge speed and parallelism!):

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();

$messages.Dialogs = $MadelineProto->messages->getDialogs(['exclude_pinned' => Bool, 'offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, 'hash' => [int, int], ]);

Or, if you're into Lua:

messages.Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, hash={int}, })

Errors

Code Type Description
400 INPUT_CONSTRUCTOR_INVALID The provided constructor is invalid
400 OFFSET_PEER_ID_INVALID The provided offset peer is invalid
406 AUTH_KEY_DUPLICATED An auth key with the same ID was already generated
401 SESSION_PASSWORD_NEEDED 2FA is enabled, use a password to login
-503 Timeout Timeout while fetching data