MadelineProtoDocs/docs/API_docs/methods/messages.getStatsURL.md

55 lines
1.7 KiB
Markdown
Raw Normal View History

2018-12-26 02:56:50 +01:00
---
title: messages.getStatsURL
2019-12-27 17:48:04 +01:00
description: Returns URL with the chat statistics. Currently this method can be used only for channels
2018-12-26 02:56:50 +01:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2019-12-27 18:46:25 +01:00
redirect_from: /API_docs/methods/messages_getStatsURL.html
2018-12-26 02:56:50 +01:00
---
# Method: messages.getStatsURL
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Returns URL with the chat statistics. Currently this method can be used only for channels
2018-12-26 02:56:50 +01:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|dark|[Bool](../types/Bool.md) | Pass true if a URL with the dark theme must be returned | Optional|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | Chat identifier | Optional|
|params|[string](../types/string.md) | Parameters from `tg://statsrefresh?params=******` link | Yes|
2018-12-26 02:56:50 +01:00
### Return type: [StatsURL](../types/StatsURL.md)
2019-06-30 15:12:21 +02:00
### Can bots use this method: **NO**
2018-12-26 02:56:50 +01:00
2019-06-02 13:49:54 +02:00
### MadelineProto Example ([now async for huge speed and parallelism!](https://docs.madelineproto.xyz/docs/ASYNC.html)):
2018-12-26 02:56:50 +01:00
```php
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();
2019-03-29 21:12:30 +01:00
$StatsURL = $MadelineProto->messages->getStatsURL(['dark' => Bool, 'peer' => InputPeer, 'params' => 'string', ]);
2018-12-26 02:56:50 +01:00
```
Or, if you're into Lua:
```lua
2019-03-29 21:12:30 +01:00
StatsURL = messages.getStatsURL({dark=Bool, peer=InputPeer, params='string', })
2018-12-26 02:56:50 +01:00
```
2019-09-02 17:41:28 +02:00
### Errors
2019-08-15 20:25:16 +02:00
2019-09-02 17:41:28 +02:00
| Code | Type | Description |
|------|----------|---------------|
|400|PEER_ID_INVALID|The provided peer id is invalid|
2019-08-15 20:25:16 +02:00