MadelineProtoDocs/docs/API_docs/methods/initConnection.md

63 lines
2.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: initConnection
2019-12-27 17:48:04 +01:00
description: Initialize connection
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
---
2020-06-16 17:50:25 +02:00
# Method: initConnection
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2020-06-16 17:50:25 +02:00
2019-12-27 17:48:04 +01:00
Initialize connection
2018-04-01 13:19:25 +02:00
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|api\_id|[int](../types/int.md) | Application identifier (see. [App configuration](https://core.telegram.org/myapp)) | Yes|
2018-08-29 11:18:25 +02:00
|device\_model|[string](../types/string.md) | Device model | Yes|
2019-12-27 17:48:04 +01:00
|system\_version|[string](../types/string.md) | Operation system version | Yes|
|app\_version|[string](../types/string.md) | Application version | Yes|
|system\_lang\_code|[string](../types/string.md) | Code for the language used on the device's OS, ISO 639-1 standard | Yes|
2018-08-29 11:18:25 +02:00
|lang\_pack|[string](../types/string.md) | Language pack to use | Yes|
2019-12-27 17:48:04 +01:00
|lang\_code|[string](../types/string.md) | Code for the language used on the client, ISO 639-1 standard | Yes|
|proxy|[InputClientProxy](../types/InputClientProxy.md) | Info about an MTProto proxy | Optional|
2020-06-16 17:50:25 +02:00
|params|[JSONValue](../types/JSONValue.md) | Additional initConnection parameters. <br>For now, only the `tz_offset` field is supported, for specifying timezone offset in seconds. | Optional|
2019-12-27 17:48:04 +01:00
|query|[!X](../types/!X.md) | The query itself | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [X](../types/X.md)
### Can bots use this method: **YES**
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
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();
2020-06-16 17:50:25 +02:00
$X = $MadelineProto->initConnection(['api_id' => int, 'device_model' => 'string', 'system_version' => 'string', 'app_version' => 'string', 'system_lang_code' => 'string', 'lang_pack' => 'string', 'lang_code' => 'string', 'proxy' => InputClientProxy, 'params' => JSONValue, 'query' => !X, ]);
2018-04-01 13:19:25 +02:00
```
Or, if you're into Lua:
```lua
2020-06-16 17:50:25 +02:00
X = initConnection({api_id=int, device_model='string', system_version='string', app_version='string', system_lang_code='string', lang_pack='string', lang_code='string', proxy=InputClientProxy, params=JSONValue, query=!X, })
2018-04-01 13:19:25 +02:00
```
2019-09-02 17:41:28 +02:00
### Errors
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|CONNECTION_LAYER_INVALID|Layer invalid|
|400|INPUT_FETCH_FAIL|Failed deserializing TL payload|
2018-04-01 13:19:25 +02:00