MadelineProto/old_docs/API_docs_v66/methods/messages_sendEncryptedFile.md

90 lines
2.4 KiB
Markdown
Raw Normal View History

2017-06-30 15:36:33 +02:00
---
title: messages.sendEncryptedFile
description: messages.sendEncryptedFile parameters, return type and example
---
## Method: messages.sendEncryptedFile
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|
2017-06-30 15:36:33 +02:00
|message|[DecryptedMessage](../types/DecryptedMessage.md) | Yes|
|file|[File path or InputEncryptedFile](../types/InputEncryptedFile.md) | Optional|
2017-06-30 15:36:33 +02:00
### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.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 |
|----------|---------------|
|MSG_WAIT_FAILED|A waiting call returned an error|
2017-06-30 15:36:33 +02:00
### Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-06-30 15:36:33 +02:00
}
include 'madeline.php';
// !!! This API id/API hash combination will not work !!!
// !!! You must get your own @ my.telegram.org !!!
$api_id = 0;
$api_hash = '';
$MadelineProto = new \danog\MadelineProto\API('session.madeline', ['app_info' => ['api_id' => $api_id, 'api_hash' => $api_hash]]);
$MadelineProto->start();
2017-06-30 15:36:33 +02:00
$messages_SentEncryptedMessage = $MadelineProto->messages->sendEncryptedFile(['peer' => InputEncryptedChat, 'message' => DecryptedMessage, 'file' => InputEncryptedFile, ]);
```
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 - messages.sendEncryptedFile
2017-07-23 16:40:54 +02:00
* params - `{"peer": InputEncryptedChat, "message": DecryptedMessage, "file": InputEncryptedFile, }`
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/messages.sendEncryptedFile`
Parameters:
peer - Json encoded InputEncryptedChat
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
message - Json encoded DecryptedMessage
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
file - Json encoded InputEncryptedFile
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
2017-06-30 15:36:33 +02:00
Or, if you're into Lua:
```
messages_SentEncryptedMessage = messages.sendEncryptedFile({peer=InputEncryptedChat, message=DecryptedMessage, file=InputEncryptedFile, })
```
## Return value
If the length of the provided message is bigger than 4096, the message will be split in chunks and the method will be called multiple times, with the same parameters (except for the message), and an array of [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md) will be returned instead.