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
Name | Type | Description |
---|---|---|
flags | # | Flags, see TL conditional fields |
revoked | flags.3?true | Whether to fetch revoked chat invites |
peer | InputPeer | Chat |
adminId | InputUser | Whether to only fetch chat invites from this admin |
offsetDate | flags.2?int | Offsets for pagination, for more info click here |
offsetLink | flags.2?string | Offsets for pagination, for more info click here |
limit | int | Maximum number of results to return, see pagination |
Result
Possible errors
Code | Type | Description |
---|---|---|
400 | ADMIN_ID_INVALID | The specified admin ID is invalid. |
400 | CHAT_ADMIN_REQUIRED | You must be an admin in this chat to do this. |
400 | PEER_ID_INVALID | The provided peer id is invalid. |
Can bots use this method?
No
Related pages
Pagination in the API
How to fetch results from large lists of objects.