微信小程序 getPluginList

2022-05-11 14:55 更新

pluginManager.getPluginList

本接口应在服务器端调用,详细说明参见服务端API
本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载
wx-server-sdk >= 0.4.0

查询已添加的插件

调用方式:

  • HTTPS 调用
  • 云调用

HTTPS 调用

请求地址

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errcode number 错误码
errmsg string 错误信息
plugin_list Array.<Object> 申请或使用中的插件列表

plugin_list 的结构

属性 类型 说明
appid string 插件 appId
status number 插件状态
nickname string 插件昵称
headimgurl string 插件头像

status 的合法值

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

错误

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

请求数据示例

{
  "action":"list"
}

返回数据示例

{
  "errcode": 0,
  "errmsg": "ok",
  "plugin_list": [{
    "appid": "aaaa",
    "status": 1,
    "nickname": "插件昵称",
    "headimgurl": "http://plugin.qq.com"
  }]
}

云调用

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

接口方法

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

请求参数

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

返回值

Object

返回的 JSON 数据包

属性 类型 说明
errCode number 错误码
errMsg string 错误信息
pluginList Array.<Object> 申请或使用中的插件列表

pluginList 的结构

属性 类型 说明
appid string 插件 appId
status number 插件状态
nickname string 插件昵称
headimgurl string 插件头像

status 的合法值

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

异常

Object

抛出的异常

属性 类型 说明
errCode number 错误码
errMsg string 错误信息

errCode 的合法值

说明 最低版本

错误

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

请求数据示例

const cloud = require('wx-server-sdk')
cloud.init()
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.pluginManager.getPluginList({
        action: 'list'
      })
    return result
  } catch (err) {
    return err
  }
}

返回数据示例

{
  "errCode": 0,
  "errMsg": "openapi.pluginManager.getPluginList:ok",
  "pluginList": [
    {
      "appid": "aaaa",
      "status": 1,
      "nickname": "插件昵称",
      "headimgurl": "http://plugin.qq.com"
    }
  ]
}


以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号