MadelineProto/docs/API_docs/methods/help_setBotUpdatesStatus.md

77 lines
1.7 KiB
Markdown
Raw Normal View History

---
title: help.setBotUpdatesStatus
2018-03-23 16:23:49 +01:00
description: Set the update status of webhook
---
## Method: help.setBotUpdatesStatus
[Back to methods index](index.md)
2018-03-23 16:23:49 +01:00
Set the update status of webhook
### Parameters:
2018-03-23 16:23:49 +01:00
| Name | Type | Required | Description |
|----------|---------------|----------|-------------|
|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|Pending update count|
|message|[CLICK ME string](../types/string.md) | Yes|Message|
### Return type: [Bool](../types/Bool.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';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
2017-07-23 16:33:46 +02:00
$Bool = $MadelineProto->help->setBotUpdatesStatus(['pending_updates_count' => int, 'message' => 'string', ]);
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 - help.setBotUpdatesStatus
2017-07-23 16:40:54 +02:00
* params - `{"pending_updates_count": int, "message": "string", }`
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/help.setBotUpdatesStatus`
Parameters:
pending_updates_count - Json encoded int
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
message - Json encoded string
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
Bool = help.setBotUpdatesStatus({pending_updates_count=int, message='string', })
```
## 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 [Bool](../types/Bool.md) will be returned instead.