MadelineProtoDocs/old_docs/API_docs_v91/methods/channels_checkUsername.md

55 lines
1.6 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
2019-03-08 13:49:23 +01: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
---
2019-03-08 13:49:23 +01:00
# Method: channels.checkUsername
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-03-08 13:49:23 +01:00
Check if this username is free and can be assigned to a channel/supergroup
2018-04-01 13:19:25 +02:00
### 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|
2019-03-08 13:49:23 +01:00
|username|[string](../types/string.md) | The new username for this channel/supergroup | Yes|
2018-04-01 13:19:25 +02:00
2019-03-08 13:49:23 +01:00
### Return type: [Bool](../types/Bool.md)
2018-04-01 13:19:25 +02:00
### Can bots use this method: **NO**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
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();
2019-03-08 13:49:23 +01:00
$Bool = $MadelineProto->channels->checkUsername(['channel' => InputChannel, 'username' => 'string', ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2019-03-08 13:49:23 +01:00
Bool = channels.checkUsername({channel=InputChannel, username='string', })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|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|
2018-04-01 13:19:25 +02:00