MadelineProtoDocs/old_docs/API_docs_v82/methods/messages.getDialogs.md

62 lines
2.3 KiB
Markdown
Raw Permalink Normal View History

2018-12-26 02:56:50 +01:00
---
title: messages.getDialogs
2019-12-27 17:48:04 +01:00
description: Returns the current user dialog list.
2018-12-26 02:56:50 +01:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_getDialogs.html
2018-12-26 02:56:50 +01:00
---
# Method: messages.getDialogs
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Returns the current user dialog list.
2018-12-26 02:56:50 +01:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|exclude\_pinned|[Bool](../types/Bool.md) | Exclude pinned dialogs | Optional|
|offset\_date|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes|
|offset\_id|[int](../types/int.md) | [Offsets for pagination, for more info click here](https://core.telegram.org/api/offsets) | Yes|
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | [Offset peer for pagination](https://core.telegram.org/api/offsets) | Optional|
|limit|[int](../types/int.md) | Number of list elements to be returned | Yes|
2018-12-26 02:56:50 +01:00
|hash|Array of [int](../types/int.md) | IDs of previously fetched dialogs | Optional|
2019-12-27 18:25:37 +01:00
### Return type: [messages.Dialogs](../types/messages.Dialogs.md)
2018-12-26 02:56:50 +01:00
### 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-12-26 02:56:50 +01:00
```php
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();
2019-12-27 18:25:37 +01:00
$messages.Dialogs = $MadelineProto->messages->getDialogs(['exclude_pinned' => Bool, 'offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, 'hash' => [int, int], ]);
2018-12-26 02:56:50 +01:00
```
Or, if you're into Lua:
```lua
2019-12-27 18:25:37 +01:00
messages.Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, hash={int}, })
2018-12-26 02:56:50 +01:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid|
|400|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid|
2020-02-23 19:29:04 +01:00
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
2019-09-02 17:41:28 +02:00
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
|-503|Timeout|Timeout while fetching data|
2018-12-26 02:56:50 +01:00