2024-08-18 17:47:59 +03:00
|
|
|
---
|
|
|
|
sidebar_position: 10
|
|
|
|
---
|
|
|
|
|
|
|
|
# Unpin message
|
|
|
|
Unpins a previously pinned chat message
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
`Function UnpinMessage(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 unpinned |
|
|
|
|
|
|
|
|
|
|
|
|
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/unpinMessage](https://teams.vk.com/botapi/#/chats/get_chats_unpinMessage)
|
|
|
|
:::
|
|
|
|
<br/>
|
|
|
|
|
|
|
|
|
|
|
|
```bsl title="Code example"
|
2024-09-24 11:38:18 +03:00
|
|
|
Token = "001.3501506236.091...";
|
|
|
|
ChatID = "689203963@chat.agent";
|
2024-09-29 17:35:23 +03:00
|
|
|
MessageID = "7419291601358293295";
|
2024-08-18 17:47:59 +03:00
|
|
|
|
|
|
|
Result = OPI_VKTeams.UnpinMessage(Token, ChatID, MessageID);
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
```sh title="CLI command example"
|
|
|
|
|
|
|
|
oint vkteams UnpinMessage --token "001.3501506236.091..." --chatid "689203963@chat.agent" --messageid "7401463509940174907"
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
```json title="Result"
|
|
|
|
{
|
|
|
|
"ok": true
|
|
|
|
}
|
|
|
|
```
|