ChatInviteLink

interface

Represents an invite link for a chat.

Declaration

interface ChatInviteLink

Properties

creates_join_requestproperty#

creates_join_request: boolean;

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

creatorproperty#

creator: User;

Creator of the link

expire_dateproperty#

expire_date?: number;

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

invite_linkproperty#

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 "...".

is_primaryproperty#

is_primary: boolean;

True, if the link is primary

is_revokedproperty#

is_revoked: boolean;

True, if the link is revoked

member_limitproperty#

member_limit?: number;

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

nameproperty#

name?: string;

Optional. Invite link name

pending_join_request_countproperty#

pending_join_request_count?: number;

Optional. Number of pending join requests created using this link

subscription_periodproperty#

subscription_period?: number;

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

subscription_priceproperty#

subscription_price?: number;

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