pluginManager.getPluginList

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

查询已添加的插件

调用方式:

HTTPS 调用

请求地址

  1. POST https://api.weixin.qq.com/wxa/plugin?access_token=TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
actionstring此接口下填写 "list"

返回值

Object

返回的 JSON 数据包

属性类型说明
errcodenumber错误码
errmsgstring错误信息
plugin_listArray.<Object>申请或使用中的插件列表

plugin_list 的结构

属性类型说明
appidstring插件 appId
statusnumber插件状态
nicknamestring插件昵称
headimgurlstring插件头像

status 的合法值

说明最低版本
1申请中
2申请通过
3已拒绝
4已超时

错误

错误码错误信息说明
0ok正常
-1系统错误
89236该插件不能申请
89237已经添加该插件
89238申请或使用的插件已经达到上限
89239该插件不存在
89240无法进行此操作,只有“待确认”的申请可操作通过/拒绝
89241无法进行此操作,只有“已拒绝/已超时”的申请可操作删除
89242该appid不在申请列表内
89243“待确认”的申请不可删除
89044不存在该插件appid

请求数据示例

  1. {
  2. "action":"list"
  3. }

返回数据示例

  1. {
  2. "errcode": 0,
  3. "errmsg": "ok",
  4. "plugin_list": [{
  5. "appid": "aaaa",
  6. "status": 1,
  7. "nickname": "插件昵称",
  8. "headimgurl": "http://plugin.qq.com"
  9. }]
  10. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.pluginManager.getPluginList

需在 config.json 中配置 pluginManager.getPluginList API 的权限,详情

请求参数

属性类型默认值必填说明
actionstring此接口下填写 "list"

返回值

Object

返回的 JSON 数据包

属性类型说明
errCodenumber错误码
errMsgstring错误信息
pluginListArray.<Object>申请或使用中的插件列表

pluginList 的结构

属性类型说明
appidstring插件 appId
statusnumber插件状态
nicknamestring插件昵称
headimgurlstring插件头像

status 的合法值

说明最低版本
1申请中
2申请通过
3已拒绝
4已超时

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本

错误

错误码错误信息说明
0ok正常
-1系统错误
89236该插件不能申请
89237已经添加该插件
89238申请或使用的插件已经达到上限
89239该插件不存在
89240无法进行此操作,只有“待确认”的申请可操作通过/拒绝
89241无法进行此操作,只有“已拒绝/已超时”的申请可操作删除
89242该appid不在申请列表内
89243“待确认”的申请不可删除
89044不存在该插件appid

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4. try {
  5. const result = await cloud.openapi.pluginManager.getPluginList({
  6. action: 'list'
  7. })
  8. console.log(result)
  9. return result
  10. } catch (err) {
  11. console.log(err)
  12. return err
  13. }
  14. }

返回数据示例

  1. {
  2. "errCode": 0,
  3. "errMsg": "openapi.pluginManager.getPluginList:ok",
  4. "pluginList": [
  5. {
  6. "appid": "aaaa",
  7. "status": 1,
  8. "nickname": "插件昵称",
  9. "headimgurl": "http://plugin.qq.com"
  10. }
  11. ]
  12. }