1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-14 08:07:20 +01:00
MadelineProto/old_docs/API_docs_v70/methods/channels_updatePinnedMessage.md

87 lines
2.1 KiB
Markdown
Raw Normal View History

---
title: channels.updatePinnedMessage
description: channels.updatePinnedMessage parameters, return type and example
---
## Method: channels.updatePinnedMessage
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
2018-03-20 16:42:05 +01:00
|silent|[CLICK ME Bool](../types/Bool.md) | Optional|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|
2018-03-20 16:42:05 +01:00
|id|[CLICK ME int](../types/int.md) | Yes|
### 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, ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) 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, })
```