# 获取指定房间信息

> 接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考[接口调用指南](/doc/oplatform/developers/dev/guide.md)。

接口英文名：lock-step.getGameRoomInfo

本接口用于获取指定房间信息

## 1. 调用方式

### HTTPS 调用

```bash
GET https://api.weixin.qq.com/wxa/getwxagameroominfo?access_token=ACCESS_TOKEN&access_info=ACCESS_INFO
```

### 云调用

- 调用方法：lockstep.getGameRoomInfo

- 出入参和 HTTPS 调用相同，调用方式可查看 [云调用](/doc/oplatform/developers/dev/cloudCall.md) 说明文档。

### 第三方调用

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

## 2. 请求参数

### 查询参数 `Query String Parameters`

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/minigame/dev/api-backend/access-token/api_getaccesstoken)"
  },
  {
    "参数名": "access_info",
    "类型": "string",
    "必填": "是",
    "说明": "房间/对局访问凭证，不同于 access_token"
  }
]
```

### 请求体 `Request Payload`

无

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误提示信息"
  },
  {
    "参数名": "data",
    "类型": "object",
    "说明": "房间/对局访问凭证数据"
  }
]
```

### Res.data `Object Payload`

房间/对局访问凭证数据

```json
[
  {
    "参数名": "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",
    "类型": "objarray",
    "说明": "成员列表"
  }
]
```

">

### Res.data.member_list(Array) `Object Payload`

成员列表

```json
[
  {
    "参数名": "is_ready",
    "类型": "boolean",
    "说明": "玩家准备状态"
  },
  {
    "参数名": "role",
    "类型": "number",
    "说明": "0：普通成员 1：房主"
  },
  {
    "参数名": "pos_num",
    "类型": "number",
    "说明": "座位号，从 0 开始"
  },
  {
    "参数名": "headimg",
    "类型": "string",
    "说明": "头像 URL（用户授权才会返回）"
  },
  {
    "参数名": "nickname",
    "类型": "string",
    "说明": "用户昵称（用户授权才会返回）"
  },
  {
    "参数名": "client_id",
    "类型": "number",
    "说明": "用户在房间内的唯一标识"
  },
  {
    "参数名": "enable_to_start",
    "类型": "boolean",
    "说明": "是否已做好游戏开始准备"
  },
  {
    "参数名": "member_ext_info",
    "类型": "string",
    "说明": "给第三方用的 buffer，最长 32 个字节"
  }
]
```

## 4. 注意事项

本接口无特殊注意事项

## 5. 代码示例

本接口无代码示例

## 6. 错误码

以下是本接口的错误码列表，其他错误码可参考 [通用错误码](/doc/oplatform/developers/errCode/README.md)；调用接口遇到报错，可使用官方提供的 [API 诊断工具](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_errcode) 辅助定位和分析问题。

```json
[
  {
    "错误码": "-1",
    "错误描述": "系统繁忙，此时请开发者稍候再试"
  },
  {
    "错误码": "0",
    "错误描述": "请求成功"
  }
]
```

## 7. 适用范围

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