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.

channels.InviteToChannel

Invite users to a channel/supergroup

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.channels.InviteToChannel({
      channel: "username",
      users: ["username"],
    })
  );
  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.channels.InviteToChannel({
      channel: "username",
      users: ["username"],
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
channelInputChannelChannel/supergroup
usersVector<InputUser>Users to invite

Result

Updates

Possible errors

CodeTypeDescription
400BOTS_TOO_MUCHThere are too many bots in this chat/channel.
400BOT_GROUPS_BLOCKEDThis bot can't be added to groups.
400CHANNEL_INVALIDThe provided channel is invalid.
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup.
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this.
400CHAT_INVALIDInvalid chat.
403CHAT_WRITE_FORBIDDENYou can't write in this chat.
400INPUT_USER_DEACTIVATEDThe specified user was deleted.
400MSG_ID_INVALIDInvalid message ID provided.
400USERS_TOO_MUCHThe maximum number of users has been exceeded (to create a chat, for example).
400USER_BANNED_IN_CHANNELYou're banned from sending messages in supergroups/channels.
400USER_BLOCKEDUser blocked.
400USER_BOTBots can only be admins in channels.
403USER_CHANNELS_TOO_MUCHOne of the users you tried to add is already in too many channels/supergroups.
400USER_ID_INVALIDThe provided user ID is invalid.
400USER_KICKEDThis user was kicked from this supergroup/channel.
403USER_NOT_MUTUAL_CONTACTThe provided user is not a mutual contact.
403USER_PRIVACY_RESTRICTEDThe user's privacy settings do not allow you to do this.

Can bots use this method?

No