MadelineProtoDocs/docs/API_docs/methods/account.checkUsername.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: account.checkUsername
2019-12-27 17:48:04 +01:00
description: Validates a username and checks availability.
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/account_checkUsername.html
2019-06-23 13:07:51 +02:00
---
# Method: account.checkUsername
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Validates a username and checks availability.
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:58:34 +01:00
|username|[string](../types/string.md) | Username<br>Accepted characters: A-z (case-insensitive), 0-9 and underscores.<br>Length: 5-32 characters. | Yes|
2019-06-23 13:07:51 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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();
$Bool = $MadelineProto->account->checkUsername(['username' => 'string', ]);
```
Or, if you're into Lua:
```lua
Bool = account.checkUsername({username='string', })
```
2019-09-02 17:41:28 +02:00
### Errors
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|USERNAME_INVALID|The provided username is not valid|
2020-02-23 19:29:04 +01:00
|406|AUTH_KEY_DUPLICATED|An auth key with the same ID was already generated|
2019-06-23 13:07:51 +02:00