MadelineProto/old_docs/API_docs_v65/methods/help_setBotUpdatesStatus.md

78 lines
1.8 KiB
Markdown
Raw Normal View History

2017-04-21 13:27:04 +02: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 |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
2017-04-21 13:27:04 +02:00
|pending\_updates\_count|[int](../types/int.md) | Yes|
|message|[string](../types/string.md) | Yes|
### Return type: [Bool](../types/Bool.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-04-21 13:27:04 +02:00
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
2017-04-21 13:27:04 +02:00
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
2017-04-21 13:27:04 +02:00
}
if (isset($number)) { // Login as a user
2017-12-11 12:12:38 +01:00
$MadelineProto->phone_login($number);
$code = readline('Enter the code you received: '); // Or do this in two separate steps in an HTTP API
2017-04-21 13:27:04 +02:00
$MadelineProto->complete_phone_login($code);
}
2017-07-23 16:33:46 +02:00
$Bool = $MadelineProto->help->setBotUpdatesStatus(['pending_updates_count' => int, 'message' => 'string', ]);
2017-04-21 13:27:04 +02: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 - 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
2017-04-21 13:27:04 +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', })
2017-04-21 13:27:04 +02:00
```
## 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.