2016-12-30 16:32:25 +01:00
|
|
|
---
|
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
|
2016-12-30 16:32:25 +01:00
|
|
|
---
|
2017-01-19 23:02:27 +01:00
|
|
|
## Method: messages.getDialogs
|
2016-12-30 16:32:25 +01:00
|
|
|
[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
|
|
|
|
|
2016-12-30 16:32:25 +01:00
|
|
|
### Parameters:
|
|
|
|
|
2018-03-23 12:35:00 +01:00
|
|
|
| Name | Type | Required | Description |
|
|
|
|
|----------|---------------|----------|-------------|
|
2018-03-27 14:41:50 +02:00
|
|
|
|offset\_date|[int](../types/int.md) | Yes|end($res['messages'])['date'];|
|
|
|
|
|offset\_id|[int](../types/int.md) | Yes|end($res['messages'])['id'];|
|
2018-03-23 12:35:00 +01:00
|
|
|
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|end($res['dialogs'])['peer'];|
|
2018-03-27 14:41:50 +02:00
|
|
|
|limit|[int](../types/int.md) | Yes|Number of dialogs to fetch|
|
2016-12-30 16:32:25 +01:00
|
|
|
|
|
|
|
|
2017-01-02 19:50:37 +01:00
|
|
|
### Return type: [messages\_Dialogs](../types/messages_Dialogs.md)
|
2016-12-30 16:32:25 +01:00
|
|
|
|
2017-08-28 12:44:50 +02:00
|
|
|
### Can bots use this method: **NO**
|
|
|
|
|
|
|
|
|
2018-03-20 19:57:36 +01:00
|
|
|
### MadelineProto Example:
|
2016-12-30 16:32:25 +01:00
|
|
|
|
|
|
|
|
|
|
|
```
|
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
|
|
|
if (!file_exists('madeline.php')) {
|
|
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
2016-12-30 16:32:25 +01:00
|
|
|
}
|
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
|
|
|
include 'madeline.php';
|
|
|
|
|
2018-03-23 17:48:12 +01:00
|
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
Documentation rework (#349)
* Documentation rework
* Apply fixes from StyleCI
* Documentation fixes
* Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite
* Apply fixes from StyleCI
* Logging fixes
* Build docs
* Add methods to modify start template, bugfix to logging and keyboard conversion
* Add TL documentator
* Document MTProto methods
* Documenting methods...
* 7% documented
* Bugfixes
* Update docs
* Update docs
* Simplify file management
* Implement automatic object conversion for media, and more awesome stuff
* Implement automatic object conversion for media, and more awesome stuff
* Implement event update handler and file upload/download callback
* Auto-detect mime type, duration, width and height of media
* Update docs
* Document new file functions
* Fix links
* Fix links
* Update bot.php to use event loop
* Implement webhook update handler and forking in main loop
* Build docs
* Better docs
* Fixes to secret chats
* Almost finished updating docs
* Bugfixes, implemented infinite loop for loop() method, almost finished docs
* Finish writing docs
* Add automatic documentation builder script
* Finished writing docs
2018-03-20 12:48:05 +01:00
|
|
|
$MadelineProto->start();
|
2016-12-30 16:32:25 +01:00
|
|
|
|
2017-01-02 19:50:37 +01:00
|
|
|
$messages_Dialogs = $MadelineProto->messages->getDialogs(['offset_date' => int, 'offset_id' => int, 'offset_peer' => InputPeer, 'limit' => int, ]);
|
2017-02-13 04:33:06 +01:00
|
|
|
```
|
2017-03-11 19:54:51 +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_date - Json encoded int
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
offset_id - Json encoded int
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
offset_peer - Json encoded InputPeer
|
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
|
|
|
|
2017-03-11 19:54:51 +01:00
|
|
|
Or, if you're into Lua:
|
|
|
|
|
|
|
|
```
|
|
|
|
messages_Dialogs = messages.getDialogs({offset_date=int, offset_id=int, offset_peer=InputPeer, 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|
|
|
|
|
|
|
|
|
|