# 获取半屏小程序调用列表
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:getEmbeddedList
- 调用本接口可以获取半屏小程序调用列表,使用过程中如遇到问题,可在开放平台服务商专区发帖交流。
- 说明,通过addEmbedded接口添加半屏小程序后,可通过当前接口获取半屏小程序调用列表。
# 1. 调用方式
# HTTPS 调用
GET https://api.weixin.qq.com/wxaapi/wxaembedded/get_list?access_token=ACCESS_TOKEN
# 云调用
- 本接口不支持云调用
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:18
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| start | number | 否 | query参数,分页起始值 ,默认值为0 |
| num | number | 否 | query参数,一次拉取最大值,最大 1000,默认值为10 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| wxa_embedded_list | objarray | 半屏小程序列表 |
| embedded_flag | number | 授权方式。0表示需要管理员确认,1表示自动通过,2表示自动拒绝 |
# Res.wxa_embedded_list(Array) Object Payload
半屏小程序列表
| 参数名 | 类型 | 说明 |
|---|---|---|
| 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
返回示例
{
"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. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| 40001 | invalid credential access_token isinvalid or not latest | access_token 无效或不为最新获取的 access_token,请开发者确认access_token的有效性 |
| 89408 | 半屏小程序系统错误 | |
| 89409 | 获取半屏小程序列表参数错误 |
# 7. 适用范围
本接口支持「第三方平台」账号类型代调用,权限集请参考「调用方式」部分。其他账号类型如无特殊说明,均不可调用。