GramJS

messages.GetExportedChatInvites

Get info about the chat invites of a specific 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.GetExportedChatInvites({
      peer: "username",
      adminId: "username",
      limit: 100,
      revoked: true,
      offsetDate: 43,
      offsetLink: "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.messages.ExportedChatInvites = await client.invoke(
    new Api.messages.GetExportedChatInvites({
      peer: "username",
      adminId: "username",
      limit: 100,
      revoked: true,
      offsetDate: 43,
      offsetLink: "some string here",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
flags#Flags, see TL conditional fields
revokedflags.3?trueWhether to fetch revoked chat invites
peerInputPeerChat
adminIdInputUserWhether to only fetch chat invites from this admin
offsetDateflags.2?intOffsets for pagination, for more info click here
offsetLinkflags.2?stringOffsets for pagination, for more info click here
limitintMaximum number of results to return, see pagination

Result

messages.ExportedChatInvites

Possible errors

CodeTypeDescription
400ADMIN_ID_INVALIDThe specified admin ID is invalid.
400CHAT_ADMIN_REQUIREDYou must be an admin in this chat to do this.
400PEER_ID_INVALIDThe provided peer id is invalid.

Can bots use this method?

No

Pagination in the API

How to fetch results from large lists of objects.