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.

contacts.ResolveUsername

Resolve a @username to get peer info

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.contacts.ResolveUsername({
      username: "some string here",
    })
  );
  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.contacts.ResolvedPeer = await client.invoke(
    new Api.contacts.ResolveUsername({
      username: "some string here",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
usernamestring@username to resolve

Result

contacts.ResolvedPeer

Possible errors

CodeTypeDescription
400CONNECTION_LAYER_INVALIDLayer invalid.
400USERNAME_INVALIDThe provided username is not valid.
400USERNAME_NOT_OCCUPIEDThe provided username is not occupied.

Can bots use this method?

Yes