2024-06-05 12:19:46 +02:00
|
|
|
---
|
|
|
|
|
sidebar_position: 4
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Pin message
|
|
|
|
|
Pins a message in the chat header
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
*Function PinMessage(Val Token, Val ChatID, Val MessageID) Export*
|
|
|
|
|
|
|
|
|
|
| Parameter | CLI option | Type | Destination |
|
|
|
|
|
|-|-|-|-|
|
|
|
|
|
| Token | --token | String | Token |
|
|
|
|
|
| ChatID | --chat | String, Number | Target chat ID |
|
|
|
|
|
| MessageID | --message | String, Number | Target message ID |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Returns: Key-Value Pair - Serialized JSON response from Telegram
|
|
|
|
|
|
|
|
|
|
```bsl title="Code example"
|
|
|
|
|
|
|
|
|
|
Token = "6129457865:AAFyzNYOAFbu...";
|
|
|
|
|
ChannelID = "@testsichee";
|
|
|
|
|
MessageID = "4951";
|
|
|
|
|
|
|
|
|
|
Result = OPI_Telegram.PinMessage(Token, ChannelID, MessageID);
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
```sh title="CLI command example"
|
|
|
|
|
|
|
|
|
|
oint telegram PinMessage --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --message "4951"
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```json title="Result"
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
"ok": true,
|
|
|
|
|
"result": true
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
```
|
