MadelineProtoDocs/docs/API_docs/methods/messages_getGameHighScores.md

84 lines
2.0 KiB
Markdown
Raw Normal View History

2018-04-01 13:19:25 +02:00
---
title: messages.getGameHighScores
description: Get high scores of a game
2018-04-04 19:52:48 +02:00
image: https://docs.madelineproto.xyz/favicons/android-chrome-256x256.png
2018-04-01 13:19:25 +02:00
---
2018-04-05 01:19:57 +02:00
# Method: messages.getGameHighScores
2018-04-01 13:19:25 +02:00
[Back to methods index](index.md)
Get high scores of a game
### Parameters:
2018-08-29 11:18:25 +02:00
| Name | Type | Description | Required |
|----------|---------------|-------------|----------|
|peer|[Username, chat ID, Update, Message or InputPeer](../types/InputPeer.md) | The chat | Optional|
|id|[int](../types/int.md) | The message ID | Yes|
|user\_id|[Username, chat ID, Update, Message or InputUser](../types/InputUser.md) | The user that set the high scores | Optional|
2018-04-01 13:19:25 +02:00
### Return type: [messages\_HighScores](../types/messages_HighScores.md)
### Can bots use this method: **YES**
### MadelineProto Example:
```php
2018-04-01 13:19:25 +02:00
if (!file_exists('madeline.php')) {
copy('https://phar.madelineproto.xyz/madeline.php', 'madeline.php');
}
2019-03-12 13:25:41 +01:00
define('MADELINE_BRANCH', '');
2018-04-01 13:19:25 +02:00
include 'madeline.php';
$MadelineProto = new \danog\MadelineProto\API('session.madeline');
$MadelineProto->start();
$messages_HighScores = $MadelineProto->messages->getGameHighScores(['peer' => InputPeer, 'id' => int, 'user_id' => InputUser, ]);
```
### [PWRTelegram HTTP API](https://pwrtelegram.xyz) example (NOT FOR MadelineProto):
### As a bot:
POST/GET to `https://api.pwrtelegram.xyz/botTOKEN/madeline`
Parameters:
* method - messages.getGameHighScores
* params - `{"peer": InputPeer, "id": int, "user_id": InputUser, }`
### As a user:
POST/GET to `https://api.pwrtelegram.xyz/userTOKEN/messages.getGameHighScores`
Parameters:
peer - Json encoded InputPeer
id - Json encoded int
user_id - Json encoded InputUser
Or, if you're into Lua:
```lua
2018-04-01 13:19:25 +02:00
messages_HighScores = messages.getGameHighScores({peer=InputPeer, id=int, user_id=InputUser, })
```
### Errors this method can return:
| Error | Description |
|----------|---------------|
|PEER_ID_INVALID|The provided peer id is invalid|
|USER_BOT_REQUIRED|This method can only be called by a bot|