aiogram/docs/api/methods/get_chat_administrators.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

# getChatAdministrators
## Description
Use this method to get a list of administrators in a chat. On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
## 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 List[ChatMember]`
Description: On success, returns an Array of ChatMember objects that contains information about all chat administrators except other bots. If the chat is a group or a supergroup and no administrators were appointed, only the creator will be returned.
## Usage
### As bot method bot
```python3
result: List[ChatMember] = await bot.get_chat_administrators(...)
```
### Method as object
Imports:
- `from aiogram.methods import GetChatAdministrators`
- `from aiogram.api.methods import GetChatAdministrators`
- `from aiogram.api.methods.get_chat_administrators import GetChatAdministrators`
2020-01-11 22:59:14 +02:00
#### In handlers with current bot
```python3
2020-01-11 22:59:14 +02:00
result: List[ChatMember] = await GetChatAdministrators(...)
```
2020-01-11 22:59:14 +02:00
#### With specific bot
```python3
2020-01-11 22:59:14 +02:00
result: List[ChatMember] = await bot(GetChatAdministrators(...))
```
2020-01-11 22:59:14 +02:00
## Related pages:
- [Official documentation](https://core.telegram.org/bots/api#getchatadministrators)
- [aiogram.types.ChatMember](../types/chat_member.md)