90 lines
2.3 KiB
Markdown
90 lines
2.3 KiB
Markdown
|
---
|
||
|
title: messages.getHistory
|
||
|
description: messages.getHistory parameters, return type and example
|
||
|
---
|
||
|
## Method: messages.getHistory
|
||
|
[Back to methods index](index.md)
|
||
|
|
||
|
|
||
|
### Parameters:
|
||
|
|
||
|
| Name | Type | Required |
|
||
|
|----------|---------------|----------|
|
||
|
|peer|[InputPeer](../types/InputPeer.md) | Optional|
|
||
|
|offset\_id|[int](../types/int.md) | Yes|
|
||
|
|offset\_date|[int](../types/int.md) | Yes|
|
||
|
|add\_offset|[int](../types/int.md) | Yes|
|
||
|
|limit|[int](../types/int.md) | Yes|
|
||
|
|max\_id|[int](../types/int.md) | Yes|
|
||
|
|min\_id|[int](../types/int.md) | Yes|
|
||
|
|hash|[int](../types/int.md) | Yes|
|
||
|
|
||
|
|
||
|
### Return type: [messages\_Messages](../types/messages_Messages.md)
|
||
|
|
||
|
### Can bots use this method: **NO**
|
||
|
|
||
|
|
||
|
### Errors this method can return:
|
||
|
|
||
|
| Error | Description |
|
||
|
|----------|---------------|
|
||
|
|CHANNEL_INVALID|The provided channel is invalid|
|
||
|
|CHANNEL_PRIVATE|You haven't joined this channel/supergroup|
|
||
|
|CHAT_ID_INVALID|The provided chat id is invalid|
|
||
|
|PEER_ID_INVALID|The provided peer id is invalid|
|
||
|
|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
|
||
|
|Timeout|A timeout occurred while fetching data from the bot|
|
||
|
|
||
|
|
||
|
### Example:
|
||
|
|
||
|
|
||
|
```
|
||
|
$MadelineProto = new \danog\MadelineProto\API();
|
||
|
$MadelineProto->session = 'mySession.madeline';
|
||
|
if (isset($number)) { // Login as a user
|
||
|
$MadelineProto->phone_login($number);
|
||
|
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
|
||
|
$MadelineProto->complete_phone_login($code);
|
||
|
}
|
||
|
|
||
|
$messages_Messages = $MadelineProto->messages->getHistory(['peer' => InputPeer, 'offset_id' => int, 'offset_date' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => int, ]);
|
||
|
```
|
||
|
|
||
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
||
|
|
||
|
|
||
|
|
||
|
### As a user:
|
||
|
|
||
|
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getHistory`
|
||
|
|
||
|
Parameters:
|
||
|
|
||
|
peer - Json encoded InputPeer
|
||
|
|
||
|
offset_id - Json encoded int
|
||
|
|
||
|
offset_date - Json encoded int
|
||
|
|
||
|
add_offset - Json encoded int
|
||
|
|
||
|
limit - Json encoded int
|
||
|
|
||
|
max_id - Json encoded int
|
||
|
|
||
|
min_id - Json encoded int
|
||
|
|
||
|
hash - Json encoded int
|
||
|
|
||
|
|
||
|
|
||
|
|
||
|
Or, if you're into Lua:
|
||
|
|
||
|
```
|
||
|
messages_Messages = messages.getHistory({peer=InputPeer, offset_id=int, offset_date=int, add_offset=int, limit=int, max_id=int, min_id=int, hash=int, })
|
||
|
```
|
||
|
|