# 分片拉取对局游戏帧

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

接口英文名：lock-step.getGameFrame

本接口用于分片拉取对局游戏帧

## 1. 调用方式

### HTTPS 调用

```bash
POST https://api.weixin.qq.com/wxa/getwxagameframe?access_token=ACCESS_TOKEN
```

### 云调用

- 调用方法：lockstep.getGameFrame

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

### 第三方调用

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

## 2. 请求参数

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

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "示例": "ACCESS_TOKEN",
    "说明": "接口调用凭证，可使用 [access_token](/minigame/dev/api-backend/access-token/api_getaccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "access_token / cloudbase_access_token",
    "类型": "string",
    "必填": "是",
    "说明": "微信后台接口调用凭证"
  },
  {
    "参数名": "access_info",
    "类型": "string",
    "必填": "是",
    "说明": "填 onGameEnd 接口返回给开发者的 gameAccessInfo"
  },
  {
    "参数名": "begin_frame_id",
    "类型": "number",
    "必填": "是",
    "说明": "待获取帧的起始 frame_id"
  },
  {
    "参数名": "end_frame_id",
    "类型": "number",
    "必填": "是",
    "说明": "待获取帧的终止 frame_id，左闭右开区间"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

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

### Res.data `Object Payload`

房间/对局访问凭证数据

```json
[
  {
    "参数名": "has_more",
    "类型": "boolean",
    "说明": "是否还有更多帧可以获取"
  },
  {
    "参数名": "frame_list",
    "类型": "objarray",
    "说明": "游戏帧数据列表"
  }
]
```

">

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

游戏帧数据列表

```json
[
  {
    "参数名": "frame_id",
    "类型": "number",
    "说明": "帧编号，从 1 开始"
  },
  {
    "参数名": "pkg_list",
    "类型": "objarray",
    "说明": "指令包列表，每个指令包具体格式见下面"
  }
]
```

__pkg_list">

### Res.data.frame_list(Array).pkg_list `Object Payload`

指令包列表，每个指令包具体格式见下面

```json
[
  {
    "参数名": "open_id",
    "类型": "string",
    "说明": "该包发送者的 OpenId"
  },
  {
    "参数名": "action_list",
    "类型": "array",
    "说明": "第三方自定义游戏指令数组"
  },
  {
    "参数名": "b",
    "类型": "boolean",
    "说明": "true 代表是空帧"
  },
  {
    "参数名": "dp_id",
    "类型": "number",
    "说明": "微信内部使用，无需理解，为了更快速返回数据，没有去掉该字段内容"
  }
]
```

## 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",
    "错误描述": "请求成功"
  },
  {
    "错误码": "1",
    "错误描述": "数据不存在"
  },
  {
    "错误码": "5",
    "错误描述": "非法的请求数据"
  },
  {
    "错误码": "6000",
    "错误描述": "获取数据失败"
  }
]
```

## 7. 适用范围

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