MadelineProtoDocs/old_docs/API_docs_v81/methods/messages_getDialogs.md

60 lines
2.1 KiB
Markdown
Raw Normal View History

2018-07-12 20:24:55 +02:00
---
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](index.md)
Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|exclude\_pinned|[Bool](../types/Bool.md) | Do not fetch pinned chats | Optional|
2018-12-26 02:56:50 +01:00
|offset\_date|[int](../types/int.md) | End($res['messages'])['date']; | Yes|
|offset\_id|[int](../types/int.md) | End($res['messages'])['id']; | Yes|
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | End($res['dialogs'])['peer']; | Optional|
2018-08-29 11:18:25 +02:00
|limit|[int](../types/int.md) | Number of dialogs to fetch | Yes|
2018-07-12 20:24:55 +02:00
### Return type: [messages\_Dialogs](../types/messages_Dialogs.md)
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-07-12 20:24:55 +02:00
```php
2018-07-12 20:24:55 +02:00
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, ]);
```
Or, if you're into Lua:
```lua
2018-07-12 20:24:55 +02:00
messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=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|
2019-05-03 21:10:09 +02:00
|MSGID_DECREASE_RETRY|IDK TBH|
2018-07-12 20:24:55 +02:00
|Timeout|A timeout occurred while fetching data from the bot|