1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-14 18:46:58 +01:00
MadelineProto/docs/TD_docs/methods/getChatHistory.md

80 lines
2.5 KiB
Markdown
Raw Normal View History

---
title: getChatHistory
description: Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id
---
## Method: getChatHistory
[Back to methods index](index.md)
2017-06-06 18:39:21 +02:00
YOU CANNOT USE THIS METHOD IN MADELINEPROTO
Returns messages in a chat. Automatically calls openChat. Returns result in reverse chronological order, i.e. in order of decreasing message.message_id
### Params:
| Name | Type | Required | Description |
|----------|:-------------:|:--------:|------------:|
|chat\_id|[InputPeer](../types/InputPeer.md) | Yes|Chat identifier|
|from\_message\_id|[long](../types/long.md) | Yes|Identifier of the message near which we need a history, you can use 0 to get results from the beginning, i.e. from oldest to newest|
|offset|[int](../types/int.md) | Yes|Specify 0 to get results exactly from from_message_id or negative offset to get specified message and some newer messages|
|limit|[int](../types/int.md) | Yes|Maximum number of messages to be returned, should be positive and can't be greater than 100. If offset is negative, limit must be greater than -offset. There may be less than limit messages returned even the end of the history is not reached|
### Return type: [Messages](../types/Messages.md)
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
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 = $MadelineProto->getChatHistory(['chat_id' => InputPeer, 'from_message_id' => long, 'offset' => int, 'limit' => int, ]);
```
2017-07-23 16:11:02 +02:00
Or, if you're using [PWRTelegram](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - getChatHistory
2017-07-23 16:33:46 +02:00
* params - {"chat_id": InputPeer, "from_message_id": long, "offset": int, "limit": int, }
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/getChatHistory`
Parameters:
chat_id - Json encoded InputPeer
from_message_id - Json encoded long
offset - Json encoded int
limit - Json encoded int
```
Or, if you're into Lua:
```
Messages = getChatHistory({chat_id=InputPeer, from_message_id=long, offset=int, limit=int, })
```