initConnection

Initialize connection

API section: Miscellaneous

initConnection#c1cd5ea9 {X:Type} flags:# api_id:int device_model:string system_version:string app_version:string system_lang_code:string lang_pack:string lang_code:string proxy:flags.0?InputClientProxy params:flags.1?JSONValue query:!X = X;

Parameters

NameTypeDescription
flags # Bit mask: a field written flags.N?T is present only when bit N is set.
api_id int Application identifier issued at my.ansible.su.
device_model string Device model — appears in the list of active sessions.
system_version string System version — appears in the list of active sessions.
app_version string App version — appears in the list of active sessions.
system_lang_code string
lang_pack string Language pack name.
lang_code string Language code, ISO 639-1.
proxy flags.0?InputClientProxy
params flags.1?JSONValue
query !X Search query.

Result

X

Possible errors

This method has no errors of its own: it either answers or fails on the shared checks below.

Common to every call

CodeTypeWhat it means
401 AUTH_KEY_UNREGISTERED The server does not know this session: the key was revoked, expired, or the call was made before authorisation.
401 API_ID_INVALID This api_id was never issued or has been blocked. Keys come from my.ansible.su.
400 CONNECTION_LAYER_INVALID The client did not declare a layer, or declared one the server does not know.
420 FLOOD_WAIT_X Too often. Do not retry for X seconds — the number arrives in the error text.
500 INTERNAL A failure on our side. The request may be retried; if it keeps failing, it is a bug of ours.

Related pages

Types used here