MadelineProtoDocs/docs/API_docs/methods/messages_getDialogs.md

2.3 KiB

title: messages.getDialogs description: Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png

Method: messages.getDialogs

Back to methods index

Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html

Parameters:

Name Type Description Required
exclude_pinned Bool Do not fetch pinned chats Optional
folder_id int Folder ID Optional
offset_date int End($res['messages'])['date']; Yes
offset_id int End($res['messages'])['id']; Yes
offset_peer Username, chat ID, Update, Message or InputPeer End($res['dialogs'])['peer']; Optional
limit int Number of dialogs to fetch 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, 'folder_id' => int, '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, folder_id=int, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, hash={int}, })

Errors this method can return:

Error Description
INPUT_CONSTRUCTOR_INVALID The provided constructor is invalid
OFFSET_PEER_ID_INVALID The provided offset peer is invalid
SESSION_PASSWORD_NEEDED 2FA is enabled, use a password to login
MSGID_DECREASE_RETRY IDK TBH
Timeout A timeout occurred while fetching data from the bot