GramJS

⚠️ This project is archived and no longer maintained. Development continues in teleproto, an actively maintained fork. It's largely compatible with GramJS for most projects, migration means little more than swapping the package:
npm install teleproto
See the migration guide for details.

messages.Search

Returns users found by username substring.

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: BigInt("-4156887774564"),
      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: BigInt("-4156887774564"),
      fromId: "username",
      topMsgId: 43,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
qstringTarget substring
limitintMaximum number of users to be returned

Result

contacts.Found

Possible errors

CodeTypeDescription
400QUERY_TOO_SHORTThe query string is too short.
400SEARCH_QUERY_EMPTYThe search query is empty.

Can bots use this method?

No