# lock-step.getGameRoomInfo
本接口应在服务器端调用,详细说明参见服务端 API。
获取指定房间信息
# 请求地址
GET https://api.weixin.qq.com/wxa/getwxagameroominfo?access_token=XXX&access_info=YYY
# 请求参数 - Query
| 属性 | 类型 | 默认值 | 必填 | 说明 |
|---|---|---|---|---|
| access_token / cloudbase_access_token | string | 是 | 微信后台接口调用凭证 | |
| access_info | string | 是 | 房间/对局访问凭证,不同于 access_token |
# 返回值
# Object
返回的 JSON 数据包
| 属性 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误提示信息 |
| data | Object | 房间/对局访问凭证数据 |
errcode 的合法值
| 值 | 说明 | 最低版本 |
|---|---|---|
| 0 | 请求成功 | |
| -1 | 系统繁忙,此时请开发者稍候再试 |
data 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| room_id_str | string | 房间 ID |
| room_state | number | 1:组队中,2:该房间的对局游戏已开始,3:该房间的对局游戏已结束,4:房间已销毁 |
| max_member_num | number | 房间最大可容纳人数 |
| create_timestamp | number | 创建时间 |
| update_timestamp | number | 最近更新时间 |
| game_tick | number | 游戏下发帧的时间间隔,单位 ms |
| start_percent | number | 真正开始帧同步需要达到多少百分比的玩家发送了开始指令,填 50 表征 50% |
| game_last_time | number | 游戏对局时长,单位 s |
| game_version | number | 第三方自定义的游戏版本号 |
| game_access_info | string | 该房间对应的游戏的 access_info |
| udp_reliability_strategy | number | UDP 可靠性策略, 0:全冗余 N:固定冗余 N 帧 |
| room_ext_info | string | 给第三方用的 buffer,最长 32 个字节 |
| seed | string | 游戏随机种子 |
| member_list | Array.<Object> | 成员列表 |
member_list 的结构
| 属性 | 类型 | 说明 |
|---|---|---|
| is_ready | bool | 玩家准备状态 |
| role | number | 0:普通成员 1:房主 |
| pos_num | number | 座位号,从 0 开始 |
| headimg | string | 头像 URL(用户授权才会返回) |
| nickname | string | 用户昵称(用户授权才会返回) |
| client_id | number | 用户在房间内的唯一标识 |
| enable_to_start | bool | 是否已做好游戏开始准备 |
| member_ext_info | string | 给第三方用的 buffer,最长 32 个字节 |