ChatInviteLink

Represents an invite link for a chat. ↗

11 fields, 5 required.

Used by

• createChatInviteLink
• createChatSubscriptionInviteLink
• editChatInviteLink
• editChatSubscriptionInviteLink
• revokeChatInviteLink

Fields

invite_link string Required
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 Required
Creator of the link.

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

is_primary boolean Required
True, if the link is primary.

is_revoked boolean Required
True, if the link is revoked.

name string
Invite link name.

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

member_limit number
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 number
Number of pending join requests created using this link.

subscription_period number
The number of seconds the subscription will be active for before the next payment.

subscription_price number
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.