Interface ChatInviteLinkInfo

Contains information about a chat invite link.

interface ChatInviteLinkInfo {
    @type: "chatInviteLinkInfo";
    accent_color_id: number;
    accessible_for: number;
    chat_id: number;
    creates_join_request?: boolean;
    description: string;
    is_fake?: boolean;
    is_public?: boolean;
    is_scam?: boolean;
    is_verified?: boolean;
    member_count: number;
    member_user_ids: number[];
    photo: ChatPhotoInfo;
    subscription_info: ChatInviteLinkSubscriptionInfo;
    title: string;
    type: InviteLinkChatType;
}

Properties

@type: "chatInviteLinkInfo"
accent_color_id: number

Identifier of the accent color for chat title and background of chat photo.

accessible_for: number

If non-zero, the amount of time for which read access to the chat will remain available, in seconds.

chat_id: number

Chat identifier of the invite link; 0 if the user has no access to the chat before joining.

creates_join_request?: boolean

True, if the link only creates join request.

description: string

Contains information about a chat invite link.

is_fake?: boolean

True, if many users reported this chat as a fake account.

is_public?: boolean

True, if the chat is a public supergroup or channel, i.e. it has a username or it is a location-based supergroup.

is_scam?: boolean

True, if many users reported this chat as a scam.

is_verified?: boolean

True, if the chat is verified.

member_count: number

Number of members in the chat.

member_user_ids: number[]

User identifiers of some chat members that may be known to the current user.

Chat photo; may be null.

Information about subscription plan that must be paid by the user to use the link; may be null if the link doesn't require subscription.

title: string

Title of the chat.

Type of the chat.