GramJS

messages.ReadMentions

Get unread messages where we were mentioned

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.ReadMentions({
      peer: "username",
    })
  );
  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.AffectedHistory = await client.invoke(
    new Api.messages.ReadMentions({
      peer: "username",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
peerInputPeerPeer where to look for mentions
offsetIdintOffsets for pagination, for more info click here
addOffsetintOffsets for pagination, for more info click here
limitintMaximum number of results to return, see pagination
maxIdintMaximum message ID to return, see pagination
minIdintMinimum message ID to return, see pagination

Result

messages.Messages

Possible errors

CodeTypeDescription
400CHANNEL_INVALIDThe provided channel is invalid
400CHANNEL_PRIVATEYou haven't joined this channel/supergroup
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.