1
0
mirror of https://github.com/Bayselonarrend/OpenIntegrations.git synced 2025-06-15 00:15:19 +02:00
Files
OpenIntegrations/docs/en/md/Telegram/Administration/Ban.mdx
Vitaly the Alpaca (bot) 4de7fa4268 Main build (Jenkins)
2024-12-16 19:38:57 +03:00

71 lines
1.5 KiB
Plaintext
Vendored

---
sidebar_position: 1
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
# Ban
Bans a user in the selected chat
`Function Ban(Val Token, Val ChatID, Val UserID) Export`
| Parameter | CLI option | Type | Required | Description |
|-|-|-|-|-|
| 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
<br/>
:::tip
Method at API documentation: [banChatMember](https://core.telegram.org/bots/api#banchatmember)
:::
<br/>
```bsl title="1C:Enterprise/OneScript code example"
Token = "6129457865:AAFyzNYOAFbu...";
UserID = "461699897";
ChannelID = "@testsichee";
Result = OPI_Telegram.Ban(Token, ChannelID, UserID);
```
<Tabs>
<TabItem value="bash" label="Bash" default>
```bash
oint telegram Ban \
--token "***" \
--chat "@testsichee" \
--user "461699897"
```
</TabItem>
<TabItem value="bat" label="CMD/Bat" default>
```batch
oint telegram Ban ^
--token "***" ^
--chat "@testsichee" ^
--user "461699897"
```
</TabItem>
</Tabs>
```json title="Result"
{
"ok": false,
"error_code": 400,
"description": "Bad Request: can't remove chat owner"
}
```