1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-02-05 13:25:25 +02:00
OpenIntegrations/docs/en/md/VKTeams/Chat-management/Get-chat-blocked-users.md
Vitaly the Alpaca (bot) ab33d2f19d Main build (Jenkins)
2024-09-17 12:29:46 +03:00

51 lines
1017 B
Markdown

---
sidebar_position: 6
---
# Get chat blocked users
Gets the list of blocked chat users
`Function GetChatBlockedUsers(Val Token, Val ChatID) Export`
| Parameter | CLI option | Type | Description |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chatid | String, Number | Chat ID |
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​/getBlockedUsers](https://teams.vk.com/botapi/#/chats/get_chats_getBlockedUsers)
:::
<br/>
```bsl title="Code example"
Token = FunctionParameters["VkTeams_Token"];
ChatID = FunctionParameters["VkTeams_ChatID"];
Result = OPI_VKTeams.GetChatBlockedUsers(Token, ChatID);
```
```sh title="CLI command example"
oint vkteams GetChatBlockedUsers --token "001.3501506236.091..." --chatid "AoLI0egLWBSLR1Ngn2w"
```
```json title="Result"
{
"users": [],
"ok": true
}
```