MadelineProto/docs/TD_docs/methods/changePhoneNumber.md

77 lines
2.2 KiB
Markdown
Raw Normal View History

---
title: changePhoneNumber
description: Changes user's phone number and sends authentication code to the new user's phone number. Returns authStateWaitCode with information about sent code on success
---
## Method: changePhoneNumber
[Back to methods index](index.md)
2017-06-06 18:39:21 +02:00
YOU CANNOT USE THIS METHOD IN MADELINEPROTO
Changes user's phone number and sends authentication code to the new user's phone number. Returns authStateWaitCode with information about sent code on success
### Params:
| Name | Type | Required | Description |
|----------|:-------------:|:--------:|------------:|
|phone\_number|[string](../types/string.md) | Yes|New user's phone number in any reasonable format|
|allow\_flash\_call|[Bool](../types/Bool.md) | Yes|Pass True, if code can be sent via flash call to the specified phone number|
|is\_current\_phone\_number|[Bool](../types/Bool.md) | Yes|Pass true, if the phone number is used on the current device. Ignored if allow_flash_call is False|
### Return type: [AuthState](../types/AuthState.md)
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
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);
}
2017-07-23 16:33:46 +02:00
$AuthState = $MadelineProto->changePhoneNumber(['phone_number' => 'string', 'allow_flash_call' => Bool, 'is_current_phone_number' => Bool, ]);
```
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
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - changePhoneNumber
2017-07-23 16:40:54 +02:00
* params - `{"phone_number": "string", "allow_flash_call": Bool, "is_current_phone_number": Bool, }`
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/changePhoneNumber`
Parameters:
phone_number - Json encoded string
allow_flash_call - Json encoded Bool
is_current_phone_number - Json encoded Bool
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
AuthState = changePhoneNumber({phone_number='string', allow_flash_call=Bool, is_current_phone_number=Bool, })
```