MadelineProto/old_docs/API_docs_v51/methods/messages_searchGlobal.md

83 lines
2.0 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.searchGlobal
2018-03-23 16:23:49 +01:00
description: Global message search
---
2017-01-19 23:02:27 +01:00
## Method: messages.searchGlobal
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Global message search
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|q|[CLICK ME string](../types/string.md) | Yes|The query|
|offset\_date|[CLICK ME int](../types/int.md) | Yes|0 or the date offset|
|offset\_peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Optional|0 or the peer offset|
|offset\_id|[CLICK ME int](../types/int.md) | Yes|0 or the message ID offset|
|limit|[CLICK ME int](../types/int.md) | Yes|The 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 |
|----------|---------------|
|SEARCH_QUERY_EMPTY|The search query is empty|
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';
// !!! 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();
2017-07-23 16:33:46 +02:00
$messages_Messages = $MadelineProto->messages->searchGlobal(['q' => 'string', 'offset_date' => int, 'offset_peer' => InputPeer, 'offset_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.searchGlobal`
Parameters:
q - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
offset_date - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
offset_peer - Json encoded InputPeer
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
offset_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.searchGlobal({q='string', offset_date=int, offset_peer=InputPeer, offset_id=int, limit=int, })
```