GramJS

⚠️ This project is archived and no longer maintained. Development continues in teleproto, an actively maintained fork. It's largely compatible with GramJS for most projects, migration means little more than swapping the package:
npm install teleproto
See the migration guide for details.

messages.GetCommonChats

Get chats in common with a user

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.GetCommonChats({
      userId: "username",
      maxId: 0,
      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.messages.Chats = await client.invoke(
    new Api.messages.GetCommonChats({
      userId: "username",
      maxId: 0,
      limit: 100,
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
userIdInputUserUser ID
maxIdlongMaximum ID of chat to return (see pagination)
limitintMaximum number of results to return, see pagination

Result

messages.Chats

Possible errors

CodeTypeDescription
400MSG_ID_INVALIDInvalid message ID provided.
400USER_ID_INVALIDThe provided user ID is invalid.

Can bots use this method?

No

Pagination in the API

How to fetch results from large lists of objects.