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.

auth.ExportLoginToken

Generate a login token, for login via QR code.

The generated login token should be encoded using base64url, then shown as a tg://login?token=base64encodedtoken URL in the QR code.

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.auth.ExportLoginToken({
      apiId: 43,
      apiHash: "some string here",
      exceptIds: [BigInt("-4156887774564")],
    })
  );
  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.auth.LoginToken = await client.invoke(
    new Api.auth.ExportLoginToken({
      apiId: 43,
      apiHash: "some string here",
      exceptIds: [BigInt("-4156887774564")],
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
apiIdintApplication identifier (see. App configuration)
apiHashstringApplication identifier hash (see. App configuration)
exceptIdsVector<long>List of already logged-in user IDs, to prevent logging in twice with the same user

Result

auth.LoginToken

Possible errors

CodeTypeDescription
400API_ID_INVALIDAPI ID invalid.

Can bots use this method?

No

Login via QR code

QR code login flow