1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-15 09:56:54 +01:00
MadelineProto/docs/API_docs/methods/messages_search.md

100 lines
2.7 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: messages.search
description: messages.search parameters, return type and example
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: messages.search
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|peer|[InputPeer](../types/InputPeer.md) | Optional|
|q|[string](../types/string.md) | Yes|
2017-06-30 15:36:33 +02:00
|from\_id|[InputUser](../types/InputUser.md) | Optional|
|filter|[MessagesFilter](../types/MessagesFilter.md) | Yes|
|min\_date|[int](../types/int.md) | Yes|
|max\_date|[int](../types/int.md) | Yes|
|offset\_id|[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|
2016-12-19 18:35:27 +01:00
### 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|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$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->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, ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
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:
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
from_id - Json encoded InputUser
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
offset_id - Json encoded int
2017-08-20 19:09:52 +02:00
add_offset - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
limit - Json encoded int
max_id - Json encoded int
min_id - 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:
```
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, })
```