643 matches
60 actions
Telegram
60 actions
Communication/Telegram
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 objects.
This method will currently return scores for the target user, plus two of their closest neighbors on each side. Will also return the top three users if the user and his neighbors are not among them. Please note that this behavior is subject to change.
{
"type": "object",
"required": [
"user_id"
],
"properties": {
"chat_id": {
"type": "integer",
"description": "Required if *inline\\_message\\_id* is not specified. Unique identifier for the target chat"
},
"inline_message_id": {
"type": "string",
"description": "Required if *chat\\_id* and *message\\_id* are not specified. Identifier of the inline message"
},
"message_id": {
"type": "integer",
"description": "Required if *inline\\_message\\_id* is not specified. Identifier of the sent message"
},
"user_id": {
"type": "integer",
"description": "Target user id"
}
}
}{
"type": "object",
"required": [
"ok",
"result"
],
"properties": {
"ok": {
"type": "boolean"
},
"result": {
"type": "array",
"items": {
"type": "object",
"description": "This object represents one row of the high scores table for a game.",
"required": [
"position",
"user",
"score"
],
"properties": {
"position": {
"type": "integer",
"description": "Position in high score table for the game"
},
"score": {
"type": "integer",
"description": "Score"
},
"user": {
"type": "object",
"description": "This object represents a Telegram user or bot.",
"required": [
"id",
"is_bot",
"first_name"
],
"properties": {
"can_join_groups": {
"type": "boolean",
"description": "*Optional*. True, if the bot can be invited to groups. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"can_read_all_group_messages": {
"type": "boolean",
"description": "*Optional*. True, if [privacy mode](https://core.telegram.org/bots#privacy-mode) is disabled for the bot. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"first_name": {
"type": "string",
"description": "User's or bot's first name"
},
"id": {
"type": "integer",
"description": "Unique identifier for this user or bot"
},
"is_bot": {
"type": "boolean",
"description": "True, if this user is a bot"
},
"language_code": {
"type": "string",
"description": "*Optional*. [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) of the user's language"
},
"last_name": {
"type": "string",
"description": "*Optional*. User's or bot's last name"
},
"supports_inline_queries": {
"type": "boolean",
"description": "*Optional*. True, if the bot supports inline queries. Returned only in [getMe](https://core.telegram.org/bots/api/#getme)."
},
"username": {
"type": "string",
"description": "*Optional*. User's or bot's username"
}
}
}
}
}
}
}
}