MadelineProto/old_docs/API_docs_v72/methods/help_setBotUpdatesStatus.md

80 lines
1.9 KiB
Markdown
Raw Normal View History

2017-11-15 13:41:58 +01:00
---
title: help.setBotUpdatesStatus
description: help.setBotUpdatesStatus parameters, return type and example
---
## Method: help.setBotUpdatesStatus
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
|----------|---------------|----------|
2018-03-20 16:42:05 +01:00
|pending\_updates\_count|[CLICK ME int](../types/int.md) | Yes|
|message|[CLICK ME string](../types/string.md) | Yes|
2017-11-15 13:41:58 +01:00
### Return type: [Bool](../types/Bool.md)
### Can bots use this method: **YES**
### Example:
```
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
2017-11-15 13:41:58 +01:00
}
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();
2017-11-15 13:41:58 +01:00
$Bool = $MadelineProto->help->setBotUpdatesStatus(['pending_updates_count' => int, 'message' => 'string', ]);
```
Or, if you're using the [PWRTelegram HTTP API](https://pwrtelegram.xyz):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - help.setBotUpdatesStatus
* params - `{"pending_updates_count": int, "message": "string", }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/help.setBotUpdatesStatus`
Parameters:
pending_updates_count - Json encoded int
message - Json encoded string
Or, if you're into Lua:
```
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.