version: 2.1.3







getGameHighScores

Use this method to get data for high score tables. Will return the score of the specified user and several of their neighbors in a game. On success, returns an Array of GameHighScore objects.

Parameters

user_id int Target user id Optional
chat_id int Required if inline_message_id is not specified. Unique identifier for the target chat Optional
message_id int Required if inline_message_id is not specified. Identifier of the sent message Optional
inline_message_id string Required if chat_id and message_id are not specified. Identifier of the inline message Optional
token String You can use this method on another bot with specify this parameter Optional
return_array Boolean Specify the result type , if pass true results will be array otherwise will be object Optional
forgot Boolean You can set to not receive request result, dont set it or pass null for turn it off Optional
answer Boolean You can set to answer to webhook, dont set it or pass null for turn it off Optional

Method errors

ErrorNamedescription
required parameters not found required parameter for this method is not founded. you can see them in log
answer mode not allowed you can use answer mode only once for each webhook update and you already did
answer mode not allowed bc multi you can't use answer mode when multi is on

Method examples

$this->getGameHighScores(['user_id' => int, 'chat_id' => int, 'message_id' => int, 'inline_message_id' => string]);
$this->getGameHighScores();

Method alices

Method output :

Array of GameHighScore