MadelineProto/old_docs/API_docs_v71/methods/auth_checkPassword.md

64 lines
1.3 KiB
Markdown
Raw Normal View History

2017-10-14 11:50:46 +02:00
---
title: auth.checkPassword
description: auth.checkPassword parameters, return type and example
---
## Method: auth.checkPassword
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
|password\_hash|[bytes](../types/bytes.md) | Yes|
### Return type: [auth\_Authorization](../types/auth_Authorization.md)
### Can bots use this method: **NO**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PASSWORD_HASH_INVALID|The provided password hash is invalid|
2017-10-14 11:50:46 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-10-14 11:50:46 +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-10-14 11:50:46 +02:00
$MadelineProto->complete_phone_login($code);
}
$auth_Authorization = $MadelineProto->auth->checkPassword(['password_hash' => 'bytes', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.checkPassword`
Parameters:
password_hash - Json encoded bytes
Or, if you're into Lua:
```
auth_Authorization = auth.checkPassword({password_hash='bytes', })
```