# 查询license资源包列表

[调试诊断](https://developers.weixin.qq.com/console/devtools/debug?utm_source=api_tools)

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

接口英文名：getLicensePkgList

查询小程序已购买的 license 资源包列表信息。

## 1. 调用方式

### HTTPS 调用

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

### 云调用

- 本接口不支持云调用。

### 第三方调用

- 本接口支持第三方平台代商家调用。

- 该接口所属的权限集 id 为：118

- 服务商获得其中之一权限集授权后，可通过使用 [authorizer_access_token](/doc/oplatform/developers/dev/AuthorizerAccessToken.md) 代商家进行调用，具体可查看 [第三方调用](/doc/oplatform/Third-party_Platforms/2.0/Before_Develop/call_interface.md) 说明文档。

## 2. 请求参数

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

```json
[
  {
    "参数名": "access_token",
    "类型": "string",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [access_token](/miniprogram/dev/server/API/mp-access-token/api_getaccesstoken)、[authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken.md)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "pkg_type",
    "类型": "number",
    "必填": "是",
    "说明": "资源包类型，0：测试体验包，1：A 类设备，2：B 类设备，3：C 类设备，4：D 类设备，5：E类设备"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "pkg_list",
    "类型": "objarray",
    "说明": "资源包列表"
  },
  {
    "参数名": "max_active_number",
    "类型": "number",
    "说明": "最大激活码序号，已废弃。"
  }
]
```

">

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

资源包列表

```json
[
  {
    "参数名": "pkg_id",
    "类型": "string",
    "说明": "资源包 ID"
  },
  {
    "参数名": "pkg_type",
    "类型": "number",
    "说明": "资源包类型"
  },
  {
    "参数名": "start_time",
    "类型": "number",
    "说明": "资源包下单时间"
  },
  {
    "参数名": "end_time",
    "类型": "number",
    "说明": "资源包过期时间"
  },
  {
    "参数名": "pkg_status",
    "类型": "number",
    "说明": "资源包状态，1为已生效，2为未生效，3为已过期"
  },
  {
    "参数名": "used",
    "类型": "number",
    "说明": "已使用额度"
  },
  {
    "参数名": "all",
    "类型": "number",
    "说明": "资源包总量"
  }
]
```

## 4. 注意事项

开发者需要先在小程序管理后台购买设备 license 的套餐包后，方可查询到对应的资源包。

本接口将于2024年12月31日正式回收，请开发者及时进行调整适配。

详见[调整公告](https://developers.weixin.qq.com/community/minihome/doc/000428b5bd4d10c54812f7cd466401)

## 5. 代码示例

请求示例

```json
{
  "pkg_type": 0
}
```

返回示例

```json
{
  "errcode": 0,
  "errmsg": "success",
  "pkg_list": [
    {
      "pkg_id": "ZY100000000",
      "pkg_type": 1,
      "start_time": 1629907200,
      "end_time": 1630425600,
      "pkg_status": 1,
      "used": 10,
      "all": 100
    },
    {
      "pkg_id": "ZY100000001",
      "pkg_type": 2,
      "start_time": 1629907200,
      "end_time": 1630425600,
      "pkg_status": 1,
      "used": 20,
      "all": 200
    }
  ],
  "max_active_number": 300
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "0",
    "错误描述": "ok",
    "解决方案": "ok"
  }
]
```

## 7. 适用范围

本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请以实际调用情况为准。