MadelineProtoDocs/old_docs/API_docs_v62/methods/auth.checkPhone.md

55 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: auth.checkPhone
description: Check if this phone number is registered on telegram
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: auth.checkPhone
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Check if this phone number is registered on telegram
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_number|[string](../types/string.md) | The phone number to check | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md)
2019-08-15 20:25:16 +02:00
### Can bots use this method: **YES**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
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
2018-04-01 13:19:25 +02:00
auth_CheckedPhone = auth.checkPhone({phone_number='string', })
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| 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|
2019-12-27 17:48:04 +01:00
|401|AUTH_KEY_PERM_EMPTY|The temporary auth key must be binded to the permanent auth key to use these methods.|
2018-04-01 13:19:25 +02:00