mirror of
https://github.com/danog/MadelineProto.git
synced 2024-12-11 10:19:36 +01:00
69 lines
1.5 KiB
Markdown
69 lines
1.5 KiB
Markdown
|
---
|
||
|
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) | Optional|
|
||
|
|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();
|
||
|
$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->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', })
|
||
|
```
|
||
|
|