Contents Menu Expand Light mode Dark mode Auto light/dark mode
aiogram 3.0.0b7 documentation
Logo
aiogram 3.0.0b7 documentation
  • Installation
  • Bot API
    • Bot
    • Client session
      • Use Custom API server
      • Base
      • aiohttp
    • Types
      • ChosenInlineResult
      • InlineQuery
      • InlineQueryResult
      • InlineQueryResultArticle
      • InlineQueryResultAudio
      • InlineQueryResultCachedAudio
      • InlineQueryResultCachedDocument
      • InlineQueryResultCachedGif
      • InlineQueryResultCachedMpeg4Gif
      • InlineQueryResultCachedPhoto
      • InlineQueryResultCachedSticker
      • InlineQueryResultCachedVideo
      • InlineQueryResultCachedVoice
      • InlineQueryResultContact
      • InlineQueryResultDocument
      • InlineQueryResultGame
      • InlineQueryResultGif
      • InlineQueryResultLocation
      • InlineQueryResultMpeg4Gif
      • InlineQueryResultPhoto
      • InlineQueryResultVenue
      • InlineQueryResultVideo
      • InlineQueryResultVoice
      • InputContactMessageContent
      • InputInvoiceMessageContent
      • InputLocationMessageContent
      • InputMessageContent
      • InputTextMessageContent
      • InputVenueMessageContent
      • SentWebAppMessage
      • Animation
      • Audio
      • BotCommand
      • BotCommandScope
      • BotCommandScopeAllChatAdministrators
      • BotCommandScopeAllGroupChats
      • BotCommandScopeAllPrivateChats
      • BotCommandScopeChat
      • BotCommandScopeChatAdministrators
      • BotCommandScopeChatMember
      • BotCommandScopeDefault
      • CallbackQuery
      • Chat
      • ChatAdministratorRights
      • ChatInviteLink
      • ChatJoinRequest
      • ChatLocation
      • ChatMember
      • ChatMemberAdministrator
      • ChatMemberBanned
      • ChatMemberLeft
      • ChatMemberMember
      • ChatMemberOwner
      • ChatMemberRestricted
      • ChatMemberUpdated
      • ChatPermissions
      • ChatPhoto
      • Contact
      • Dice
      • Document
      • File
      • ForceReply
      • ForumTopic
      • ForumTopicClosed
      • ForumTopicCreated
      • ForumTopicEdited
      • ForumTopicReopened
      • GeneralForumTopicHidden
      • GeneralForumTopicUnhidden
      • InlineKeyboardButton
      • InlineKeyboardMarkup
      • InputFile
      • InputMedia
      • InputMediaAnimation
      • InputMediaAudio
      • InputMediaDocument
      • InputMediaPhoto
      • InputMediaVideo
      • KeyboardButton
      • KeyboardButtonPollType
      • Location
      • LoginUrl
      • MenuButton
      • MenuButtonCommands
      • MenuButtonDefault
      • MenuButtonWebApp
      • Message
      • MessageAutoDeleteTimerChanged
      • MessageEntity
      • MessageId
      • PhotoSize
      • Poll
      • PollAnswer
      • PollOption
      • ProximityAlertTriggered
      • ReplyKeyboardMarkup
      • ReplyKeyboardRemove
      • ResponseParameters
      • User
      • UserProfilePhotos
      • Venue
      • Video
      • VideoChatEnded
      • VideoChatParticipantsInvited
      • VideoChatScheduled
      • VideoChatStarted
      • VideoNote
      • Voice
      • WebAppData
      • WebAppInfo
      • WriteAccessAllowed
      • EncryptedCredentials
      • EncryptedPassportElement
      • PassportData
      • PassportElementError
      • PassportElementErrorDataField
      • PassportElementErrorFile
      • PassportElementErrorFiles
      • PassportElementErrorFrontSide
      • PassportElementErrorReverseSide
      • PassportElementErrorSelfie
      • PassportElementErrorTranslationFile
      • PassportElementErrorTranslationFiles
      • PassportElementErrorUnspecified
      • PassportFile
      • Update
      • WebhookInfo
      • MaskPosition
      • Sticker
      • StickerSet
      • Invoice
      • LabeledPrice
      • OrderInfo
      • PreCheckoutQuery
      • ShippingAddress
      • ShippingOption
      • ShippingQuery
      • SuccessfulPayment
      • CallbackGame
      • Game
      • GameHighScore
      • ErrorEvent
    • Methods
      • answerCallbackQuery
      • approveChatJoinRequest
      • banChatMember
      • banChatSenderChat
      • close
      • closeForumTopic
      • closeGeneralForumTopic
      • copyMessage
      • createChatInviteLink
      • createForumTopic
      • declineChatJoinRequest
      • deleteChatPhoto
      • deleteChatStickerSet
      • deleteForumTopic
      • deleteMyCommands
      • editChatInviteLink
      • editForumTopic
      • editGeneralForumTopic
      • editMessageLiveLocation
      • exportChatInviteLink
      • forwardMessage
      • getChat
      • getChatAdministrators
      • getChatMember
      • getChatMemberCount
      • getChatMenuButton
      • getFile
      • getForumTopicIconStickers
      • getMe
      • getMyCommands
      • getMyDefaultAdministratorRights
      • getUserProfilePhotos
      • hideGeneralForumTopic
      • leaveChat
      • logOut
      • pinChatMessage
      • promoteChatMember
      • reopenForumTopic
      • reopenGeneralForumTopic
      • restrictChatMember
      • revokeChatInviteLink
      • sendAnimation
      • sendAudio
      • sendChatAction
      • sendContact
      • sendDice
      • sendDocument
      • sendLocation
      • sendMediaGroup
      • sendMessage
      • sendPhoto
      • sendPoll
      • sendVenue
      • sendVideo
      • sendVideoNote
      • sendVoice
      • setChatAdministratorCustomTitle
      • setChatDescription
      • setChatMenuButton
      • setChatPermissions
      • setChatPhoto
      • setChatStickerSet
      • setChatTitle
      • setMyCommands
      • setMyDefaultAdministratorRights
      • stopMessageLiveLocation
      • unbanChatMember
      • unbanChatSenderChat
      • unhideGeneralForumTopic
      • unpinAllChatMessages
      • unpinAllForumTopicMessages
      • unpinChatMessage
      • answerPreCheckoutQuery
      • answerShippingQuery
      • createInvoiceLink
      • sendInvoice
      • addStickerToSet
      • createNewStickerSet
      • deleteStickerFromSet
      • getCustomEmojiStickers
      • getStickerSet
      • sendSticker
      • setStickerPositionInSet
      • setStickerSetThumb
      • uploadStickerFile
      • getGameHighScores
      • sendGame
      • setGameScore
      • deleteWebhook
      • getUpdates
      • getWebhookInfo
      • setWebhook
      • setPassportDataErrors
      • deleteMessage
      • editMessageCaption
      • editMessageMedia
      • editMessageReplyMarkup
      • editMessageText
      • stopPoll
      • answerInlineQuery
      • answerWebAppQuery
    • Enums
      • BotCommandScopeType
      • ChatAction
      • ChatMemberStatus
      • ChatType
      • ContentType
      • DiceEmoji
      • InlineQueryResultType
      • InputMediaType
      • MaskPositionPoint
      • MenuButtonType
      • MessageEntityType
      • ParseMode
      • PollType
      • StickerType
      • TopicIconColor
      • UpdateType
    • How to download file?
    • How to upload file?
  • Handling events
    • Observer
    • Router
    • Dispatcher
    • Class based handlers
      • BaseHandler
      • CallbackQueryHandler
      • ChosenInlineResultHandler
      • ErrorHandler
      • InlineQueryHandler
      • MessageHandler
      • PollHandler
      • PreCheckoutQueryHandler
      • ShippingQueryHandler
      • ChatMemberHandler
    • Filtering events
      • Command
      • Text
      • ChatMemberUpdated
      • Magic filters
      • MagicData
      • Callback Data Factory & Filter
      • Exceptions
    • Middlewares
    • Finite State Machine
      • Storages
    • Flags
  • Utils
    • Keyboard builder
    • Translation
    • Chat action sender
    • WebApp
    • Callback answer
  • Changelog
  • Contributing
  v: dev-3.x
Versions
latest
dev-3.x
Downloads
pdf
html
epub
On Read the Docs
Project Home
Builds
Back to top
Edit this page

ChatInviteLink#

class aiogram.types.chat_invite_link.ChatInviteLink(*, invite_link: str, creator: User, creates_join_request: bool, is_primary: bool, is_revoked: bool, name: Optional[str] = None, expire_date: Optional[datetime] = None, member_limit: Optional[int] = None, pending_join_request_count: Optional[int] = None, **extra_data: Any)[source]#

Represents an invite link for a chat.

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

invite_link: str#

The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with ‘…’.

creator: User#

Creator of the link

creates_join_request: bool#

True, if users joining the chat via the link need to be approved by chat administrators

is_primary: bool#

True, if the link is primary

is_revoked: bool#

True, if the link is revoked

name: Optional[str]#

Optional. Invite link name

expire_date: Optional[datetime.datetime]#

Optional. Point in time (Unix timestamp) when the link will expire or has been expired

member_limit: Optional[int]#

Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999

pending_join_request_count: Optional[int]#

Optional. Number of pending join requests created using this link

Next
ChatJoinRequest
Previous
ChatAdministratorRights
Copyright © 2023, aiogram Team
Made with Sphinx and @pradyunsg's Furo
On this page
  • ChatInviteLink
    • ChatInviteLink
      • ChatInviteLink.invite_link
      • ChatInviteLink.creator
      • ChatInviteLink.creates_join_request
      • ChatInviteLink.is_primary
      • ChatInviteLink.is_revoked
      • ChatInviteLink.name
      • ChatInviteLink.expire_date
      • ChatInviteLink.member_limit
      • ChatInviteLink.pending_join_request_count