post_setGameScore

v1.0.0

Use this method to set the score of the specified user in a game. On success, if the message was sent by the bot, returns the edited , otherwise returns True. Returns an error, if the new score is not greater than the user's current score in the chat and force is False.

Input

{
  "type": "object",
  "required": [
    "score",
    "user_id"
  ],
  "properties": {
    "chat_id": {
      "type": "integer",
      "description": "Required if *inline\\_message\\_id* is not specified. Unique identifier for the target chat"
    },
    "disable_edit_message": {
      "type": "boolean",
      "description": "Pass True, if the game message should not be automatically edited to include the current scoreboard"
    },
    "force": {
      "type": "boolean",
      "description": "Pass True, if the high score is allowed to decrease. This can be useful when fixing mistakes or banning cheaters"
    },
    "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"
    },
    "score": {
      "type": "integer",
      "description": "New score, must be non-negative"
    },
    "user_id": {
      "type": "integer",
      "description": "User identifier"
    }
  }
}

Output

{
  "type": "object",
  "required": [
    "ok",
    "result"
  ],
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "result": {
      "type": "object"
    }
  }
}