MadelineProtoDocs/docs/API_docs/methods/initConnection.md

101 lines
2.9 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: initConnection
description: Initializes connection and save information on the user's device and application.
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: initConnection
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Initializes connection and save information on the user's device and application.
### Parameters:
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|api\_id|[int](../types/int.md) | Yes|Application identifier|
|device\_model|[string](../types/string.md) | Yes|Device model|
|system\_version|[string](../types/string.md) | Yes|System version|
|app\_version|[string](../types/string.md) | Yes|App version|
|system\_lang\_code|[string](../types/string.md) | Yes|Language code|
|lang\_pack|[string](../types/string.md) | Yes|Language pack to use|
|lang\_code|[string](../types/string.md) | Yes|Language code to set|
2018-06-29 13:59:08 +02:00
|proxy|[InputClientProxy](../types/InputClientProxy.md) | Optional|The current proxy|
2018-04-01 13:19:25 +02:00
|query|[!X](../types/!X.md) | Yes|Nested query|
### Return type: [X](../types/X.md)
### Can bots use this method: **YES**
### MadelineProto Example:
```
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();
2018-06-29 13:59:08 +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, 'query' => !X, ]);
2018-04-01 13:19:25 +02:00
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - initConnection
2018-06-29 13:59:08 +02:00
* params - `{"api_id": int, "device_model": "string", "system_version": "string", "app_version": "string", "system_lang_code": "string", "lang_pack": "string", "lang_code": "string", "proxy": InputClientProxy, "query": !X, }`
2018-04-01 13:19:25 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/initConnection`
Parameters:
api_id - Json encoded int
device_model - Json encoded string
system_version - Json encoded string
app_version - Json encoded string
system_lang_code - Json encoded string
lang_pack - Json encoded string
lang_code - Json encoded string
2018-06-29 13:59:08 +02:00
proxy - Json encoded InputClientProxy
2018-04-01 13:19:25 +02:00
query - Json encoded !X
Or, if you're into Lua:
```
2018-06-29 13:59:08 +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, query=!X, })
2018-04-01 13:19:25 +02:00
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|CONNECTION_LAYER_INVALID|Layer invalid|
|INPUT_FETCH_FAIL|Failed deserializing TL payload|