GramJS

messages.GetGameHighScores

Get highscores of a game

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

Parameters

NameTypeDescription
peerInputPeerWhere was the game sent
idintID of message with game media attachment
userIdInputUserGet high scores made by a certain user

Result

messages.HighScores

Possible errors

CodeTypeDescription
400MESSAGE_ID_INVALIDThe provided message id is invalid.
400PEER_ID_INVALIDThe provided peer id is invalid.
400USER_BOT_REQUIREDThis method can only be called by a bot.

Can bots use this method?

Yes