MadelineProto/old_docs/API_docs_v23/methods/auth_bindTempAuthKey.md

88 lines
2.1 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: auth.bindTempAuthKey
description: auth.bindTempAuthKey parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: auth.bindTempAuthKey
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|perm\_auth\_key\_id|[long](../types/long.md) | Yes|
|nonce|[long](../types/long.md) | Yes|
|expires\_at|[int](../types/int.md) | Yes|
|encrypted\_message|[bytes](../types/bytes.md) | Yes|
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|ENCRYPTED_MESSAGE_INVALID|Encrypted message invalid|
|INPUT_REQUEST_TOO_LONG|The request is too big|
|TEMP_AUTH_KEY_EMPTY|No temporary auth key provided|
2017-12-21 10:52:23 +01:00
|Timeout|A timeout occurred while fetching data from the bot|
2017-11-03 17:39:50 +01:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$Bool = $MadelineProto->auth->bindTempAuthKey(['perm_auth_key_id' => long, 'nonce' => long, 'expires_at' => int, 'encrypted_message' => 'bytes', ]);
2017-02-13 04:33:06 +01:00
```
2017-07-24 01:32:29 +02:00
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - auth.bindTempAuthKey
2017-07-23 16:40:54 +02:00
* params - `{"perm_auth_key_id": long, "nonce": long, "expires_at": int, "encrypted_message": "bytes", }`
2017-07-23 16:11:02 +02:00
2017-07-23 16:34:36 +02:00
2017-07-23 16:11:02 +02:00
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/auth.bindTempAuthKey`
Parameters:
perm_auth_key_id - Json encoded long
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
nonce - Json encoded long
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
expires_at - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
encrypted_message - Json encoded bytes
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
2017-07-23 16:33:46 +02:00
Bool = auth.bindTempAuthKey({perm_auth_key_id=long, nonce=long, expires_at=int, encrypted_message='bytes', })
```