MadelineProtoDocs/docs/API_docs/methods/auth_cancelCode.md
Daniil Gentili e5a1324684 docufix
2018-04-04 23:19:57 +00:00

70 lines
1.4 KiB
Markdown

---
title: auth.cancelCode
description: Invalidate sent phone code
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: auth.cancelCode
[Back to methods index](index.md)
Invalidate sent phone code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|phone\_number|[string](../types/string.md) | Yes|Phone number|
|phone\_code\_hash|[string](../types/string.md) | Yes|Phone code hash|
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### MadelineProto Example:
```
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();
$Bool = $MadelineProto->auth->cancelCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### 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', })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_INVALID|The phone number is invalid|