get_chat_admin_invite_links()¶
- async Client.get_chat_admin_invite_links()¶
Get the invite links created by an administrator in a chat.
Note
As an administrator you can only get your own links you have exported. As the chat or channel owner you can get everyones links.
- Parameters:
chat_id (
int
|str
) – Unique identifier for the target chat or username of the target channel/supergroup (in the format @username).admin_id (
int
|str
) – Unique identifier (int) or username (str) of the target user. For you yourself you can simply use “me” or “self”. For a contact that exists in your Telegram address book you can use his phone number (str).revoked (
bool
, optional) – True, if you want to get revoked links instead. Defaults to False (get active links only).limit (
int
, optional) – Limits the number of invite links to be retrieved. By default, no limit is applied and all invite links are returned.
- Returns:
Generator
– A generator yieldingChatInviteLink
objects.- Yields:
ChatInviteLink
objects.