ChatInviteLink
Represents an invite link for a chat.
fields
| field | type | required | description |
|---|---|---|---|
invite_link | string | required | The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”. |
creator | User | required | Creator of the link |
creates_join_request | boolean | required | True, if users joining the chat via the link need to be approved by chat administrators |
is_primary | boolean | required | True, if the link is primary |
is_revoked | boolean | required | True, if the link is revoked |
name | string | optional | Optional. Invite link name |
expire_date | number | optional | Optional. Point in time (Unix timestamp) when the link will expire or has been expired |
member_limit | number | optional | Optional. 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_count | number | optional | Optional. Number of pending join requests created using this link |
subscription_period | number | optional | Optional. The number of seconds the subscription will be active for before the next payment |
subscription_price | number | optional | 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 |
import
import type { ChatInviteLink } from "@yaebal/types";used by
methods
- createChatInviteLink
- createChatSubscriptionInviteLink
- editChatInviteLink
- editChatSubscriptionInviteLink
- revokeChatInviteLink
types
official Bot API docs: https://core.telegram.org/bots/api/#chatinvitelink