telebot-ts API Documentation - v1.0.0
    Preparing search index...

    Interface ChatInviteLink

    Represents an invite link for a chat.

    Telegram Bot API: ChatInviteLink

    interface ChatInviteLink {
        creates_join_request: boolean;
        creator: User;
        expire_date?: number;
        invite_link: string;
        is_primary: boolean;
        is_revoked: boolean;
        member_limit?: number;
        name?: string;
        pending_join_request_count?: number;
        subscription_period?: number;
        subscription_price?: number;
    }
    Index
    creates_join_request creator expire_date? invite_link is_primary is_revoked member_limit? name? pending_join_request_count? subscription_period? subscription_price?
    creates_join_request: boolean

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

    creator: User

    Creator of the link.

    expire_date?: number

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

    invite_link: string

    The invite link as a string.

    is_primary: boolean

    True, if the link is primary.

    is_revoked: boolean

    True, if the link is revoked.

    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.

    name?: string

    Invite link name.

    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.

    subscription_price?: number

    The amount of Telegram Stars a user must pay initially and after each subscription period to remain in the chat.

    Settings
    Member Visibility

    On This Page
    Properties