You've already forked OpenIntegrations
mirror of
https://github.com/Bayselonarrend/OpenIntegrations.git
synced 2025-11-23 22:05:15 +02:00
50 lines
1.0 KiB
Markdown
50 lines
1.0 KiB
Markdown
|
---
|
||
|
|
sidebar_position: 13
|
||
|
|
---
|
||
|
|
|
||
|
|
# Set chat description
|
||
|
|
Sets new chat description
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
`Function SetChatDescription(Val Token, Val ChatID, Val Text) Export`
|
||
|
|
|
||
|
|
| Parameter | CLI option | Type | Description |
|
||
|
|
|-|-|-|-|
|
||
|
|
| Token | --token | String | Bot token |
|
||
|
|
| ChatID | --chatid | String, Number | Chat ID |
|
||
|
|
| Text | --text | String | Description text |
|
||
|
|
|
||
|
|
|
||
|
|
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/setAbout](https://teams.vk.com/botapi/#/chats/get_chats_setAbout)
|
||
|
|
:::
|
||
|
|
<br/>
|
||
|
|
|
||
|
|
|
||
|
|
```bsl title="Code example"
|
||
|
|
Token = "001.3501506236.091...";
|
||
|
|
ChatID = "689203963@chat.agent";
|
||
|
|
Text = "New description";
|
||
|
|
|
||
|
|
Result = OPI_VKTeams.SetChatDescription(Token, ChatID, Text);
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
```sh title="CLI command example"
|
||
|
|
|
||
|
|
oint vkteams SetChatDescription --token "001.3501506236.091..." --chatid "689203963@chat.agent" --text %text%
|
||
|
|
|
||
|
|
```
|
||
|
|
|
||
|
|
```json title="Result"
|
||
|
|
|
||
|
|
```
|