MadelineProto/old_docs/API_docs_v25/methods/messages_getDialogs.md

75 lines
1.8 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.getDialogs
2018-03-23 12:35:00 +01:00
description: Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html
---
2017-01-19 23:02:27 +01:00
## Method: messages.getDialogs
[Back to methods index](index.md)
2018-03-23 12:35:00 +01:00
Gets list of chats: you should use $MadelineProto->get_dialogs() instead: https://docs.madelineproto.xyz/docs/DIALOGS.html
### Parameters:
2018-03-23 12:35:00 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-27 14:41:50 +02:00
|offset|[int](../types/int.md) | Yes|Offset|
|max\_id|[int](../types/int.md) | Yes|Maximum ID of result to return|
|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch|
### Return type: [messages\_Dialogs](../types/messages_Dialogs.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
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(['offset' => int, 'max_id' => int, 'limit' => int, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getDialogs`
Parameters:
offset - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
max_id - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
limit - Json encoded int
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
messages_Dialogs = messages.getDialogs({offset=int, max_id=int, limit=int, })
```
2018-03-27 14:41:50 +02:00
### 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|