exportChatInviteLink#

Returns: str

class aiogram.methods.export_chat_invite_link.ExportChatInviteLink(*, chat_id: int | str, **extra_data: Any)[source]#

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

Note: Each administrator in a chat generates their own invite links. Bots can’t use invite links generated by other administrators. If you want your bot to work with invite links, it will need to generate its own link using aiogram.methods.export_chat_invite_link.ExportChatInviteLink or by calling the aiogram.methods.get_chat.GetChat method. If your bot needs to generate a new primary invite link replacing its previous one, use aiogram.methods.export_chat_invite_link.ExportChatInviteLink again.

Source: https://core.telegram.org/bots/api#exportchatinvitelink

chat_id: int | str#: Unique identifier for the target chat or username of the target channel (in the format @channelusername)

Usage#

As bot method#

result: str = await bot.export_chat_invite_link(...)

Method as object#

Imports:

from aiogram.methods.export_chat_invite_link import ExportChatInviteLink
alias: from aiogram.methods import ExportChatInviteLink

With specific bot#

result: str = await bot(ExportChatInviteLink(...))

As reply into Webhook in handler#

return ExportChatInviteLink(...)

As shortcut from received object#

aiogram.types.chat.Chat.export_invite_link()