apitelegraf

How to get started

Install apitelegram:

$ npm i apitelegram

Install input package, we'll use it to prompt ourselves inside terminal for login information:

$ npm i input

After installation, you'll need to obtain an API ID and hash:

1. Login into your telegram account
2. Then click "API development tools" and fill your application details (only app title and short name required)
3. Finally, click "Create application"

Never share any API/authorization details, that will compromise your application and account.

When you've successfully created the application, change apiId and apiHash on what you got from telegram.

Then run this code to send a message to yourself.

import { TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";
import input from "input";

const apiId = 123456;
const apiHash = "YOUR_API_HASH";
const stringSession = new StringSession(""); 

(async () => {
  console.log("Loading interactive example...");
  const client = new TelegramClient(stringSession, apiId, apiHash, {
    connectionRetries: 5,
  });
  await client.start({
    phoneNumber: async () => await input.text("Please enter your number: "),
    password: async () => await input.text("Please enter your password: "),
    phoneCode: async () =>
      await input.text("Please enter the code you received: "),
    onError: (err) => console.log(err),
  });
  console.log("You should now be connected.");
  console.log(client.session.save());
  await client.sendMessage("me", { message: "Hello!" });
})();

Note that you can also save auth key to a folder instead of a string, change stringSession into this:

const storeSession = new StoreSession("folder_name");

Be sure to save output of client.session.save() into stringSession or storeSession variable to avoid logging in again.

Running GramJS inside browsers

GramJS works great in combination with frontend libraries such as React, Vue and others.

While working within browsers, GramJS is using localStorage to cache the layers.

To get a browser bundle of GramJS, use the following command:

NODE_ENV=production npx webpack

You can also use the helpful script generate_webpack.js

node generate_webpack.js