GramJS

messages.Search

Search for GIFs

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.Search({
      peer: "username",
      q: "some string here",
      filter: new Api.InputMessagesFilterPhotos({}),
      minDate: 43,
      maxDate: 43,
      offsetId: 43,
      addOffset: 0,
      limit: 100,
      maxId: 0,
      minId: 0,
      hash: 0,
      fromId: "username",
      topMsgId: 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.Search({
      peer: "username",
      q: "some string here",
      filter: new Api.InputMessagesFilterPhotos({}),
      minDate: 43,
      maxDate: 43,
      offsetId: 43,
      addOffset: 0,
      limit: 100,
      maxId: 0,
      minId: 0,
      hash: 0,
      fromId: "username",
      topMsgId: 43,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
qstringText query
offsetintOffset for pagination ยป

Result

messages.FoundGifs

Possible errors

CodeTypeDescription
400SEARCH_QUERY_EMPTYThe search query is empty

Can bots use this method?

No

Pagination in the API

How to fetch results from large lists of objects.