MadelineProtoDocs/old_docs/API_docs_v82/methods/auth.cancelCode.md

53 lines
1.3 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: auth.cancelCode
2019-12-27 17:48:04 +01:00
description: Cancel the login verification code
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: auth.cancelCode
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Cancel the login verification code
2019-06-23 13:07:51 +02:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|phone\_number|[string](../types/string.md) | Phone number | Yes|
2019-12-27 17:48:04 +01:00
|phone\_code\_hash|[string](../types/string.md) | Phone code hash from [auth.sendCode](../methods/auth.sendCode.md) | Yes|
2019-06-23 13:07:51 +02:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **NO**
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
```php
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', ]);
```
Or, if you're into Lua:
```lua
Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', })
```
2019-09-02 17:41:28 +02:00
### Errors
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|PHONE_NUMBER_INVALID|The phone number is invalid|
2019-06-23 13:07:51 +02:00