#

Description
- Query basic information of a single game
Request URL
- Test environment: see the query_match_base field in Obtain Server End API Configurations
- Production environment: see the query_match_base field in Obtain Server End API Configurations
Request Method
- Transmission protocol: HTTPS
- Request method: POST
- Parameters are passed in the body in JSON format (see request example)
- Content-Type: application/json;charset=utf-8 needs to be added to the Header
- Authorization needs to be added to the Header
Request Header [Authorization]
Request Parameters
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| match_id | Special Optional | string | Game session ID, cannot be empty at the same time as report_game_info_key |
| report_game_info_key | Special Optional | string | The report information key passed in at the beginning of the game, can be empty at the same time as match_id. If report_game_info_key and match_id exist at the same time, match_id has a higher priority than report_game_info_key. |
Request Example
{
"match_id": "1659497694003"
}
Return Parameters
- BaseResp
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| ret_code | Yes | int | Response code |
| ret_msg | Yes | string | Response message |
| data | Yes | AppServerQueryMatchBaseResp | Response data |
- AppServerQueryMatchBaseResp
| Parameter Name | Required | Type | Description | |
|---|---|---|---|---|
| mg_id | Yes | string | Game ID | 14615640800525066 |
| room_id | Yes | string | Room ID | 9009 |
| game_mode | Yes | int32 | Game mode | 1 |
| match_id | Yes | string | Game session ID | ce56b6lzi1a7 |
| battle_start_at | Yes | string | Game start time stamp (seconds) | 1663991010 |
| battle_end_at | No | string | Game end time stamp (seconds) | 1663991020 |
| battle_duration | No | string | Game duration (seconds) | 10 |
| results | No | PlayerSettleModel[] | Player settlement data | |
| report_game_info_key | No | string | The report information key passed in at the beginning of the game | |
| report_game_info_extras | No | string | Extended parameters passed in at the beginning of the game | |
| status | Yes | string | Game session status: PLAYING: in game, CLOSED: ended |
CLOSED |
- PlayerSettleModel
| Parameter Name | Required | Type | Description | Example |
|---|---|---|---|---|
| uid | Yes | string | User UID, empty character for robot | u001 |
| is_ai | Yes | int32 | 0: ordinary user, 1: robot | 0 |
| score | Yes | int32 | Total score obtained by the player in this game | 10 |
| remain_score | Yes | int32 | Remaining points of the player | 100 |
| commission_score | No | int32 | Commission points deducted | 10 |
Return Example
{
"ret_code": 0,
"ret_msg": "",
"data": {
"mg_id": "1557194155570024449",
"room_id": "90091",
"game_mode": 1,
"match_id": "ce56b6lzi1a7-cf75pcvbs7j1-cx5h93twefna",
"battle_start_at": "1664333908",
"battle_end_at": "1664334968",
"battle_duration": "1060",
"results": [
{
"is_ai": 0,
"uid": "a4c1c93d",
"score": -100,
"remain_score": 0,
"commission_score": 0
},
{
"is_ai": 0,
"uid": "5cb0d3a5",
"score": -100,
"remain_score": 0,
"commission_score": 0
}
],
"report_game_info_key": "mkey001",
"report_game_info_extras": "extras",
"status": "CLOSED"
}
}
Business Error Code
| Error Code | Error Description | Solution |
|---|---|---|
| 10002 | Parameter error | Check the request parameters and resubmit the request |
| 70420 | The game session does not exist | Check whether the order number and the report information key are correct, and then resubmit the request |