# 获取半屏小程序调用列表

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

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

接口英文名：getEmbeddedList

调用本接口可以获取半屏小程序调用列表。补充说明，通过[addEmbedded接口](api_addembedded)添加半屏小程序后，可通过当前接口获取半屏小程序调用列表。

## 1. 调用方式

### HTTPS 调用

```bash
GET https://api.weixin.qq.com/wxaapi/wxaembedded/get_list?access_token=ACCESS_TOKEN
```

### 云调用

- 本接口不支持云调用。

### 第三方调用

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

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

- 服务商获得其中之一权限集授权后，可通过使用 [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",
    "必填": "是",
    "说明": "接口调用凭证，可使用 [authorizer_access_token](/doc/oplatform/openApi/ticket-token/api_getauthorizeraccesstoken)"
  }
]
```

### 请求体 `Request Payload`

```json
[
  {
    "参数名": "start",
    "类型": "number",
    "必填": "否",
    "说明": "query参数，分页起始值 ，默认值为0"
  },
  {
    "参数名": "num",
    "类型": "number",
    "必填": "否",
    "说明": "query参数，一次拉取最大值，最大 1000，默认值为10"
  }
]
```

## 3. 返回参数

### 返回体 `Response Payload`

```json
[
  {
    "参数名": "errcode",
    "类型": "number",
    "说明": "错误码"
  },
  {
    "参数名": "errmsg",
    "类型": "string",
    "说明": "错误信息"
  },
  {
    "参数名": "wxa_embedded_list",
    "类型": "objarray",
    "说明": "半屏小程序列表"
  },
  {
    "参数名": "embedded_flag",
    "类型": "number",
    "说明": "授权方式。0表示需要管理员确认，1表示自动通过，2表示自动拒绝"
  }
]
```

">

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

半屏小程序列表

```json
[
  {
    "参数名": "appid",
    "类型": "string",
    "说明": "半屏小程序appid"
  },
  {
    "参数名": "create_time",
    "类型": "number",
    "说明": "添加时间"
  },
  {
    "参数名": "headimg",
    "类型": "string",
    "说明": "头像url"
  },
  {
    "参数名": "nickname",
    "类型": "string",
    "说明": "半屏小程序昵称"
  },
  {
    "参数名": "reason",
    "类型": "string",
    "说明": "申请理由"
  },
  {
    "参数名": "status",
    "类型": "string",
    "说明": "申请状态"
  }
]
```

## 4. 注意事项

# 其他说明 

## 半屏小程序申请状态 status 的枚举值

| 值  | 说明       |
| --- | ---------- |
| 1   | 待验证     |
| 2   | 已通过     |
| 3   | 已拒绝     |
| 4   | 已超时     |
| 5   | 已撤销     |
| 6   | 已取消授权 |

## 5. 代码示例

请求示例

```
GET https://api.weixin.qq.com/wxaapi/wxaembedded/get_list?access_token=ACCESS_TOKEN&start=0&num=10
```

返回示例

```json
{
  "errmsg": "ok",
  "errcode": 0,
  "wxa_embedded_list": [
    {
      "appid": "wxf074afxxxxxxxx",
      "create_time": 1648177830,
      "headimg": "http://wx.qlogo.cn/mmhead/Q3axxxxxxxdRLA",
      "name": "testxxx6",
      "nickname": "tesxxx",
      "reason": "我是理由",
      "status": 1
    },
    {
      "appid": "wx355c73xxxxxxx",
      "create_time": 1647250557,
      "headimg": "http://wx.qlogo.cn/mmhead/QxxxxxxA",
      "name": "深圳市xx计算机系统有限公司",
      "nickname": "美味助手xx",
      "reason": "特殊",
      "status": 2
    }
  ]
}
```

## 6. 错误码

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

```json
[
  {
    "错误码": "40001",
    "错误描述": "invalid credential  access_token isinvalid or not latest",
    "解决方案": "access_token 无效或不为最新获取的 access_token，请开发者确认access_token的有效性"
  },
  {
    "错误码": "89408",
    "错误描述": "半屏小程序系统错误",
    "解决方案": "系统错误，请稍后重试"
  },
  {
    "错误码": "89409",
    "错误描述": "获取半屏小程序列表参数错误",
    "解决方案": "请检查分页的start和num是否合法"
  }
]
```

## 7. 适用范围

本接口支持「第三方平台」账号类型代调用，权限集请参考「调用方式」部分。其他账号类型如无特殊说明，均不可调用。