GramIO API Reference / gramio/dist / TelegramChatInviteLink
Interface: TelegramChatInviteLink
Defined in: @gramio/types/out/objects.d.ts:3439
Represents an invite link for a chat.
Properties
| Property | Type | Description | Defined in |
|---|---|---|---|
creates_join_request | boolean | True, if users joining the chat via the link need to be approved by chat administrators | @gramio/types/out/objects.d.ts:3451 |
creator | TelegramUser | Creator of the link | @gramio/types/out/objects.d.ts:3447 |
expire_date? | number | Optional. Point in time (Unix timestamp) when the link will expire or has been expired | @gramio/types/out/objects.d.ts:3467 |
invite_link | string | The invite link. If the link was created by another chat administrator, then the second part of the link will be replaced with “…”. | @gramio/types/out/objects.d.ts:3443 |
is_primary | boolean | True, if the link is primary | @gramio/types/out/objects.d.ts:3455 |
is_revoked | boolean | True, if the link is revoked | @gramio/types/out/objects.d.ts:3459 |
member_limit? | number | Optional. The maximum number of users that can be members of the chat simultaneously after joining the chat via this invite link; 1-99999 | @gramio/types/out/objects.d.ts:3471 |
name? | string | Optional. Invite link name | @gramio/types/out/objects.d.ts:3463 |
pending_join_request_count? | number | Optional. Number of pending join requests created using this link | @gramio/types/out/objects.d.ts:3475 |
subscription_period? | number | Optional. The number of seconds the subscription will be active for before the next payment | @gramio/types/out/objects.d.ts:3479 |
subscription_price? | number | 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 | @gramio/types/out/objects.d.ts:3483 |