1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-11 08:42:03 +01:00
MadelineProto/old_docs/API_docs_v70/methods/messages_getDialogs.md
Daniil Gentili 7a0153a139
Documentation rework (#349)
* Documentation rework

* Apply fixes from StyleCI

* Documentation fixes

* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite

* Apply fixes from StyleCI

* Logging fixes

* Build docs

* Add methods to modify start template, bugfix to logging and keyboard conversion

* Add TL documentator

* Document MTProto methods

* Documenting methods...

* 7% documented

* Bugfixes

* Update docs

* Update docs

* Simplify file management

* Implement automatic object conversion for media, and more awesome stuff

* Implement automatic object conversion for media, and more awesome stuff

* Implement event update handler and file upload/download callback

* Auto-detect mime type, duration, width and height of media

* Update docs

* Document new file functions

* Fix links

* Fix links

* Update bot.php to use event loop

* Implement webhook update handler and forking in main loop

* Build docs

* Better docs

* Fixes to secret chats

* Almost finished updating docs

* Bugfixes, implemented infinite loop for loop() method, almost finished docs

* Finish writing docs

* Add automatic documentation builder script

* Finished writing docs
2018-03-20 12:48:05 +01:00

2.1 KiB

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

Method: messages.getDialogs

Back to methods index

Parameters:

Name Type Required
exclude_pinned Bool Optional
offset_date int Yes
offset_id int Yes
offset_peer Username, chat ID, Update, Message or InputPeer Optional
limit 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

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, ]);

Or, if you're using the PWRTelegram HTTP API:

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, })