69 lines
2.8 KiB
Markdown
69 lines
2.8 KiB
Markdown
|
---
|
||
|
|
title: messages.search
|
||
|
|
description: Search peers or messages
|
||
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||
|
|
---
|
||
|
|
# Method: messages.search
|
||
|
|
[Back to methods index](index.md)
|
||
|
|
|
||
|
|
|
||
|
|
Search peers or messages
|
||
|
|
|
||
|
|
### Parameters:
|
||
|
|
|
||
|
|
| Name | Type | Description | Required |
|
||
|
|
|----------|---------------|-------------|----------|
|
||
|
|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Where to search | Optional|
|
||
|
|
|q|[string](../types/string.md) | What to search | Yes|
|
||
|
|
|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Show only messages from a certain user? | Optional|
|
||
|
|
|filter|[MessagesFilter](../types/MessagesFilter.md) | Message filter | Optional|
|
||
|
|
|min\_date|[int](../types/int.md) | Minumum date of results to fetch | Yes|
|
||
|
|
|max\_date|[int](../types/int.md) | Maximum date of results to fetch | Yes|
|
||
|
|
|offset\_id|[int](../types/int.md) | Message ID offset | Yes|
|
||
|
|
|add\_offset|[int](../types/int.md) | Additional offset, can be 0 | Yes|
|
||
|
|
|limit|[int](../types/int.md) | Number of results to return | Yes|
|
||
|
|
|max\_id|[int](../types/int.md) | Maximum message id to return | Yes|
|
||
|
|
|min\_id|[int](../types/int.md) | Minumum message id to return | Yes|
|
||
|
|
|hash|Array of [int](../types/int.md) | The IDs of messages you already fetched | Optional|
|
||
|
|
|
||
|
|
|
||
|
|
### Return type: [messages\_Messages](../types/messages_Messages.md)
|
||
|
|
|
||
|
|
### Can bots use this method: **NO**
|
||
|
|
|
||
|
|
|
||
|
|
### 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();
|
||
|
|
|
||
|
|
$messages_Messages = $MadelineProto->messages->search(['peer' => InputPeer, 'q' => 'string', 'from_id' => InputUser, 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset_id' => int, 'add_offset' => int, 'limit' => int, 'max_id' => int, 'min_id' => int, 'hash' => [int, int], ]);
|
||
|
|
```
|
||
|
|
|
||
|
|
Or, if you're into Lua:
|
||
|
|
|
||
|
|
```lua
|
||
|
|
messages_Messages = messages.search({peer=InputPeer, q='string', from_id=InputUser, filter=MessagesFilter, min_date=int, max_date=int, offset_id=int, add_offset=int, limit=int, max_id=int, min_id=int, hash={int}, })
|
||
|
|
```
|
||
|
|
|
||
|
|
### Errors this method can return:
|
||
|
|
|
||
|
|
| Error | Description |
|
||
|
|
|----------|---------------|
|
||
|
|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|
||
|
|
|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid|
|
||
|
|
|INPUT_USER_DEACTIVATED|The specified user was deleted|
|
||
|
|
|PEER_ID_INVALID|The provided peer id is invalid|
|
||
|
|
|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported|
|
||
|
|
|SEARCH_QUERY_EMPTY|The search query is empty|
|
||
|
|
|USER_ID_INVALID|The provided user ID is invalid|
|
||
|
|
|
||
|
|
|