MadelineProtoDocs/docs/API_docs/methods/auth.sendCode.md

65 lines
2.7 KiB
Markdown
Raw Normal View History

2019-06-23 13:07:51 +02:00
---
title: auth.sendCode
2019-12-27 18:02:36 +01:00
description: You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info)
2019-06-23 13:07:51 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
---
# Method: auth.sendCode
[Back to methods index](index.md)
2019-12-27 18:02:36 +01:00
You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info)
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
### Parameters:
2019-06-23 13:07:51 +02:00
2019-09-02 17:41:28 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 18:02:36 +01:00
|phone\_number|[string](../types/string.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes|
|api\_id|[int](../types/int.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes|
|api\_hash|[string](../types/string.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes|
|settings|[CodeSettings](../types/CodeSettings.md) | You cannot use this method directly, use the phoneLogin method instead (see https://docs.madelineproto.xyz for more info) | Yes|
2019-09-02 17:41:28 +02:00
2019-12-27 18:25:37 +01:00
### Return type: [auth.SentCode](../types/auth.SentCode.md)
2019-09-02 17:41:28 +02:00
### 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();
2019-12-27 18:25:37 +01:00
$auth.SentCode = $MadelineProto->auth->sendCode(['phone_number' => 'string', 'api_id' => int, 'api_hash' => 'string', 'settings' => CodeSettings, ]);
2019-09-02 17:41:28 +02:00
```
Or, if you're into Lua:
```lua
2019-12-27 18:25:37 +01:00
auth.SentCode = auth.sendCode({phone_number='string', api_id=int, api_hash='string', settings=CodeSettings, })
2019-09-02 17:41:28 +02:00
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|API_ID_INVALID|API ID invalid|
|400|API_ID_PUBLISHED_FLOOD|This API id was published somewhere, you can't use it now|
|400|INPUT_REQUEST_TOO_LONG|The request is too big|
|400|PHONE_NUMBER_APP_SIGNUP_FORBIDDEN|You can't sign up using this app|
|400|PHONE_NUMBER_BANNED|The provided phone number is banned from telegram|
|400|PHONE_NUMBER_FLOOD|You asked for the code too many times.|
|400|PHONE_NUMBER_INVALID|The phone number is invalid|
|400|PHONE_PASSWORD_PROTECTED|This phone is password protected|
|400|SMS_CODE_CREATE_FAILED|An error occurred while creating the SMS code|
|406|PHONE_NUMBER_INVALID|The phone number is invalid|
|406|PHONE_PASSWORD_FLOOD|You have tried logging in too many times|
2019-06-23 13:07:51 +02:00