mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-11 01:54:53 +00:00
58 lines
1 KiB
Markdown
58 lines
1 KiB
Markdown
# leaveChat
|
|
|
|
## Description
|
|
|
|
Use this method for your bot to leave a group, supergroup or channel. Returns True on success.
|
|
|
|
|
|
## Arguments
|
|
|
|
| Name | Type | Description |
|
|
| - | - | - |
|
|
| `chat_id` | `#!python3 Union[int, str]` | Unique identifier for the target chat or username of the target supergroup or channel (in the format @channelusername) |
|
|
|
|
|
|
|
|
## Response
|
|
|
|
Type: `#!python3 bool`
|
|
|
|
Description: Returns True on success.
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
### As bot method bot
|
|
|
|
```python3
|
|
result: bool = await bot.leave_chat(...)
|
|
```
|
|
|
|
### Method as object
|
|
|
|
Imports:
|
|
|
|
- `from aiogram.methods import LeaveChat`
|
|
- `from aiogram.api.methods import LeaveChat`
|
|
- `from aiogram.api.methods.leave_chat import LeaveChat`
|
|
|
|
#### In handlers with current bot
|
|
```python3
|
|
result: bool = await LeaveChat(...)
|
|
```
|
|
|
|
#### With specific bot
|
|
```python3
|
|
result: bool = await bot(LeaveChat(...))
|
|
```
|
|
#### As reply into Webhook in handler
|
|
```python3
|
|
return LeaveChat(...)
|
|
```
|
|
|
|
|
|
|
|
## Related pages:
|
|
|
|
- [Official documentation](https://core.telegram.org/bots/api#leavechat)
|