messages.GetSearchResultsPositions
Returns sparse positions of messages of the specified type in the chat to be used for shared media scroll implementation.
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.GetSearchResultsPositions({
peer: "username",
filter: new Api.InputMessagesFilterPhotos({}),
offsetId: 43,
limit: 100,
})
);
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.SearchResultsPositions = await client.invoke(
new Api.messages.GetSearchResultsPositions({
peer: "username",
filter: new Api.InputMessagesFilterPhotos({}),
offsetId: 43,
limit: 100,
})
);
console.log(result); // prints the result
})();
Parameters
Name | Type | Description |
---|---|---|
peer | InputPeer | Peer where to search |
filter | MessagesFilter | Message filter, inputMessagesFilterEmpty, inputMessagesFilterMyMentions filters are not supported by this method. |
offsetId | int | Offsets for pagination, for more info click here |
limit | int | Maximum number of results to return, see pagination |
Result
messages.SearchResultsPositions
Possible errors
Code | Type | Description |
---|
Can bots use this method?
No
Related pages
inputMessagesFilterEmpty
Filter is absent.
inputMessagesFilterMyMentions
Return only messages where the current user was mentioned.
Pagination in the API
How to fetch results from large lists of objects.