channels.checkUsername

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

Example

Javascript

const {Api, TelegramClient} = require('telegram');
const {StringSession} = require('telegram/sessions');

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result = await client.invoke(new Api.channels.checkUsername({
        channel: new Api.InputChannel({...}),
        username: 'random string here',
        }));
    console.log(result); // prints the result
})();

TypeScript

import {Api, TelegramClient} from 'telegram';
import {StringSession} from 'telegram/sessions';

const session = new StringSession('');
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
    const result: Api.Bool = await client.invoke(new Api.channels.checkUsername({
        channel: new Api.InputChannel({...}),
        username: 'random string here',
        }));
    console.log(result); // prints the result
})();

TL schema

boolFalse#bc799737 = Bool;
boolTrue#997275b5 = Bool;
---functions---
channels.checkUsername#10e6bd2c channel:InputChannel username:string = Bool;

Parameters

Name	Type	Description
channel	InputChannel	The channel/supergroup that will assigned the specified username
username	string	The username to check

Result

Bool

Possible errors

Code	Type	Description
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	CHANNEL_INVALID	The provided channel is invalid
400	CHAT_ID_INVALID	The provided chat id is invalid
400	USERNAME_INVALID	The provided username is not valid

Can bots use this methd ?

yes

Related pages

Channels

How to handle channels, supergroups, groups, and what's the difference between them.