MadelineProtoDocs/old_docs/API_docs_v46/methods/auth.signUp.md

62 lines
2.4 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: auth.signUp
2019-12-27 17:48:04 +01:00
description: Registers a validated phone number in the system.
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: auth.signUp
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Registers a validated phone number in the system.
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
### Parameters:
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|phone\_number|[string](../types/string.md) | Phone number in the international format | Yes|
|phone\_code\_hash|[string](../types/string.md) | SMS-message ID | Yes|
|phone\_code|[string](../types/string.md) | You cannot use this method directly, use the completeSignup method instead (see https://docs.madelineproto.xyz for more info) | Yes|
|first\_name|[string](../types/string.md) | New user first name | Yes|
|last\_name|[string](../types/string.md) | New user last name | Yes|
2019-09-02 17:41:28 +02:00
### 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->signUp(['phone_number' => 'string', 'phone_code_hash' => 'string', 'phone_code' => 'string', 'first_name' => 'string', 'last_name' => 'string', ]);
```
Or, if you're into Lua:
```lua
auth_Authorization = auth.signUp({phone_number='string', phone_code_hash='string', phone_code='string', first_name='string', last_name='string', })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|FIRSTNAME_INVALID|The first name is invalid|
|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_FLOOD|You asked for the code too many times.|
|400|PHONE_NUMBER_INVALID|The phone number is invalid|
|400|PHONE_NUMBER_OCCUPIED|The phone number is already in use|
2018-04-01 13:19:25 +02:00