GramJS

messages.ExportChatInvite

Export an invite link for a chat

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.ExportChatInvite({
      peer: "username",
      legacyRevokePermanent: true,
      expireDate: 43,
      usageLimit: 43,
    })
  );
  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.ExportedChatInvite = await client.invoke(
    new Api.messages.ExportChatInvite({
      peer: "username",
      legacyRevokePermanent: true,
      expireDate: 43,
      usageLimit: 43,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
peerInputPeerChat

Result

ExportedChatInvite

Possible errors

CodeTypeDescription
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this
400CHAT_ID_INVALIDThe provided chat id is invalid
403CHAT_WRITE_FORBIDDENYou can't write in this chat
400PEER_ID_INVALIDThe provided peer id is invalid

Can bots use this method?

Yes