Available types

ChatInviteLink

Represents an invite link for a chat.

fields

fieldtyperequireddescription
invite_linkstringrequiredThe invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”.
creatorUserrequiredCreator of the link
creates_join_requestbooleanrequiredTrue, if users joining the chat via the link need to be approved by chat administrators
is_primarybooleanrequiredTrue, if the link is primary
is_revokedbooleanrequiredTrue, if the link is revoked
namestringoptionalOptional. Invite link name
expire_datenumberoptionalOptional. Point in time (Unix timestamp) when the link will expire or has been expired
member_limitnumberoptionalOptional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999
pending_join_request_countnumberoptionalOptional. Number of pending join requests created using this link
subscription_periodnumberoptionalOptional. The number of seconds the subscription will be active for before the next payment
subscription_pricenumberoptionalOptional. 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

import

types.ts
import type { ChatInviteLink } from "@yaebal/types";

used by

methods

types