小游戏
取消
开发
中文
EN
取消
  • 服务端

    • # 创建对局匹配规则

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南。

    接口英文名：gamematch.createMatchRule

    小游戏创建对局匹配规则，并返回一个 matchid。

    每个小游戏可以创建多个 matchid 对应不同的匹配规则。小游戏持有的 matchid 数量上限为 20。

    # 1. 调用方式

    # HTTPS 调用

    POST https://api.weixin.qq.com/wxa/business/gamematch/creatematchrule?access_token=ACCESS_TOKEN

    # 云调用

    • 本接口不支持云调用。

    # 第三方调用

    • 本接口不支持第三方平台调用。

    # 2. 请求参数

    # 查询参数 Query String Parameters

    参数名类型必填示例说明
    access_tokenstring是ACCESS_TOKEN接口调用凭证，可使用 access_token

    # 请求体 Request Payload

    参数名类型必填说明
    team_countnumber是匹配结果中的队伍数量
    team_member_countnumber是匹配结果每个队伍对应的成员数量
    need_room_service_infonumber否是否需要在下发匹配结果时同步创建帧同步房间。0:不需要，1:需要。如果填 1，则会在下发对局匹配结果时携带accessInfo，用于加入帧同步房间。 要求 team_count * team_member_count 不超过 10 人才可以使用该项。
    game_room_infoobject否创建帧同步房间时的房间信息。在 need_room_service_info 为 1 时有效。

    # Body.game_room_info Object Payload

    创建帧同步房间时的房间信息。在 need_room_service_info 为 1 时有效。

    参数名类型必填说明
    game_ticknumber是后台下发游戏逻辑帧的周期，单位 ms，最小不得小于 33ms
    start_percentnumber是不填或者填 0 代表微信后台只要收到一次“开始游戏”指令就会开始游戏，否则微信后台会统计发送“开始游戏”指令的玩家数达到规定的百分比后才能启动游戏，填 50 表征 50%
    udp_reliability_strategynumber是使用的 UDP 可靠性策略，N：固定冗余 N 帧。建议值：3
    need_user_infoboolean否房间是否需要用户的头像昵称——如果填 True，微信后台会去校验用户是否授权该应用获取其头像昵称的权限。如果房间需要头像昵称但是用户未授权，则用户后续加入房间的请求会返回失败；如果 need_user_info 为 False，后续用户的加入房间操作会成功，但微信后台不会在房间信息中下发用户的头像昵称。
    game_last_timenumber否游戏对局时长，单位 s，不得超过微信后台最大限制 1 个小时，如果不填或填 0 则默认为 20 分钟
    need_game_seedboolean否是否需要在创建房间时同时生成一个随机的游戏种子

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    errcodenumber错误码
    errmsgstring错误提示信息
    match_idstring匹配池对应的 id，加入匹配时需要携带 matchid 以加入对应的匹配池

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    请求示例

    {
  "team_count": 2,
  "team_member_count": 1,
  "need_room_service_info":1, 
  "game_room_info":{
      "game_tick": 30, 
      "udp_reliability_strategy": 3,
      "start_percent": 100,
      "need_user_info": true,
      "game_last_time": 1800,
      "need_game_seed": true
  }
}

    返回示例

    {
  "errcode": 0,
  "errmsg": "ok",
  "match_id": "FD0PT4rKguEdK-L83RaJgdbchUCW8wjhSwgCku4CLQk"
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述
    -1系统繁忙，此时请开发者稍候再试
    0请求成功
    200000无效的请求数据
    500008每个对局需要的玩家数量超过房间服务人数上限
    500014小程序拥有的 matchid 数量超过上限

    # 7. 适用范围

    本接口支持「小游戏」账号类型调用。其他账号类型如无特殊说明，均不可调用。

    点击咨询小助手