MadelineProto/old_docs/API_docs_v71/methods/channels_checkUsername.md

71 lines
1.7 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: channels.checkUsername
2018-03-23 16:23:49 +01:00
description: Check if this username is free and can be assigned to a channel/supergroup
2017-10-14 11:50:46 +02:00
---
## Method: channels.checkUsername
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Check if this username is free and can be assigned to a channel/supergroup
2017-10-14 11:50:46 +02:00
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|channel|[Username, chat ID, Update, Message or InputChannel](../types/InputChannel.md) | Optional|The channel/supergroup|
|username|[CLICK ME string](../types/string.md) | Yes|The new username for this channel/supergroup|
2017-10-14 11:50:46 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### 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|
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-10-14 11:50:46 +02:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-10-14 11:50:46 +02:00
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-10-14 11:50:46 +02:00
$Bool = $MadelineProto->channels->checkUsername(['channel' => InputChannel, 'username' => 'string', ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-10-14 11:50:46 +02:00
### 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', })
```