1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2024-12-23 02:06:12 +02:00
OpenIntegrations/docs/en/md/Telegram/Administration/Ban.md

49 lines
928 B
Markdown
Raw Normal View History

---
sidebar_position: 1
---
# Ban
Bans a user in the selected chat
2024-07-10 12:58:29 +02:00
`Function Ban(Val Token, Val ChatID, Val UserID) Export`
| Parameter | CLI option | Type | Destination |
|-|-|-|-|
| Token | --token | String | Bot token |
| ChatID | --chat | String, Number | Target chat ID or ChatID*TopicID |
| UserID | --user | String, Number | Target user ID |
Returns: Map Of KeyAndValue - Serialized JSON response from Telegram
2024-07-10 13:05:58 +02:00
<br/>
2024-07-10 12:58:29 +02:00
```bsl title="Code example"
2024-07-10 13:24:11 +02:00
Token = "6129457865:AAFyzNYOAFbu...";
UserID = "461699897";
ChannelID = "@testsichee";
Result = OPI_Telegram.Ban(Token, ChannelID, UserID);
```
```sh title="CLI command example"
oint telegram Ban --token "6129457865:AAFyzNYOAFbu..." --chat %chat% --user "461699897"
```
```json title="Result"
2024-07-10 13:11:17 +02:00
{
"ok": false,
"error_code": 400,
"description": "Bad Request: can't remove chat owner"
}
```