Method: channels.checkUsername

Back to methods index

Check if this username is free and can be assigned to a channel/supergroup


Name Type Description Required
channel Username, chat ID, Update, Message or InputChannel The channel/supergroup Optional
username string The new username for this channel/supergroup Yes

Return type: Bool

Can bots use this method: NO

MadelineProto Example:

if (!file_exists('madeline.php')) {
    copy('', 'madeline.php');
include 'madeline.php';

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

$Bool = $MadelineProto->channels->checkUsername(['channel' => InputChannel, 'username' => 'string', ]);

PWRTelegram HTTP API example (NOT FOR MadelineProto):

As a user:



channel - Json encoded InputChannel

username - Json encoded string

Or, if you’re into Lua:

Bool = channels.checkUsername({channel=InputChannel, username='string', })

Errors this method can return:

Error Description
CHANNEL_INVALID The provided channel is invalid
CHAT_ID_INVALID The provided chat id is invalid
USERNAME_INVALID The provided username is not valid