createChatInviteLink
Returns ChatInviteLink ↗
Use this method to create an additional invite link for a chat. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. The link can be revoked using the method revokeChatInviteLink.
Required: chat_id · Optional: 4 parameters
Limits:
- name: 0-32 characters
Try it
TypeScript example · @effect-ak/tg-bot-client
import { makeTgBotClient } from "@effect-ak/tg-bot-client"
const client = makeTgBotClient({ bot_token: "YOUR_BOT_TOKEN" })
const result = await client.execute("create_chat_invite_link", { chat_id: "YOUR_CHAT_ID"})Parameters
chat_id number | string Required
Unique identifier for the target chat or username of the target channel (in the format @channelusername).
name string
Invite link name; 0-32 characters.
expire_date number
Point in time (Unix timestamp) when the link will expire.
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.
creates_join_request boolean
True, if users joining the chat via the link need to be approved by chat administrators. If True, member_limit can’t be specified.
Related methods
createChatSubscriptionInviteLink · createForumTopic · createInvoiceLink · createNewStickerSet