1
0
mirror of https://github.com/danog/MadelineProto.git synced 2024-12-12 16:27:22 +01:00
MadelineProto/old_docs/API_docs_v68/methods/auth_cancelCode.md

67 lines
1.4 KiB
Markdown
Raw Normal View History

2017-07-23 17:44:01 +02:00
---
title: auth.cancelCode
description: auth.cancelCode parameters, return type and example
---
## Method: auth.cancelCode
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-07-23 17:44:01 +02:00
|phone\_number|[string](../types/string.md) | Yes|
|phone\_code\_hash|[string](../types/string.md) | Yes|
### 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|
2017-07-23 17:44:01 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-07-23 17:44:01 +02:00
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-07-23 17:44:01 +02:00
$MadelineProto->complete_phone_login($code);
}
$Bool = $MadelineProto->auth->cancelCode(['phone_number' => 'string', 'phone_code_hash' => 'string', ]);
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 17:44:01 +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 17:44:01 +02:00
phone_code_hash - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 17:44:01 +02:00
Or, if you're into Lua:
```
Bool = auth.cancelCode({phone_number='string', phone_code_hash='string', })
```