MadelineProto/old_docs/API_docs_v46/methods/auth_checkPhone.md

69 lines
1.4 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: auth.checkPhone
description: auth.checkPhone parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: auth.checkPhone
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|phone\_number|[string](../types/string.md) | Yes|
### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
2017-09-01 12:27:38 +02:00
|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram|
|PHONE_NUMBER_INVALID|The phone number is invalid|
2017-09-25 12:26:30 +02:00
|PHONE_NUMBER_INVALID|The phone number is invalid|
2017-09-01 12:27:38 +02:00
2017-08-28 12:44:50 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
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
$auth_CheckedPhone = $MadelineProto->auth->checkPhone(['phone_number' => 'string', ]);
2017-02-13 04:33:06 +01: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/auth.checkPhone`
Parameters:
phone_number - 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
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
auth_CheckedPhone = auth.checkPhone({phone_number='string', })
```