1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-14 09:27:20 +01:00
MadelineProto/old_docs/API_docs_v66/methods/auth_cancelCode.md

69 lines
1.4 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-06-30 15:36:33 +02:00
title: auth.cancelCode
description: Invalidate sent phone code
2016-12-20 13:15:22 +01:00
---
2017-06-30 15:36:33 +02:00
## Method: auth.cancelCode
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
Invalidate sent phone code
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
2018-03-20 16:42:05 +01:00
|phone\_number|[CLICK ME string](../types/string.md) | Yes|Phone number|
|phone\_code\_hash|[CLICK ME string](../types/string.md) | Yes|Phone code hash|
2017-06-30 15:36:33 +02:00
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PHONE_NUMBER_INVALID|The phone number is invalid|
2018-03-20 19:57:36 +01:00
### 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();
2017-07-23 16:33:46 +02:00
$Bool = $MadelineProto->auth->cancelCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.cancelCode`
Parameters:
phone_number - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
phone_code_hash - Json encoded string
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', })
```