mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-11 01:54:53 +00:00
59 lines
1.2 KiB
Markdown
59 lines
1.2 KiB
Markdown
|
# unpinChatMessage
|
|||
|
|
|
|||
|
|
## Description
|
|||
|
|
|
|||
|
|
Use this method to unpin a message in a group, a supergroup, or a channel. The bot must be an administrator in the chat for this to work and must have the ‘can_pin_messages’ admin right in the supergroup or ‘can_edit_messages’ admin right in the 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 channel (in the format @channelusername) |
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Response
|
|||
|
|
|
|||
|
|
Type: `#!python3 bool`
|
|||
|
|
|
|||
|
|
Description: Returns True on success.
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Usage
|
|||
|
|
|
|||
|
|
|
|||
|
|
### As bot method bot
|
|||
|
|
|
|||
|
|
```python3
|
|||
|
|
result: bool = await bot.unpin_chat_message(...)
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
### Method as object
|
|||
|
|
|
|||
|
|
Imports:
|
|||
|
|
|
|||
|
|
- `from aiogram.types import UnpinChatMessage`
|
|||
|
|
- `from aiogram.api.types import UnpinChatMessage`
|
|||
|
|
- `from aiogram.api.types.unpin_chat_message import UnpinChatMessage`
|
|||
|
|
|
|||
|
|
#### As reply into Webhook
|
|||
|
|
```python3
|
|||
|
|
return UnpinChatMessage(...)
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
#### With specific bot
|
|||
|
|
```python3
|
|||
|
|
result: bool = await bot.emit(UnpinChatMessage(...))
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
#### In handlers with current bot
|
|||
|
|
```python3
|
|||
|
|
result: bool = await UnpinChatMessage(...)
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
|
|||
|
|
## Related pages:
|
|||
|
|
|
|||
|
|
- [Official documentation](https://core.telegram.org/bots/api#unpinchatmessage)
|