MadelineProto/old_docs/API_docs_v42/methods/messages_sendBroadcast.md

84 lines
2.0 KiB
Markdown
Raw Normal View History

---
2017-01-19 23:02:27 +01:00
title: messages.sendBroadcast
description: messages.sendBroadcast parameters, return type and example
---
2017-01-19 23:02:27 +01:00
## Method: messages.sendBroadcast
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|contacts|Array of [InputUser](../types/InputUser.md) | Yes|
|message|[string](../types/string.md) | Yes|
|media|[InputMedia](../types/InputMedia.md) | Yes|
### Return type: [Updates](../types/Updates.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
if (isset($number)) { // Login as a user
$sentCode = $MadelineProto->phone_login($number);
echo 'Enter the code you received: ';
$code = '';
for ($x = 0; $x < $sentCode['type']['length']; $x++) {
$code .= fgetc(STDIN);
}
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$Updates = $MadelineProto->messages->sendBroadcast(['contacts' => [InputUser], 'message' => 'string', 'media' => InputMedia, ]);
2017-02-13 04:33:06 +01:00
```
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.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.