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.SignIn

Signs in a user with a validated phone number.

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.SignIn({
      phoneNumber: "some string here",
      phoneCodeHash: "some string here",
      phoneCode: "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.auth.Authorization = await client.invoke(
    new Api.auth.SignIn({
      phoneNumber: "some string here",
      phoneCodeHash: "some string here",
      phoneCode: "some string here",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
phoneNumberstringPhone number in the international format
phoneCodeHashstringSMS-message ID, obtained from auth.sendCode
phoneCodestringValid numerical code from the SMS-message

Result

Returns an auth.Authorization object with information on the new authorization.

Possible errors

CodeTypeDescription
400PHONE_CODE_EMPTYphone_code is missing.
400PHONE_CODE_EXPIREDThe phone code you provided has expired.
400PHONE_CODE_INVALIDThe provided phone code is invalid.
406PHONE_NUMBER_INVALIDThe phone number is invalid.
400PHONE_NUMBER_UNOCCUPIEDThe phone number is not yet being used.
500SIGN_IN_FAILEDFailure while signing in.

Can bots use this method?

No

auth.sendCode

Send the verification code for login