Block chat user
Blocks the selected user in chat
- Parameters
- Advanced call ?
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
| Parameter | Description |
|---|---|
| proxy | InternetProxy or a structure with fields Protocol, Host, Port, User, Password, UseOSAuthentication |
| timeout | Request execution timeout |
| adv_response | Formats the response as a complete HTTP structure with fields code, body, and headers |
| retries | Number of HTTP request send attempts on 5** status codes or internal client errors |
| dontwait | Creates a background job and returns its data (for 1C and OneScript only) |
tip
To call this method, the bot must be an administrator in the chat room.
Method at API documentation: GET /chats/blockUser
1C:Enterprise/OneScript code example
Token = "001.3501506236.091...";
ChatID = "689203963@chat.agent";
User = 1011987091;
Result = OPI_VKTeams.BlockChatUser(Token, ChatID, User, True);
- Bash
- CMD/Bat
oint vkteams BlockChatUser \
--token "***" \
--chatid "***" \
--userid 1011987091 \
--dellast true
oint vkteams BlockChatUser ^
--token "***" ^
--chatid "***" ^
--userid 1011987091 ^
--dellast true
Result
{
"ok": true
}