ChatInviteLink

^{ref / types / ChatInviteLink}

Represents an invite link for a chat.

^Source

Properties

invite_link

invite_link: string;

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

^Source

creator

creator: User;

Creator of the link

^Source

creates_join_request

creates_join_request: boolean;

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

^Source

is_primary

is_primary: boolean;

True, if the link is primary

^Source

is_revoked

is_revoked: boolean;

True, if the link is revoked

^Source

name

name?: string;

Invite link name

^Source

expire_date

expire_date?: number;

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

^Source

member_limit

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

^Source

pending_join_request_count

pending_join_request_count?: number;

Number of pending join requests created using this link

^Source

subscription_period

subscription_period?: number;

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

^Source

subscription_price

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

^Source