MadelineProto/old_docs/API_docs_v68/methods/messages_getDialogs.md

81 lines
1.9 KiB
Markdown
Raw Normal View History

2017-07-23 17:44:01 +02:00
---
title: messages.getDialogs
description: messages.getDialogs parameters, return type and example
---
## Method: messages.getDialogs
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-07-23 17:44:01 +02:00
|exclude\_pinned|[Bool](../types/Bool.md) | Optional|
|offset\_date|[int](../types/int.md) | Yes|
|offset\_id|[int](../types/int.md) | Yes|
|offset\_peer|[InputPeer](../types/InputPeer.md) | Yes|
|limit|[int](../types/int.md) | Yes|
### Return type: [messages\_Dialogs](../types/messages_Dialogs.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
2017-09-25 12:26:30 +02:00
|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid|
2017-09-01 12:27:38 +02:00
|OFFSET_PEER_ID_INVALID|The provided offset peer is invalid|
2017-08-28 12:44:50 +02:00
|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
2017-09-01 12:27:38 +02:00
2017-07-23 17:44:01 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$messages_Dialogs = $MadelineProto->messages->getDialogs(['exclude_pinned' => Bool, 'offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, ]);
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 17:44:01 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getDialogs`
Parameters:
exclude_pinned - Json encoded Bool
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
offset_date - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
offset_id - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
offset_peer - Json encoded InputPeer
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
limit - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
Or, if you're into Lua:
```
messages_Dialogs = messages.getDialogs({exclude_pinned=Bool, offset_date=int, offset_id=int, offset_peer=InputPeer, limit=int, })
```