MadelineProto/old_docs/API_docs_v65/methods/channels_updatePinnedMessage.md

2.2 KiB

title description
channels.updatePinnedMessage Set the pinned message of a channel/supergroup

Method: channels.updatePinnedMessage

Back to methods index

Set the pinned message of a channel/supergroup

Parameters:

Name Type Required Description
silent CLICK ME Bool Optional Pin silently
channel Username, chat ID, Update, Message or InputChannel Optional The channel/supergroup
id CLICK ME int Yes The ID of the message to pin

Return type: Updates

Can bots use this method: YES

Errors this method can return:

Error Description
CHANNEL_INVALID The provided channel is invalid
CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this
CHAT_ID_INVALID The provided chat id is invalid
CHAT_NOT_MODIFIED The pinned message wasn't modified

MadelineProto Example:

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';

$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();

$Updates = $MadelineProto->channels->updatePinnedMessage(['silent' => Bool, 'channel' => InputChannel, 'id' => int, ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a bot:

POST/GET to https://api.pwrtelegram.xyz/botTOKEN/madeline

Parameters:

  • method - channels.updatePinnedMessage
  • params - {"silent": Bool, "channel": InputChannel, "id": int, }

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/channels.updatePinnedMessage

Parameters:

silent - Json encoded Bool

channel - Json encoded InputChannel

id - Json encoded int

Or, if you're into Lua:

Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, })