messages.UpdatePinnedMessage
Pin a message
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.UpdatePinnedMessage({
peer: "username",
id: 43,
unpin: true,
pmOneside: true,
})
);
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.Updates = await client.invoke(
new Api.messages.UpdatePinnedMessage({
peer: "username",
id: 43,
unpin: true,
pmOneside: true,
})
);
console.log(result); // prints the result
})();
Parameters
Name | Type | Description |
---|---|---|
flags | # | Flags, see TL conditional fields |
silent | flags.0?true | Pin the message silently, without triggering a notification |
unpin | flags.1?true | Whether the message should unpinned or pinned |
pmOneside | flags.2?true | Whether the message should only be pinned on the local side of a one-to-one chat |
peer | InputPeer | The peer where to pin the message |
id | int | The message to pin or unpin |
Result
Possible errors
Code | Type | Description |
---|---|---|
400 | BOT_ONESIDE_NOT_AVAIL | Bots can't pin messages in PM just for themselves. |
400 | CHANNEL_PRIVATE | You haven't joined this channel/supergroup. |
400 | CHAT_ADMIN_REQUIRED | You must be an admin in this chat to do this. |
400 | CHAT_NOT_MODIFIED | The pinned message wasn't modified. |
403 | CHAT_WRITE_FORBIDDEN | You can't write in this chat. |
400 | MESSAGE_ID_INVALID | The provided message id is invalid. |
400 | PEER_ID_INVALID | The provided peer id is invalid. |
400 | PIN_RESTRICTED | You can't pin messages. |
400 | USER_BANNED_IN_CHANNEL | You're banned from sending messages in supergroups/channels. |
Can bots use this method?
Yes