channels.CheckUsername

class pyrogram.raw.functions.channels.CheckUsername

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

Details:

  • Layer: 227

  • ID: 10E6BD2C

Parameters:

  • channel (InputChannel) – The channel/supergroup that will assigned the specified username

  • username (str) – The username to check

Returns:

bool

TL Schema

channels.checkUsername#10e6bd2c
channel:InputChannel
username:string

= Bool

Parameter Tree

CheckUsername
├── channel → InputChannel
│ ├── InputChannelEmpty
│ ├── InputChannel
│ │ ├── channel_id → long
│ │ └── access_hash → long
│ └── InputChannelFromMessage
│ ├── peer → InputPeer
│ │ ├── InputPeerEmpty
│ │ ├── InputPeerSelf
│ │ ├── InputPeerChat
│ │ ├── InputPeerUser
│ │ ├── InputPeerChannel
│ │ ├── InputPeerUserFromMessage
│ │ └── InputPeerChannelFromMessage
│ ├── msg_id → int
│ └── channel_id → long
└── username → string

Example

await app.invoke(
    CheckUsername(
        channel=await app.resolve_channel(chat_id),
        username="text",
    )
)