StartMatchingBackfill

Last updated: 2021-05-17 15:04:12

1. API Description

Domain name for API request: gpm.tencentcloudapi.com.

This API is used to send a match backfill request, for which a MatchTicket will be searched to start a new match.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: StartMatchingBackfill.
Version Yes String Common parameter. The value used for this API: 2020-08-20.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
MatchCode Yes String MatchCode
Players.N Yes Array of Player Player information
GameServerSessionId Yes String Game server session ID. It should contain 1 to 256 ASCII characters.
MatchTicketId No String MatchTicket ID, which can contain 1 to 128 characters. This parameter is left empty by default, and in this case, MatchTicket ID will be automatically generated by GPM.

3. Output Parameters

Parameter Name Type Description
MatchTicket MatchTicket MatchTicket
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Starting match backfill

Input Example

https://gpm.tencentcloudapi.com/?Action=StartMatchingBackfill
&MatchCode=match_code
&MatchTicketId=match_ticket_id
&Players.0.Id=player_id_0
&Players.0.Name=player_name
&Players.0.Team=player_team
&Players.0.CustomPlayerStatus=0
&Players.0.CustomProfile=player_custom_profile
&Players.0.MatchAttributes.0.Name=player_match_attributes_name
&Players.0.MatchAttributes.0.Type=0
&Players.0.MatchAttributes.0.NumberValue=10
&Players.0.RegionLatencies.0.Region=ap-shanghai
&Players.0.RegionLatencies.0.Latency=100
&GameServerSessionId=game_server_session_id
&<Common request parameters>

Output Example

{
  "Response": {
    "MatchTicket": {
      "EndTime": "",
      "Id": "ml0urJm",
      "MatchCode": "match-lipp",
      "MatchResult": "",
      "MatchType": "",
      "Players": [
        {
          "CustomPlayerStatus": 0,
          "CustomProfile": "",
          "Id": "fisher0",
          "MatchAttributes": [
            {
              "ListValue": [],
              "MapValue": [],
              "Name": "numberAttr",
              "NumberValue": 10,
              "StringValue": "",
              "Type": 0
            },
            {
              "ListValue": [],
              "MapValue": [],
              "Name": "stringAttr",
              "NumberValue": 0,
              "StringValue": "stringAttrVal",
              "Type": 1
            },
            {
              "ListValue": [
                "listAttrVal1",
                "listAttrVal2",
                "listAttrVal3"
              ],
              "MapValue": [],
              "Name": "listAttr",
              "NumberValue": 0,
              "StringValue": "",
              "Type": 2
            },
            {
              "ListValue": [],
              "MapValue": [
                {
                  "Key": "mapAttrVal1",
                  "Value": 10
                },
                {
                  "Key": "mapAttrVal2",
                  "Value": 20
                },
                {
                  "Key": "mapAttrVal3",
                  "Value": 30
                }
              ],
              "Name": "mapAttr",
              "NumberValue": 0,
              "StringValue": "",
              "Type": 3
            }
          ],
          "Name": "playerName0",
          "RegionLatencies": [
            {
              "Latency": 100,
              "Region": "ap-guangzhou"
            },
            {
              "Latency": 100,
              "Region": "ap-beijing"
            }
          ],
          "Team": "playerTeam0"
        }
      ],
      "StartTime": "2020-09-05T11:11:15Z",
      "Status": "TIMEDOUT",
      "StatusMessage": "",
      "StatusReason": ""
    },
    "RequestId": "1a68664b-d796-407b-ab7b-2dbc2a12f8f5"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
AuthFailure CAM signature/authentication error
FailedOperation Operation failed
FailedOperation.FrequencySamePlayerLimited Frequency limit. The interval between the player's repeated request for matchmaking shall not be less than 100 ms.
FailedOperation.ServiceUnavailable System error. If you cannot solve the problem, please submit a ticket.
InternalError Internal error
InvalidAction The API does not exist.
InvalidParameter Parameter error
InvalidParameterValue Invalid parameter value
InvalidParameterValue.GameServerSessionRepeated A GameServerSession is in progress. Start another session until this one is completed.
InvalidParameterValue.InvalidRuleScript Incorrect rule script
InvalidParameterValue.MatchCodeNotFound MatchCode does not exist.
InvalidParameterValue.MatchFeildValueLimit The length of field value exceeds the limit.
InvalidParameterValue.MatchInvalidCharacters Field contains invalid characters.
InvalidParameterValue.MatchPlayersLimit The number of players exceeds the limit.
InvalidParameterValue.MatchPlayersRepeated The player ID already exists.
InvalidParameterValue.MatchTicketIdNotFound The MatchTicket ID does not exist.
InvalidParameterValue.MatchTicketIdRepeated The MatchTicket ID already exists.
InvalidParameterValue.RuleNotFound The rule does not exist.
LimitExceeded Quota limit exceeded.
MissingParameter The parameter is missing.
NoSuchVersion API version does not exist.
OperationDenied Operation denied
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceUnavailable The resource is unavailable.
UnauthorizedOperation The operation is unauthorized.
UnauthorizedOperation.UnauthorizedAction API permission authorization is needed.
UnknownParameter Unknown parameter error
UnsupportedOperation Unsupported operation
UnsupportedRegion The API does not support the region passed in.