# 插件管理
接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南
接口英文名:managePlugin
该接口用于管理插件,支持申请、查看、更新、删除插件等操作。
# 1. 调用方式
# HTTPS 调用
POST https://api.weixin.qq.com/wxa/plugin?access_token=ACCESS_TOKEN
支持加密请求: 本接口支持服务通信二次加密和签名,可有效防止数据篡改与泄露。查看详情
# 云调用
调用方法:pluginManager.applyPlugin
出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档
# 第三方调用
本接口支持第三方平台代商家调用。
该接口所属的权限集 id 为:40
服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。
# 2. 请求参数
# 查询参数 Query String parameters
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| access_token | string | 是 | 接口调用凭证,可使用 access_token、authorizer_access_token |
# 请求体 Request Payload
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| action | string | 是 | action可取值为"list"、"apply"、 "unbind"、"update",分别表示“查询已添加的插件列表”、“申请使用插件”、“删除已添加的插件”、“快速更新插件版本号” |
| plugin_appid | string | 是 | 插件的 appid |
| reason | string | 否 | 当action是"apply"时必填,申请原因 |
| user_version | string | 否 | 当action是"update"时使用。升级至版本号,要求此插件版本支持快速更新 |
# 3. 返回参数
# 返回体 Response Payload
| 参数名 | 类型 | 说明 |
|---|---|---|
| errcode | number | 错误码 |
| errmsg | string | 错误信息 |
| plugin_list | objarray | 申请或使用中的插件信息列表,当 action == 'list' 时返回 |
# Res.plugin_list(Array) Object Payload
申请或使用中的插件信息列表,当 action == 'list' 时返回
| 参数名 | 类型 | 说明 |
|---|---|---|
| appid | string | 插件 appId |
| status | number | 插件状态。1表示申请中;2表示申请通过;3表示被拒绝;4表示申请已超时 |
| nickname | string | 插件昵称 |
| headimgurl | string | 插件头像 |
# 4. 注意事项
本接口无特殊注意事项
# 5. 代码示例
# 5.1 申请插件示例
请求示例
{
"action": "apply",
"plugin_appid": "aaaa",
"reason": "hello"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 5.2 更新插件示例
请求示例
{
"action": "update",
"user_version": "2.2.46",
"plugin_appid": "wx5514af450eaceec2"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 5.3 获取插件列表示例
请求示例
{
"action": "list"
}
返回示例
{
"errcode": 0,
"errmsg": "ok",
"plugin_list": [
{
"appid": "aaaa",
"status": 1,
"nickname": "插件昵称",
"headimgurl": "http://plugin.qq.com"
}
]
}
# 5.4 删除已添加的插件
请求示例
{
"action": "unbind",
"plugin_appid": "aaaa"
}
返回示例
{
"errcode": 0,
"errmsg": "ok"
}
# 6. 错误码
以下是本接口的错误码列表,其他错误码可参考 通用错误码;调用接口遇到报错,可使用官方提供的 API 诊断工具 辅助定位和分析问题。
| 错误码 | 错误描述 | 解决方案 |
|---|---|---|
| -1 | system error | 系统繁忙,此时请开发者稍候再试 |
| 40001 | invalid credential access_token isinvalid or not latest | 获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口 |
| 80067 | 找不到使用的插件 |
# 7. 适用范围
本接口支持「小程序」账号类型调用。其他账号类型如无特殊说明,均不可调用。