MadelineProtoDocs/old_docs/API_docs_v105/methods/messages.getOnlines.md

53 lines
1.3 KiB
Markdown
Raw Normal View History

2018-12-26 02:56:50 +01:00
---
title: messages.getOnlines
2019-12-27 17:48:04 +01:00
description: Get count of online users in a chat
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_getOnlines.html
2018-12-26 02:56:50 +01:00
---
# Method: messages.getOnlines
[Back to methods index](index.md)
2019-12-27 17:48:04 +01:00
Get count of online users in a chat
2018-12-26 02:56:50 +01:00
### Parameters:
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
2019-12-27 17:48:04 +01:00
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional|
2018-12-26 02:56:50 +01:00
### Return type: [ChatOnlines](../types/ChatOnlines.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();
$ChatOnlines = $MadelineProto->messages->getOnlines(['peer' => InputPeer, ]);
```
Or, if you're into Lua:
```lua
ChatOnlines = messages.getOnlines({peer=InputPeer, })
```
2019-12-27 17:48:04 +01:00
### Errors
| Code | Type | Description |
|------|----------|---------------|
|400|PEER_ID_INVALID|The provided peer id is invalid|