MadelineProto/old_docs/API_docs_v71/methods/auth_checkPhone.md

68 lines
1.4 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: auth.checkPhone
description: Check if this phone number is registered on telegram
2017-10-14 11:50:46 +02:00
---
## Method: auth.checkPhone
[Back to methods index](index.md)
Check if this phone number is registered on telegram
2017-10-14 11:50:46 +02:00
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-20 16:42:05 +01:00
|phone\_number|[CLICK ME string](../types/string.md) | Yes|The phone number to check|
2017-10-14 11:50:46 +02:00
### Return type: [auth\_CheckedPhone](../types/auth_CheckedPhone.md)
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram|
|PHONE_NUMBER_INVALID|The phone number is invalid|
|PHONE_NUMBER_INVALID|The phone number is invalid|
2018-03-20 19:57:36 +01:00
### MadelineProto Example:
2017-10-14 11:50:46 +02:00
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-10-14 11:50:46 +02:00
}
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-10-14 11:50:46 +02:00
$auth_CheckedPhone = $MadelineProto->auth->checkPhone(['phone_number' => 'string', ]);
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-10-14 11:50:46 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.checkPhone`
Parameters:
phone_number - Json encoded string
Or, if you're into Lua:
```
auth_CheckedPhone = auth.checkPhone({phone_number='string', })
```