GramJS

messages.GetPinnedDialogs

Get pinned dialogs

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.GetPinnedDialogs({
      folderId: 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.messages.PeerDialogs = await client.invoke(
    new Api.messages.GetPinnedDialogs({
      folderId: 43,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
folderIdintPeer folder ID, for more info click here

Result

messages.PeerDialogs

Possible errors

CodeTypeDescription
400FOLDER_ID_INVALIDInvalid folder ID

Can bots use this method?

No

Folders

Telegram allows placing chats into folders, based on their type, mute status, or other custom criteria, thanks to folder blacklists and whitelists.