55 lines
1.4 KiB
Markdown
55 lines
1.4 KiB
Markdown
---
|
|
title: auth.checkPhone
|
|
description: auth.checkPhone parameters, return type and example
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
|
redirect_from: /API_docs/methods/auth_checkPhone.html
|
|
---
|
|
# Method: auth.checkPhone
|
|
[Back to methods index](index.md)
|
|
|
|
|
|
|
|
### Parameters:
|
|
|
|
| Name | Type | Required |
|
|
|----------|---------------|----------|
|
|
|phone\_number|[string](../types/string.md) | Yes|
|
|
|
|
|
|
### Return type: [auth.CheckedPhone](../types/auth.CheckedPhone.md)
|
|
|
|
### Can bots use this method: **YES**
|
|
|
|
|
|
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
|
|
|
|
|
|
```php
|
|
if (!file_exists('madeline.php')) {
|
|
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
|
|
}
|
|
include 'madeline.php';
|
|
|
|
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
|
|
$MadelineProto->start();
|
|
|
|
$auth.CheckedPhone = $MadelineProto->auth->checkPhone(['phone_number' => 'string', ]);
|
|
```
|
|
|
|
Or, if you're into Lua:
|
|
|
|
```lua
|
|
auth.CheckedPhone = auth.checkPhone({phone_number='string', })
|
|
```
|
|
|
|
### Errors
|
|
|
|
| Code | Type | Description |
|
|
|------|----------|---------------|
|
|
|400|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram|
|
|
|400|PHONE_NUMBER_INVALID|The phone number is invalid|
|
|
|406|PHONE_NUMBER_INVALID|The phone number is invalid|
|
|
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
|
|
|
|
|