1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-13 10:27:21 +01:00
MadelineProto/docs/API_docs/methods/auth_cancelCode.md

74 lines
1.6 KiB
Markdown

---
title: auth.cancelCode
description: Invalidate sent phone code
---
## Method: auth.cancelCode
[Back to methods index](index.md)
Invalidate sent phone code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number|
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_INVALID|The phone number is invalid|
### Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
$Bool = $MadelineProto->auth->cancelCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.cancelCode`
Parameters:
phone_number - Json encoded string
phone_code_hash - Json encoded string
Or, if you're into Lua:
```
Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', })
```