MadelineProto/old_docs/API_docs_v57/methods/channels_updateUsername.md
Daniil Gentili e4a326e552
Http refactor (#307)
* refactor

* Apply fixes from StyleCI

* Implement https and http transport, add support for new req_pq_multi, send pending acks and objects in containers along with the next method call, remove dependency on the socket extension.

* Apply fixes from StyleCI

* Make types with empty constructors optional, fix phar archives (fixes #217)

* Apply fixes from StyleCI

* Update to layer 75

* Update github pages gemfile.lock
2018-02-18 14:18:18 +01:00

1.7 KiB

title description
channels.updateUsername channels.updateUsername parameters, return type and example

Method: channels.updateUsername

Back to methods index

Parameters:

Name Type Required
channel InputChannel Optional
username string Yes

Return type: Bool

Can bots use this method: NO

Errors this method can return:

Error Description
CHANNEL_INVALID The provided channel is invalid
CHANNELS_ADMIN_PUBLIC_TOO_MUCH You're admin of too many public channels, make some channels private to change the username of this channel
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

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->updateUsername(['channel' => InputChannel, 'username' => 'string', ]);

Or, if you're using the PWRTelegram HTTP API:

As a user:

POST/GET to https://api.pwrtelegram.xyz/userTOKEN/channels.updateUsername

Parameters:

channel - Json encoded InputChannel

username - Json encoded string

Or, if you're into Lua:

Bool = channels.updateUsername({channel=InputChannel, username='string', })