MadelineProto/old_docs/API_docs_v70/methods/messages_getDialogs.md

title	description
messages.getDialogs	messages.getDialogs parameters, return type and example

Method: messages.getDialogs

Back to methods index

Parameters:

Name	Type	Required
exclude_pinned	CLICK ME Bool	Optional
offset_date	CLICK ME int	Yes
offset_id	CLICK ME int	Yes
offset_peer	Username, chat ID, Update, Message or InputPeer	Optional
limit	CLICK ME int	Yes

Return type: messages_Dialogs

Can bots use this method: NO

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
Timeout	A timeout occurred while fetching data from the bot

MadelineProto Example:

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

// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';

$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();

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

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/messages.getDialogs

Parameters:

exclude_pinned - Json encoded Bool

offset_date - Json encoded int

offset_id - Json encoded int

offset_peer - Json encoded InputPeer

limit - Json encoded 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, })