GramJS

account.CheckUsername

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

Example

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

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result = await client.invoke(
    new Api.account.CheckUsername({
      username: "some string here",
    })
  );
  console.log(result); // prints the result
})();
import { Api, TelegramClient } from "telegram";
import { StringSession } from "telegram/sessions";

const session = new StringSession(""); // You should put your string session here
const client = new TelegramClient(session, apiId, apiHash, {});

(async function run() {
  await client.connect(); // This assumes you have already authenticated with .start()

  const result: Api.Bool = await client.invoke(
    new Api.account.CheckUsername({
      username: "some string here",
    })
  );
  console.log(result); // prints the result
})();

Parameters

NameTypeDescription
channelInputChannelThe channel/supergroup that will assigned the specified username
usernamestringThe username to check

Result

Bool

Possible errors

CodeTypeDescription
400CHANNELS_ADMIN_PUBLIC_TOO_MUCHYou're admin of too many public channels, make some channels private to change the username of this channel
400CHANNEL_INVALIDThe provided channel is invalid
400CHAT_ID_INVALIDThe provided chat id is invalid
400USERNAME_INVALIDThe provided username is not valid

Can bots use this method?

No

Channels

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