MadelineProto/docs/API_docs/methods/messages_getInlineGameHighScores.md

80 lines
1.9 KiB
Markdown
Raw Normal View History

2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
title: messages.getInlineGameHighScores
description: messages.getInlineGameHighScores parameters, return type and example
2016-12-20 13:15:22 +01:00
---
2017-01-19 23:02:27 +01:00
## Method: messages.getInlineGameHighScores
2016-12-20 13:15:22 +01:00
[Back to methods index](index.md)
### Parameters:
| Name | Type | Required |
2017-08-20 11:05:56 +02:00
|----------|---------------|----------|
|id|[InputBotInlineMessageID](../types/InputBotInlineMessageID.md) | Yes|
|user\_id|[InputUser](../types/InputUser.md) | Yes|
2016-12-19 18:35:27 +01:00
### Return type: [messages\_HighScores](../types/messages_HighScores.md)
2017-08-28 12:44:50 +02:00
### Can bots use this method: **YES**
2017-11-03 17:39:50 +01:00
### Errors this method can return:
| Error | Description |
|----------|---------------|
|MESSAGE_ID_INVALID|The provided message id is invalid|
|USER_BOT_REQUIRED|This method can only be called by a bot|
### Example:
```
$MadelineProto = new \danog\MadelineProto\API();
2017-12-11 12:12:38 +01:00
$MadelineProto->session = 'mySession.madeline';
if (isset($token)) { // Login as a bot
2017-06-19 18:56:47 +02:00
$MadelineProto->bot_login($token);
}
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
$MadelineProto->complete_phone_login($code);
}
2016-12-21 10:40:30 +01:00
$messages_HighScores = $MadelineProto->messages->getInlineGameHighScores(['id' => InputBotInlineMessageID, 'user_id' => InputUser, ]);
2017-02-13 04:33:06 +01: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 - messages.getInlineGameHighScores
2017-07-23 16:40:54 +02:00
* params - `{"id": InputBotInlineMessageID, "user_id": InputUser, }`
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/messages.getInlineGameHighScores`
Parameters:
id - Json encoded InputBotInlineMessageID
2017-08-20 19:09:52 +02:00
2017-07-23 16:11:02 +02:00
user_id - Json encoded InputUser
2017-07-23 16:40:54 +02:00
2017-07-23 16:11:02 +02:00
2017-08-20 19:09:52 +02:00
Or, if you're into Lua:
```
messages_HighScores = messages.getInlineGameHighScores({id=InputBotInlineMessageID, user_id=InputUser, })
```