MadelineProto/old_docs/API_docs_v51/methods/messages_search.md

96 lines
2.7 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.search
2018-03-23 12:35:00 +01:00
description: Search peers or messages
---
2017-01-19 23:02:27 +01:00
## Method: messages.search
[Back to methods index](index.md)
2018-03-23 12:35:00 +01:00
Search peers or messages
### Parameters:
2018-03-23 12:35:00 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-23 17:44:33 +01:00
|important\_only|[CLICK ME Bool](../types/Bool.md) | Optional|Show only important messages|
2018-03-23 12:35:00 +01:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|Where to search|
|q|[CLICK ME string](../types/string.md) | Yes|What to search|
|filter|[CLICK ME MessagesFilter](../types/MessagesFilter.md) | Yes|Message filter|
|min\_date|[CLICK ME int](../types/int.md) | Yes|Minumum date of results to fetch|
|max\_date|[CLICK ME int](../types/int.md) | Yes|Maximum date of results to fetch|
2018-03-23 17:44:33 +01:00
|offset|[CLICK ME int](../types/int.md) | Yes|Offset |
2018-03-23 12:35:00 +01:00
|max\_id|[CLICK ME int](../types/int.md) | Yes|Maximum message id to return|
|limit|[CLICK ME int](../types/int.md) | Yes|Number of results to return|
### Return type: [messages\_Messages](../types/messages_Messages.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
2017-11-08 13:04:40 +01:00
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
2017-11-03 17:39:50 +01:00
|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|
2018-03-20 19:57:36 +01:00
### 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();
2017-07-23 16:33: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, ]);
2017-02-13 04:33:06 +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.search`
Parameters:
important_only - Json encoded Bool
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
peer - Json encoded InputPeer
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
q - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
filter - Json encoded MessagesFilter
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
min_date - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
max_date - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
offset - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
max_id - Json encoded int
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
Or, if you're into Lua:
```
2017-07-23 16:33: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, })
```