exportChatInviteLink()

Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as String on success.

parameters

parameter	type	required	description
`chat_id`	number \| string	required	Unique identifier for the target chat or username of the target channel in the format `@username`

returns

string

usage in yaebal

not (yet) hard-typed on Api — call it through the generic .call<T>() escape hatch documented in @yaebal/types.

bot.ts

import type { ExportChatInviteLinkParams } from "@yaebal/types";

await bot.api.call<string>("exportChatInviteLink", {
  chat_id: 123456789,
} satisfies ExportChatInviteLinkParams);

context shortcut

also available as ctx.exportChatInviteLink() on 16 context types — see @yaebal/contexts.

context shortcut

/** Use this method to generate a new primary invite link for a chat; any previously generated primary link is revoked. The bot must be an administrator in the chat for this to work and must have the appropriate administrator rights. Returns the new invite link as *String* on success. */
ctx.exportChatInviteLink(params?: Omit<ExportChatInviteLinkParams, "chat_id">)

official Bot API docs: https://core.telegram.org/bots/api/#exportchatinvitelink