MadelineProto/old_docs/API_docs_v72/methods/account_checkUsername.md

71 lines
1.5 KiB
Markdown
Raw Normal View History

---
2017-11-15 13:41:58 +01:00
title: account.checkUsername
description: Check if this username is available
---
2017-11-15 13:41:58 +01:00
## Method: account.checkUsername
[Back to methods index](index.md)
Check if this username is available
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-20 16:42:05 +01:00
|username|[CLICK ME string](../types/string.md) | Yes|The username to check|
2017-11-15 13:41:58 +01:00
### Return type: [Bool](../types/Bool.md)
2017-11-15 13:41:58 +01:00
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|USERNAME_INVALID|The provided username is not valid|
2017-08-28 12:44:50 +02:00
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
2017-11-15 13:41:58 +01:00
$Bool = $MadelineProto->account->checkUsername(['username' => 'string', ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
2017-11-15 13:41:58 +01:00
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/account.checkUsername`
2017-07-23 16:11:02 +02:00
Parameters:
2017-11-15 13:41:58 +01:00
username - Json encoded string
2017-07-23 16:11:02 +02:00
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-11-15 13:41:58 +01:00
Bool = account.checkUsername({username='string', })
```