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
Name | Type | Description |
---|---|---|
phoneNumber | string | Phone number in the international format |
phoneCodeHash | string | SMS-message ID, obtained from auth.sendCode |
phoneCode | string | Valid numerical code from the SMS-message |
Result
Returns an auth.Authorization object with information on the new authorization.
Possible errors
Code | Type | Description |
---|---|---|
400 | PHONE_CODE_EMPTY | phone_code is missing. |
400 | PHONE_CODE_EXPIRED | The phone code you provided has expired. |
400 | PHONE_CODE_INVALID | The provided phone code is invalid. |
406 | PHONE_NUMBER_INVALID | The phone number is invalid. |
400 | PHONE_NUMBER_UNOCCUPIED | The phone number is not yet being used. |
500 | SIGN_IN_FAILED | Failure while signing in. |
Can bots use this method?
No
Related pages
auth.sendCode
Send the verification code for login