MadelineProtoDocs/old_docs/API_docs_v89/methods/messages.search.md

72 lines
3.5 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: messages.search
2019-12-27 17:48:04 +01:00
description: Gets back found messages
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_search.html
2019-06-23 13:07:51 +02:00
---
# Method: messages.search
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Gets back found messages
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | User or chat, histories with which are searched, or [(inputPeerEmpty)](../constructors/inputPeerEmpty.md) constructor for global search | Optional|
|q|[string](../types/string.md) | Text search request | Yes|
|from\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Only return messages sent by the specified user ID | Optional|
|filter|[MessagesFilter](../types/MessagesFilter.md) | Filter to return only specified message types | Optional|
|min\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date bigger than the transferred one will be returned | Yes|
|max\_date|[int](../types/int.md) | If a positive value was transferred, only messages with a sending date smaller than the transferred one will be returned | Yes|
|offset\_id|[int](../types/int.md) | Only return messages starting from the specified message ID | Yes|
|add\_offset|[int](../types/int.md) | [Additional offset](https://core.telegram.org/api/offsets) | Yes|
|limit|[int](../types/int.md) | [Number of results to return](https://core.telegram.org/api/offsets) | Yes|
|max\_id|[int](../types/int.md) | [Maximum message ID to return](https://core.telegram.org/api/offsets) | Yes|
|min\_id|[int](../types/int.md) | [Minimum message ID to return](https://core.telegram.org/api/offsets) | Yes|
2019-06-23 13:07:51 +02:00
|hash|Array of [int](../types/int.md) | The IDs of messages you already fetched | Optional|
2019-12-27 18:25:37 +01:00
### Return type: [messages.Messages](../types/messages.Messages.md)
2019-06-23 13:07:51 +02:00
### 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();
2019-12-27 18:25:37 +01:00
$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], ]);
2019-06-23 13:07:51 +02:00
```
Or, if you're into Lua:
```lua
2019-12-27 18:25:37 +01:00
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}, })
2019-06-23 13:07:51 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
2019-12-27 17:48:04 +01:00
|400|CHANNEL_INVALID|The provided channel is invalid|
2019-09-02 17:41:28 +02:00
|400|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|400|INPUT_CONSTRUCTOR_INVALID|The provided constructor is invalid|
|400|INPUT_USER_DEACTIVATED|The specified user was deleted|
|400|PEER_ID_INVALID|The provided peer id is invalid|
|400|PEER_ID_NOT_SUPPORTED|The provided peer ID is not supported|
|400|SEARCH_QUERY_EMPTY|The search query is empty|
|400|USER_ID_INVALID|The provided user ID is invalid|
2019-12-27 17:48:04 +01:00
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
2019-06-23 13:07:51 +02:00