messages.SearchGlobal
Search for messages and peers globally
Example
const { Api, TelegramClient } = require("telegram");
const { StringSession } = require("telegram/sessions");
const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});
(async function run() {
await client.connect(); // This assumes you have already authenticated with .start()
const result = await client.invoke(
new Api.messages.SearchGlobal({
q: "some string here",
filter: new Api.InputMessagesFilterPhotos({}),
minDate: 43,
maxDate: 43,
offsetRate: 43,
offsetPeer: "username",
offsetId: 43,
limit: 100,
folderId: 43,
})
);
console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";
const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});
(async function run() {
await client.connect(); // This assumes you have already authenticated with .start()
const result: Api.messages.Messages = await client.invoke(
new Api.messages.SearchGlobal({
q: "some string here",
filter: new Api.InputMessagesFilterPhotos({}),
minDate: 43,
maxDate: 43,
offsetRate: 43,
offsetPeer: "username",
offsetId: 43,
limit: 100,
folderId: 43,
})
);
console.log(result); // prints the result
})();
Parameters
Name | Type | Description |
---|---|---|
flags | # | Flags, see TL conditional fields |
folderId | flags.0?int | Peer folder ID, for more info click here |
q | string | Query |
filter | MessagesFilter | Global search filter |
minDate | int | If a positive value was specified, the method will return only messages with date bigger than min_date |
maxDate | int | If a positive value was transferred, the method will return only messages with date smaller than max_date |
offsetRate | int | Initially 0, then set to the next_rate parameter of messages.messagesSlice |
offsetPeer | InputPeer | Offsets for pagination, for more info click here |
offsetId | int | Offsets for pagination, for more info click here |
limit | int | Offsets for pagination, for more info click here |
Result
Possible errors
Code | Type | Description |
---|---|---|
400 | FOLDER_ID_INVALID | Invalid folder ID. |
400 | SEARCH_QUERY_EMPTY | The search query is empty. |
Can bots use this method?
No
Related pages
Folders
Telegram allows placing chats into folders, based on their type, mute status, or other custom criteria, thanks to folder blacklists and whitelists.
messages.messagesSlice
Incomplete list of messages and auxiliary data.
Pagination in the API
How to fetch results from large lists of objects.