MadelineProto/old_docs/API_docs_v72/methods/channels_checkUsername.md

72 lines
1.5 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: channels.checkUsername
description: channels.checkUsername parameters, return type and example
---
## Method: channels.checkUsername
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|channel|[InputChannel](../types/InputChannel.md) | Yes|
|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 |
|----------|---------------|
|CHANNEL_INVALID|The provided channel is invalid|
|CHAT_ID_INVALID|The provided chat id is invalid|
|USERNAME_INVALID|The provided username is not valid|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->channels->checkUsername(['channel' => InputChannel, '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/channels.checkUsername`
Parameters:
channel - Json encoded InputChannel
username - Json encoded string
Or, if you're into Lua:
```
Bool = channels.checkUsername({channel=InputChannel, username='string', })
```