mirror of
https://github.com/danog/MadelineProto.git
synced 2024-12-13 17:27:20 +01:00
Daniil Gentili
7a0153a139
* Documentation rework * Apply fixes from StyleCI * Documentation fixes * Login as bot through web/cli API, allow using invite links in joinChannel, full invite links in importChatInvite and checkChatInvite, non-invite links in importChatInvite * Apply fixes from StyleCI * Logging fixes * Build docs * Add methods to modify start template, bugfix to logging and keyboard conversion * Add TL documentator * Document MTProto methods * Documenting methods... * 7% documented * Bugfixes * Update docs * Update docs * Simplify file management * Implement automatic object conversion for media, and more awesome stuff * Implement automatic object conversion for media, and more awesome stuff * Implement event update handler and file upload/download callback * Auto-detect mime type, duration, width and height of media * Update docs * Document new file functions * Fix links * Fix links * Update bot.php to use event loop * Implement webhook update handler and forking in main loop * Build docs * Better docs * Fixes to secret chats * Almost finished updating docs * Bugfixes, implemented infinite loop for loop() method, almost finished docs * Finish writing docs * Add automatic documentation builder script * Finished writing docs
105 lines
2.8 KiB
Markdown
105 lines
2.8 KiB
Markdown
---
|
|
title: messages.search
|
|
description: messages.search parameters, return type and example
|
|
---
|
|
## Method: messages.search
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
### Parameters:
|
|
|
|
| Name | Type | Required |
|
|
|----------|---------------|----------|
|
|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|
|
|
|q|[string](../types/string.md) | Yes|
|
|
|from\_id|[Username, chat ID, Update, Message or 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|
|
|
|
|
|
|
### Return type: [messages\_Messages](../types/messages_Messages.md)
|
|
|
|
### Can bots use this method: **NO**
|
|
|
|
|
|
### 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|
|
|
|
|
|
|
### Example:
|
|
|
|
|
|
```
|
|
if (!file_exists('madeline.php')) {
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
|
}
|
|
include 'madeline.php';
|
|
|
|
// !!! This API id/API hash combination will not work !!!
|
|
// !!! You must get your own @ my.telegram.org !!!
|
|
$api_id = 0;
|
|
$api_hash = '';
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
|
|
$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, ]);
|
|
```
|
|
|
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
|
|
|
|
|
|
|
### As a user:
|
|
|
|
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.search`
|
|
|
|
Parameters:
|
|
|
|
peer - Json encoded InputPeer
|
|
|
|
q - Json encoded string
|
|
|
|
from_id - Json encoded InputUser
|
|
|
|
filter - Json encoded MessagesFilter
|
|
|
|
min_date - Json encoded int
|
|
|
|
max_date - Json encoded int
|
|
|
|
offset_id - Json encoded int
|
|
|
|
add_offset - Json encoded int
|
|
|
|
limit - Json encoded int
|
|
|
|
max_id - Json encoded int
|
|
|
|
min_id - Json encoded int
|
|
|
|
|
|
|
|
|
|
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, })
|
|
```
|
|
|