messages.exportChatInvite

Export an invite link for a chat

chatInviteExported#6e24fc9d flags:# revoked:flags.0?true permanent:flags.5?true link:string admin_id:int date:int start_date:flags.4?int expire_date:flags.1?int usage_limit:flags.2?int usage:flags.3?int = ExportedChatInvite;
---functions---
messages.exportChatInvite#df7534c peer:InputPeer = ExportedChatInvite;

Parameters

Name Type Description
flags # Flags, see TL conditional fields
legacy_revoke_permanent flags.2?true Legacy flag, reproducing legacy behavior of this method: if set, revokes all previous links before creating a new one. Kept for bot API BC, should not be used by modern clients.
request_needed flags.3?true Whether admin confirmation is required before admitting each separate user into the chat
peer InputPeer Chat
expire_date flags.0?int Expiration date
usage_limit flags.1?int Maximum number of users that can join using this link
title flags.4?string Description of the invite link, visible only to administrators
subscription_pricing flags.5?StarsSubscriptionPricing For Telegram Star subscriptions ยป, contains the pricing of the subscription the user must activate to join the private channel.

Result

ExportedChatInvite

Possible errors

Code Type Description
400 CHANNEL_INVALID The provided channel is invalid.
400 CHANNEL_PRIVATE You haven't joined this channel/supergroup.
400 CHAT_ADMIN_REQUIRED You must be an admin in this chat to do this.
400 CHAT_ID_INVALID The provided chat id is invalid.
403 CHAT_WRITE_FORBIDDEN You can't write in this chat.
400 EXPIRE_DATE_INVALID The specified expiration date is invalid.
400 MSG_ID_INVALID Invalid message ID provided.
400 PEER_ID_INVALID The provided peer id is invalid.
400 USAGE_LIMIT_INVALID The specified usage limit is invalid.

Bots can use this method

Related pages

Telegram Stars

Telegram Stars are virtual items that allow users to purchase digital goods and services from bots and mini apps inside the Telegram ecosystem, send gifts to content creators on the Telegram platform, and more.