telegram.ChatInviteLink

class telegram.ChatInviteLink(invite_link, creator, creates_join_request, is_primary, is_revoked, expire_date=None, member_limit=None, name=None, pending_join_request_count=None, *, api_kwargs=None)

Bases: telegram.TelegramObject

This object represents an invite link for a chat.

Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their invite_link, creator, creates_join_request, is_primary and is_revoked are equal.

New in version 13.4.

Changed in version 20.0:

• The argument & attribute creates_join_request is now required to comply with the Bot API.

• Comparing objects of this class now also takes creates_join_request into account.

Parameters

• invite_link (str) – The invite link.

• creator (telegram.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.

  New in version 13.8.

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

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

• expire_date (datetime.datetime, optional) – Date 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.

• name (str, optional) –

  Invite link name. 0-32 characters.

  New in version 13.8.

• pending_join_request_count (int, optional) –

  Number of pending join requests created using this link.

  New in version 13.8.

invite_link

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

Type

str

creator

Creator of the link.

Type

telegram.User

creates_join_request

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

New in version 13.8.

Type

bool

is_primary

True, if the link is primary.

Type

bool

is_revoked

True, if the link is revoked.

Type

bool

expire_date

Optional. Date when the link will expire or has been expired.

Type

datetime.datetime

member_limit

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

Type

int

name

Optional. Invite link name. 0-32 characters.

New in version 13.8.

Type

str

pending_join_request_count

Optional. Number of pending join requests created using this link.

New in version 13.8.

Type

int

classmethod de_json(data, bot)

See telegram.TelegramObject.de_json().