MadelineProto/old_docs/API_docs_v42/methods/messages_sendBroadcast.md

85 lines
2.2 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.sendBroadcast
2018-03-23 17:44:33 +01:00
description: Send a message to all users in the chat list
---
2017-01-19 23:02:27 +01:00
## Method: messages.sendBroadcast
[Back to methods index](index.md)
2018-03-23 17:44:33 +01:00
Send a message to all users in the chat list
### Parameters:
2018-03-23 17:44:33 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|contacts|Array of [Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | Yes|The users to which send the message|
|message|[CLICK ME string](../types/string.md) | Yes|The message|
|media|[MessageMedia, Update, Message or InputMedia](../types/InputMedia.md) | Optional|The media|
### Return type: [Updates](../types/Updates.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
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';
// !!! 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();
$Updates = $MadelineProto->messages->sendBroadcast(['contacts' => [InputUser, InputUser], 'message' => 'string', 'media' => InputMedia, ]);
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.sendBroadcast
2017-07-23 16:40:54 +02:00
* params - `{"contacts": [InputUser], "message": "string", "media": InputMedia, }`
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.sendBroadcast`
Parameters:
contacts - Json encoded array of InputUser
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
message - Json encoded string
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
media - Json encoded InputMedia
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:
```
2017-07-23 16:33:46 +02:00
Updates = 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 [Updates](../types/Updates.md) will be returned instead.