2017-03-31 17:35:20 +02:00
|
|
|
---
|
|
|
|
title: channels.updateUsername
|
|
|
|
description: channels.updateUsername parameters, return type and example
|
|
|
|
---
|
|
|
|
## Method: channels.updateUsername
|
|
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
|
|
|
|
### Parameters:
|
|
|
|
|
|
|
|
| Name | Type | Required |
|
2017-08-20 11:05:56 +02:00
|
|
|
|----------|---------------|----------|
|
2018-02-18 14:18:18 +01:00
|
|
|
|channel|[InputChannel](../types/InputChannel.md) | Optional|
|
2017-03-31 17:35:20 +02:00
|
|
|
|username|[string](../types/string.md) | Yes|
|
|
|
|
|
|
|
|
|
|
|
|
### Return type: [Bool](../types/Bool.md)
|
|
|
|
|
2017-08-28 12:44:50 +02:00
|
|
|
### 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|
|
2017-11-15 13:07:42 +01:00
|
|
|
|CHANNELS_ADMIN_PUBLIC_TOO_MUCH|You're admin of too many public channels, make some channels private to change the username of this channel|
|
2017-11-03 17:39:50 +01:00
|
|
|
|CHAT_ADMIN_REQUIRED|You must be an admin in this chat to do this|
|
|
|
|
|USERNAME_INVALID|The provided username is not valid|
|
|
|
|
|USERNAME_OCCUPIED|The provided username is already occupied|
|
|
|
|
|
|
|
|
|
2017-03-31 17:35:20 +02:00
|
|
|
### Example:
|
|
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API();
|
2017-12-11 12:12:38 +01:00
|
|
|
$MadelineProto->session = 'mySession.madeline';
|
2017-04-10 13:49:32 +02:00
|
|
|
if (isset($number)) { // Login as a user
|
2017-12-11 12:12:38 +01:00
|
|
|
$MadelineProto->phone_login($number);
|
|
|
|
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
|
2017-03-31 17:35:20 +02:00
|
|
|
$MadelineProto->complete_phone_login($code);
|
|
|
|
}
|
|
|
|
|
2017-07-23 16:33:46 +02:00
|
|
|
$Bool = $MadelineProto->channels->updateUsername(['channel' => InputChannel, 'username' => 'string', ]);
|
2017-03-31 17:35:20 +02:00
|
|
|
```
|
|
|
|
|
2017-07-24 01:32:29 +02:00
|
|
|
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
|
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:
|
|
|
|
|
|
|
|
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/channels.updateUsername`
|
|
|
|
|
|
|
|
Parameters:
|
|
|
|
|
|
|
|
channel - Json encoded InputChannel
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
username - Json encoded string
|
|
|
|
|
2017-07-23 16:40:54 +02:00
|
|
|
|
2017-07-23 16:11:02 +02:00
|
|
|
|
2017-08-20 19:09:52 +02:00
|
|
|
|
2017-03-31 17:35:20 +02:00
|
|
|
Or, if you're into Lua:
|
|
|
|
|
|
|
|
```
|
2017-07-23 16:33:46 +02:00
|
|
|
Bool = channels.updateUsername({channel=InputChannel, username='string', })
|
2017-03-31 17:35:20 +02:00
|
|
|
```
|
|
|
|
|