Link Search Menu Expand Document

Method: messages.exportChatInvite

Back to methods index

Export an invite link for a chat

Parameters:

NameTypeDescriptionRequired
legacy_revoke_permanentBoolLegacy 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.Optional
request_neededBoolWhether admin confirmation is required before admitting each separate user into the chatOptional
peerUsername, chat ID, Update, Message or InputPeerChatOptional
expire_dateintExpiration dateOptional
usage_limitintMaximum number of users that can join using this linkOptional
titlestringDescription of the invite link, visible only to administratorsOptional

Return type: ExportedChatInvite

Can bots use this method: YES

MadelineProto Example (now async for huge speed and parallelism!):

if (!file_exists('madeline.php')) {
    copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';

$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();

// PHP 8+ syntax, use an array on PHP 7.
$ExportedChatInvite = $MadelineProto->messages->exportChatInvite(legacy_revoke_permanent: Bool, request_needed: Bool, peer: InputPeer, expire_date: int, usage_limit: int, title: 'string', );