Search for messages and peers globally
API section: Working with messages
messages.searchGlobal#4bc6589a flags:# broadcasts_only:flags.1?true groups_only:flags.2?true users_only:flags.3?true folder_id:flags.0?int q:string filter:MessagesFilter min_date:int max_date:int offset_rate:int offset_peer:InputPeer offset_id:int limit:int = messages.Messages;
| Name | Type | Description |
|---|---|---|
| flags | # | Bit mask: a field written flags.N?T is present only when bit N is set. |
| broadcasts_only | flags.1?true | |
| groups_only | flags.2?true | |
| users_only | flags.3?true | |
| folder_id | flags.0?int | Folder number: 0 is the main list, 1 is the archive. |
| q | string | Search query. |
| filter | MessagesFilter | Selection filter. |
| min_date | int | |
| max_date | int | |
| offset_rate | int | |
| offset_peer | InputPeer | Peer to continue the selection from. |
| offset_id | int | Identifier to continue the selection from. |
| limit | int | Maximum number of records to return. |
This method has no errors of its own: it either answers or fails on the shared checks below.
| Code | Type | What it means |
|---|---|---|
| 401 | AUTH_KEY_UNREGISTERED |
The server does not know this session: the key was revoked, expired, or the call was made before authorisation. |
| 401 | API_ID_INVALID |
This api_id was never issued or has been blocked. Keys come from my.ansible.su. |
| 400 | CONNECTION_LAYER_INVALID |
The client did not declare a layer, or declared one the server does not know. |
| 420 | FLOOD_WAIT_X |
Too often. Do not retry for X seconds — the number arrives in the error text. |
| 500 | INTERNAL |
A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours. |
This call counts as expensive: its cost grows with the amount of data, so under peak load it goes through admission control and may answer
FLOOD_WAITwhere cheap calls always pass. Build retries with a backoff.