61 lines
2.1 KiB
Markdown
61 lines
2.1 KiB
Markdown
|
---
|
||
|
|
title: auth.signIn
|
||
|
|
description: Signs in a user with a validated phone number.
|
||
|
|
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
|
||
|
|
redirect_from: /API_docs/methods/auth_signIn.html
|
||
|
|
---
|
||
|
|
# Method: auth.signIn
|
||
|
|
[Back to methods index](index.md)
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
Signs in a user with a validated phone number.
|
||
|
|
|
||
|
|
### Parameters:
|
||
|
|
|
||
|
|
| Name | Type | Description | Required |
|
||
|
|
|----------|---------------|-------------|----------|
|
||
|
|
|phone\_number|[string](../types/string.md) | Phone number in the international format | Yes|
|
||
|
|
|phone\_code\_hash|[string](../types/string.md) | SMS-message ID, obtained from [auth.sendCode](../methods/auth.sendCode.md) | Yes|
|
||
|
|
|phone\_code|[string](../types/string.md) | Valid numerical code from the SMS-message | Yes|
|
||
|
|
|
||
|
|
|
||
|
|
### Return type: [auth.Authorization](../types/auth.Authorization.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();
|
||
|
|
|
||
|
|
$auth.Authorization = $MadelineProto->auth->signIn(['phone_number' => 'string', 'phone_code_hash' => 'string', 'phone_code' => 'string', ]);
|
||
|
|
```
|
||
|
|
|
||
|
|
Or, if you're into Lua:
|
||
|
|
|
||
|
|
```lua
|
||
|
|
auth.Authorization = auth.signIn({phone_number='string', phone_code_hash='string', phone_code='string', })
|
||
|
|
```
|
||
|
|
|
||
|
|
### Errors
|
||
|
|
|
||
|
|
| Code | Type | Description |
|
||
|
|
|------|----------|---------------|
|
||
|
|
|400|PHONE_CODE_EMPTY|phone_code is missing|
|
||
|
|
|400|PHONE_CODE_EXPIRED|The phone code you provided has expired, this may happen if it was sent to any chat on telegram (if the code is sent through a telegram chat (not the official account) to avoid it append or prepend to the code some chars)|
|
||
|
|
|400|PHONE_CODE_INVALID|The provided phone code is invalid|
|
||
|
|
|400|PHONE_NUMBER_INVALID|The phone number is invalid|
|
||
|
|
|400|PHONE_NUMBER_UNOCCUPIED|The phone number is not yet being used|
|
||
|
|
|401|SESSION_PASSWORD_NEEDED|2FA is enabled, use a password to login|
|
||
|
|
|
||
|
|
|