MadelineProto/docs/API_docs/methods/messages_sendEncryptedService.md

87 lines
2.3 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: messages.sendEncryptedService
2018-03-23 16:23:49 +01:00
description: Send a service message to a secret chat
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: messages.sendEncryptedService
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Send a service message to a secret chat
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | Yes|The chat where to send the service message|
|message|[CLICK ME DecryptedMessage](../types/DecryptedMessage.md) | Yes|The service message|
2016-12-19 18:35:27 +01: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 |
|----------|---------------|
|DATA_INVALID|Encrypted data invalid|
2017-12-10 11:33:03 +01:00
|ENCRYPTION_DECLINED|The secret chat was declined|
2017-11-03 17:39:50 +01:00
|MSG_WAIT_FAILED|A waiting call returned an error|
2017-11-08 13:04:40 +01:00
|USER_IS_BLOCKED|User is blocked|
2017-11-03 17:39:50 +01:00
2018-03-20 19:57:36 +01:00
### 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();
$messages_SentEncryptedMessage = $MadelineProto->messages->sendEncryptedService(['peer' => InputEncryptedChat, 'message' => DecryptedMessage, ]);
2017-02-13 04:33:06 +01:00
```
2018-03-20 19:57:36 +01:00
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
2017-07-23 16:11:02 +02:00
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.sendEncryptedService
2017-07-23 16:40:54 +02:00
* params - `{"peer": InputEncryptedChat, "message": DecryptedMessage, }`
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.sendEncryptedService`
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-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:
```
messages_SentEncryptedMessage = messages.sendEncryptedService({peer=InputEncryptedChat, message=DecryptedMessage, })
```
## 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.