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/Chat-management/Block-chat-user.mdx
T
2024-10-22 08:59:24 +03:00

73 lines
1.7 KiB
Plaintext

---
sidebar_position: 8
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Block chat user
Blocks the selected user in chat
`Function BlockChatUser(Val Token, Val ChatID, Val UserID, Val DeleteLastMessages = False) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| Token | --token | String | ✔ | Bot token |
| ChatID | --chatid | String, Number | ✔ | Chat ID |
| UserID | --userid | String, Number | ✔ | User ID to be blocked |
| DeleteLastMessages | --dellast | Boolean | ✖ | Delete last messages before blocking |
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​/blockUser](https://teams.vk.com/botapi/#/chats/get_chats_blockUser)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
Token = "001.3501506236.091...";
ChatID = "689203963@chat.agent";
User = 1011987091;
Result = OPI_VKTeams.BlockChatUser(Token, ChatID, User, True);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint vkteams BlockChatUser \
--token "***" \
--chatid "689203963@chat.agent" \
--userid 1011987091 \
--dellast true
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint vkteams BlockChatUser ^
--token "***" ^
--chatid "689203963@chat.agent" ^
--userid 1011987091 ^
--dellast true
```
</TabItem>
</Tabs>
```json title="Result"
{
"ok": true
}
```