Documentation - v0.27.0
    Preparing search index...
    • Create an additional invite link for the chat.

      You must be an administrator and have appropriate rights.

      Parameters

      • client: ITelegramClient
      • chatId: InputPeerLike

        Chat ID

      • Optionalparams: {
            expires?: number | Date;
            subscriptionPricing?: RawStarsSubscriptionPricing;
            usageLimit?: number;
            withApproval?: boolean;
        }
        • Optionalexpires?: number | Date

          Date when this link will expire. If number is passed, UNIX time in ms is expected.

        • OptionalsubscriptionPricing?: RawStarsSubscriptionPricing

          When a pricing plan is passed, this link will become a paid subscription link

          Currently the only allowed .period is 1 month, i.e. 2592000

        • OptionalusageLimit?: number

          Maximum number of users that can be members of this chat at the same time after joining using this link.

          Integer in range [1, 99999] or Infinity

          Infinity

        • OptionalwithApproval?: boolean

          Whether users to be joined via this link need to be approved by an admin

      Returns Promise<ChatInviteLink>