MadelineProtoDocs/old_docs/API_docs_v5/methods/channels.checkUsername.md
2020-06-16 17:50:25 +02:00

1.8 KiB

title description image redirect_from
channels.checkUsername Check if a username is free and can be assigned to a channel/supergroup https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png /API_docs/methods/channels_checkUsername.html

Method: channels.checkUsername

Back to methods index

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

Parameters:

Name Type Description Required
channel Username, chat ID, Update, Message or InputChannel The channel/supergroup that will assigned the specified username Optional
username string The username to check Yes

Return type: Bool

Can bots use this method: NO

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();

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

Or, if you're into Lua:

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

Errors

Code Type Description
400 CHANNEL_INVALID The provided channel is invalid
400 CHANNELS_ADMIN_PUBLIC_TOO_MUCH You're admin of too many public channels, make some channels private to change the username of this channel
400 CHAT_ID_INVALID The provided chat id is invalid
400 USERNAME_INVALID The provided username is not valid