MadelineProto/docs/TD_docs/methods/setAuthPhoneNumber.md

77 lines
2.4 KiB
Markdown
Raw Normal View History

---
title: setAuthPhoneNumber
description: Sets user's phone number and sends authentication code to the user. Works only when authGetState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode
---
## Method: setAuthPhoneNumber
[Back to methods index](index.md)
2017-06-06 18:39:21 +02:00
YOU CANNOT USE THIS METHOD IN MADELINEPROTO
Sets user's phone number and sends authentication code to the user. Works only when authGetState returns authStateWaitPhoneNumber. If phone number is not recognized or another error has happened, returns an error. Otherwise returns authStateWaitCode
### Params:
| Name | Type | Required | Description |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|-------------|
|phone\_number|[string](../types/string.md) | Yes|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->setAuthPhoneNumber(['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 - setAuthPhoneNumber
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/setAuthPhoneNumber`
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 = setAuthPhoneNumber({phone_number='string', allow_flash_call=Bool, is_current_phone_number=Bool, })
```