MadelineProtoDocs/docs/API_docs/methods/messages_sendEncryptedService.md

62 lines
2.0 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.sendEncryptedService
description: Send a service message to a secret chat
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.sendEncryptedService
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Send a service message to a secret chat
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|peer|[Secret chat ID, Update, EncryptedMessage or InputEncryptedChat](../types/InputEncryptedChat.md) | The chat where to send the service message | Yes|
|message|[DecryptedMessage](../types/DecryptedMessage.md) | The service message | Yes|
2018-04-01 13:19:25 +02:00
### Return type: [messages\_SentEncryptedMessage](../types/messages_SentEncryptedMessage.md)
2019-06-30 15:12:21 +02:00
### Can bots use this method: **NO**
2018-04-01 13:19:25 +02:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-04-01 13:19:25 +02:00
```php
2018-04-01 13:19:25 +02:00
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, ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
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.
### Errors this method can return:
| Error | Description |
|----------|---------------|
|DATA_INVALID|Encrypted data invalid|
|ENCRYPTION_DECLINED|The secret chat was declined|
|MSG_WAIT_FAILED|A waiting call returned an error|
2019-08-15 20:25:16 +02:00
|USER_IS_BLOCKED|You were blocked by this user|
2018-04-01 13:19:25 +02:00