MadelineProto/old_docs/API_docs_v73/methods/account_checkUsername.md

64 lines
1.3 KiB
Markdown
Raw Normal View History

---
title: account.checkUsername
description: account.checkUsername parameters, return type and example
---
## Method: account.checkUsername
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|username|[string](../types/string.md) | Yes|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USERNAME_INVALID|The provided username is not valid|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
$MadelineProto->session = 'mySession.madeline';
if (isset($number)) { // Login as a user
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->account->checkUsername(['username' => 'string', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.checkUsername`
Parameters:
username - Json encoded string
Or, if you're into Lua:
```
Bool = account.checkUsername({username='string', })
```