ChatInviteLink

An invite link for a chat.

  • 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 “…”.

  • date (:py:obj:`~datetime.datetime`) – The date when the link was created.

  • is_primary (``bool``) – True, if the link is primary.

  • is_revoked (``bool``) – True, if the link is revoked.

  • creator (:obj:`~pyrogram.types.User`, *optional*) – Creator of the link.

  • name (``str``, *optional*) – Invite link name

  • creates_join_request (``bool``, *optional*) – True, if users joining the chat via the link need to be approved by chat administrators.

  • start_date (:py:obj:`~datetime.datetime`, *optional*) – Point in time when the link has been edited.

  • expire_date (:py:obj:`~datetime.datetime`, *optional*) – Point in time when the link will expire or has been expired.

  • member_limit (``int``, *optional*) – Maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999.

  • member_count (``int``, *optional*) – Number of users that joined via this link and are currently member of the chat.

  • pending_join_request_count (``int``, *optional*) – Number of pending join requests created using this link.

  • expired_member_count (``int``, *optional*) – Number of chat members, which joined the chat using the link, but have already left because of expired subscription; for subscription links only.

  • subscription_period (``int``, *optional*) – The number of seconds the subscription will be active for before the next payment.

  • subscription_price (``int``, *optional*) – The amount of Telegram Stars a user must pay initially and after each subsequent subscription period to be a member of the chat using the link.