MadelineProtoDocs/old_docs/API_docs_v45/methods/channels_checkUsername.md

56 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: channels.checkUsername
description: Check if this username is free and can be assigned to a channel/supergroup
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: channels.checkUsername
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Check if this username is free and can be assigned to a channel/supergroup
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | The channel/supergroup | Optional|
|username|[string](../types/string.md) | The new username for this channel/supergroup | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
2019-03-12 13:25:41 +01:00
define('MADELINE_BRANCH', '');
2018-04-01 13:19:25 +02:00
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:
```lua
2018-04-01 13:19:25 +02:00
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|