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.

messages.ImportChatInvite

Import a chat invite and join a private chat/supergroup/channel

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.messages.ImportChatInvite({
      hash: "B5MnlS34H1JKyBE71zZfo1",
    })
  );
  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.Updates = await client.invoke(
    new Api.messages.ImportChatInvite({
      hash: "B5MnlS34H1JKyBE71zZfo1",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
hashstringhash from t.me/joinchat/hash

Result

Updates

Possible errors

CodeTypeDescription
400CHANNELS_TOO_MUCHYou have joined too many channels/supergroups.
400CHANNEL_INVALIDThe provided channel is invalid.
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup.
400CHAT_INVALIDInvalid chat.
400INVITE_HASH_EMPTYThe invite hash is empty.
406INVITE_HASH_EXPIREDThe invite link has expired.
400INVITE_HASH_INVALIDThe invite hash is invalid.
400INVITE_REQUEST_SENTYou have successfully requested to join this chat or channel.
400MSG_ID_INVALIDInvalid message ID provided.
400PEER_ID_INVALIDThe provided peer id is invalid.
400USERS_TOO_MUCHThe maximum number of users has been exceeded (to create a chat, for example).
400USER_ALREADY_PARTICIPANTThe user is already in the group.
400USER_CHANNELS_TOO_MUCHOne of the users you tried to add is already in too many channels/supergroups.

Can bots use this method?

No