MadelineProtoDocs/old_docs/API_docs_v42/methods/messages.requestEncryption.md

54 lines
1.5 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.requestEncryption
2019-12-27 17:48:04 +01:00
description: Sends a request to start a secret chat to the user.
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: messages.requestEncryption
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Sends a request to start a secret chat to the user.
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
### Parameters:
2018-04-01 13:19:25 +02:00
2019-09-02 17:41:28 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | User ID | Optional|
|g\_a|[bytes](../types/bytes.md) | `A = g ^ a mod p`, see [Wikipedia](https://en.wikipedia.org/wiki/Diffie%E2%80%93Hellman_key_exchange) | Yes|
2019-09-02 17:41:28 +02:00
### Return type: [EncryptedChat](../types/EncryptedChat.md)
### 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();
$EncryptedChat = $MadelineProto->messages->requestEncryption(['user_id' => InputUser, 'g_a' => 'bytes', ]);
```
Or, if you're into Lua:
```lua
EncryptedChat = messages.requestEncryption({user_id=InputUser, g_a='bytes', })
```
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|DH_G_A_INVALID|g_a invalid|
|400|USER_ID_INVALID|The provided user ID is invalid|
2018-04-01 13:19:25 +02:00