1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2026-05-22 10:05:29 +02:00
Files
OpenIntegrations/docs/en/md/VKTeams/Message-sending/Pin-message.mdx
T
Vitaly the Alpaca (bot) 294bd2e77c Main build (Jenkins)
2024-10-15 10:50:56 +03:00

50 lines
1019 B
Plaintext

---
sidebar_position: 9
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Pin message
Pins the selected message in the chat room
`Function PinMessage(Val Token, Val ChatID, Val MessageID) Export`
| Parameter | CLI option | Type | Description |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chatid | String, Number | Chat ID |
| MessageID | --messageid | String, Number | ID of the message to be pinned |
Returns: Map Of KeyAndValue - serialized JSON response from VK Teams
<br/>
:::tip
To call this method, the bot must be an administrator in the chat room
Method at API documentation: [GET /chats/pinMessage](https://teams.vk.com/botapi/#/chats/get_chats_pinMessage)
:::
<br/>
```bsl title="Code example"
Token = "001.3501506236.091...";
ChatID = "689203963@chat.agent";
MessageID = "7425684917876428136";
Result = OPI_VKTeams.PinMessage(Token, ChatID, MessageID);
```
```json title="Result"
{
"ok": true
}
```