1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-01-10 04:18:47 +02:00
OpenIntegrations/docs/en/md/VKTeams/Chat-management/Remove-chat-members.md
Vitaly the Alpaca (bot) acef484801 Main build (Jenkins)
2024-10-09 09:42:00 +03:00

50 lines
1.1 KiB
Markdown

---
sidebar_position: 1
---
# Remove chat members
Removes users from the chat
`Function RemoveChatMembers(Val Token, Val ChatID, Val Users) Export`
| Parameter | CLI option | Type | Description |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chatid | String, Number | Chat ID |
| Users | --members | String, Number, Array of String, Number | The member or members of the chat room to remove |
Returns: Map Of KeyAndValue - serialized JSON response from VK Teams
<br/>
:::tip
Method at API documentation: [GET /chats/members/delete](https://teams.vk.com/botapi/#/chats/get_chats_members_delete)
:::
<br/>
```bsl title="Code example"
Token = "001.3501506236.091...";
ChatID = "689203963@chat.agent";
User = 1011987091;
Result = OPI_VKTeams.RemoveChatMembers(Token, ChatID, User);
```
```sh title="CLI command example"
oint vkteams RemoveChatMembers --token %token% --chatid %chatid% --members %members%
```
```json title="Result"
{
"ok": true
}
```