MadelineProtoDocs/old_docs/API_docs_v70/methods/auth_cancelCode.md

54 lines
1.3 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: auth.cancelCode
description: Invalidate sent phone code
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.cancelCode
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Invalidate sent phone code
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_number|[string](../types/string.md) | Phone number | Yes|
|phone\_code\_hash|[string](../types/string.md) | Phone code hash | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
2019-05-04 12:15:39 +02:00
### MadelineProto Example ([now async!](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');
}
2019-03-12 13:25:41 +01:00
define('MADELINE_BRANCH', '');
2018-04-01 13:19:25 +02:00
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$Bool = $MadelineProto->auth->cancelCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
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|