MadelineProtoDocs/old_docs/API_docs_v44/methods/messages_search.md

97 lines
2.7 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.search
description: Search peers or messages
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.search
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Search peers or messages
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-04-01 13:24:46 +02:00
|important\_only|[Bool](../types/Bool.md) | Optional|Show only important messages|
2018-04-01 13:19:25 +02:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search|
|q|[string](../types/string.md) | Yes|What to search|
|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter|
|min\_date|[int](../types/int.md) | Yes|Minumum date of results to fetch|
|max\_date|[int](../types/int.md) | Yes|Maximum date of results to fetch|
2018-04-01 13:24:46 +02:00
|offset|[int](../types/int.md) | Yes|Offset |
2018-04-01 13:19:25 +02:00
|max\_id|[int](../types/int.md) | Yes|Maximum message id to return|
2018-04-01 13:24:46 +02:00
|limit|[int](../types/int.md) | Yes|Number of results to return|
2018-04-01 13:19:25 +02:00
### Return type: [messages\_Messages](../types/messages_Messages.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```
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();
2018-04-01 13:24:46 +02:00
$messages_Messages = $MadelineProto->messages->search(['important_only' => Bool, 'peer' => InputPeer, 'q' => 'string', 'filter' => MessagesFilter, 'min_date' => int, 'max_date' => int, 'offset' => int, 'max_id' => int, 'limit' => int, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.search`
Parameters:
2018-04-01 13:24:46 +02:00
important_only - Json encoded Bool
2018-04-01 13:19:25 +02:00
peer - Json encoded InputPeer
q - Json encoded string
filter - Json encoded MessagesFilter
min_date - Json encoded int
max_date - Json encoded int
2018-04-01 13:24:46 +02:00
offset - Json encoded int
2018-04-01 13:19:25 +02:00
max_id - Json encoded int
2018-04-01 13:24:46 +02:00
limit - Json encoded int
2018-04-01 13:19:25 +02:00
Or, if you're into Lua:
```
2018-04-01 13:24:46 +02:00
messages_Messages = messages.search({important_only=Bool, peer=InputPeer, q='string', filter=MessagesFilter, min_date=int, max_date=int, offset=int, max_id=int, limit=int, })
2018-04-01 13:19:25 +02:00
```
### 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|