MadelineProtoDocs/old_docs/API_docs_v23/methods/messages.sendBroadcast.md

53 lines
1.8 KiB
Markdown
Raw Normal View History

2018-04-01 13:24:46 +02:00
---
title: messages.sendBroadcast
description: Send a message to all users in the chat list
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:24:46 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.sendBroadcast
2018-04-01 13:24:46 +02:00
[Back to methods index](index.md)
Send a message to all users in the chat list
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The users to which send the message | Yes|
|message|[string](../types/string.md) | The message | Yes|
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | The media | Optional|
2018-04-01 13:24:46 +02:00
### Return type: [messages\_StatedMessages](../types/messages_StatedMessages.md)
### Can bots use this method: **YES**
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:24:46 +02:00
```php
2018-04-01 13:24:46 +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_StatedMessages = $MadelineProto->messages->sendBroadcast(['contacts' => [InputUser, InputUser], 'message' => 'string', 'media' => InputMedia, ]);
```
Or, if you're into Lua:
```lua
2018-04-01 13:24:46 +02:00
messages_StatedMessages = messages.sendBroadcast({contacts={InputUser}, message='string', media=InputMedia, })
```
## 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\_StatedMessages](../types/messages_StatedMessages.md) will be returned instead.