MadelineProtoDocs/old_docs/API_docs_v34/methods/messages.getPinnedDialogs.md

54 lines
1.3 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
2020-06-16 17:50:25 +02:00
title: messages.getPinnedDialogs
description: Get pinned dialogs
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2020-06-16 17:50:25 +02:00
redirect_from: /API_docs/methods/messages_getPinnedDialogs.html
2019-06-23 13:07:51 +02:00
---
2020-06-16 17:50:25 +02:00
# Method: messages.getPinnedDialogs
2019-06-23 13:07:51 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
Get pinned dialogs
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2020-06-16 17:50:25 +02:00
|folder\_id|[int](../types/int.md) | [Peer folder ID, for more info click here](https://core.telegram.org/api/folders#peer-folders) | Yes|
2019-06-23 13:07:51 +02:00
2020-06-16 17:50:25 +02:00
### Return type: [messages.PeerDialogs](../types/messages.PeerDialogs.md)
2019-06-23 13:07:51 +02:00
2020-06-16 17:50:25 +02:00
### Can bots use this method: **NO**
2019-06-23 13:07:51 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```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();
2020-06-16 17:50:25 +02:00
$messages.PeerDialogs = $MadelineProto->messages->getPinnedDialogs(['folder_id' => int, ]);
2019-06-23 13:07:51 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
messages.PeerDialogs = messages.getPinnedDialogs({folder_id=int, })
2019-06-23 13:07:51 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
2020-06-16 17:50:25 +02:00
|400|FOLDER_ID_INVALID|Invalid folder ID|
2019-06-23 13:07:51 +02:00