MadelineProto/old_docs/API_docs_v51/methods/channels_updatePinnedMessage.md

89 lines
2.2 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: channels.updatePinnedMessage
2018-03-23 16:23:49 +01:00
description: Set the pinned message of a channel/supergroup
---
2017-01-19 23:02:27 +01:00
## Method: channels.updatePinnedMessage
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Set the pinned message of a channel/supergroup
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|silent|[CLICK ME Bool](../types/Bool.md) | Optional|Pin silently|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|id|[CLICK ME int](../types/int.md) | Yes|The ID of the message to pin|
### Return type: [Updates](../types/Updates.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01:00
### 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|
2017-11-15 13:07:42 +01:00
|CHAT_ID_INVALID|The provided chat id is invalid|
2017-11-03 17:39:50 +01:00
|CHAT_NOT_MODIFIED|The pinned message wasn't modified|
2018-03-20 19:57:36 +01:00
### 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, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - channels.updatePinnedMessage
2017-07-23 16:40:54 +02:00
* params - `{"silent": Bool, "channel": InputChannel, "id": int, }`
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.updatePinnedMessage`
Parameters:
silent - Json encoded Bool
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
channel - Json encoded InputChannel
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
id - Json encoded int
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
Updates = channels.updatePinnedMessage({silent=Bool, channel=InputChannel, id=int, })
```