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

Registers a validated phone number in the system.

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.SignUp({
      phoneNumber: "some string here",
      phoneCodeHash: "some string here",
      firstName: "some string here",
      lastName: "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.SignUp({
      phoneNumber: "some string here",
      phoneCodeHash: "some string here",
      firstName: "some string here",
      lastName: "some string here",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
phoneNumberstringPhone number in the international format
phoneCodeHashstringSMS-message ID
firstNamestringNew user first name
lastNamestringNew user last name

Result

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

Possible errors

CodeTypeDescription
400FIRSTNAME_INVALIDThe first name is invalid.
400LASTNAME_INVALIDThe last name is invalid.
400PHONE_CODE_EMPTYphone_code is missing.
400PHONE_CODE_EXPIREDThe phone code you provided has expired.
400PHONE_CODE_INVALIDThe provided phone code is invalid.
400PHONE_NUMBER_FLOODYou asked for the code too many times.
406PHONE_NUMBER_INVALIDThe phone number is invalid.
400PHONE_NUMBER_OCCUPIEDThe phone number is already in use.

Can bots use this method?

No