GramJS

contacts.GetBlocked

Returns the list of blocked users.

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.contacts.GetBlocked({
      offset: 43,
      limit: 100,
    })
  );
  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.contacts.Blocked = await client.invoke(
    new Api.contacts.GetBlocked({
      offset: 43,
      limit: 100,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
offsetintThe number of list elements to be skipped
limitintThe number of list elements to be returned

Result

contacts.Blocked

Possible errors

CodeTypeDescription

Can bots use this method?

No