企业内部开发 客户端API JS-SDK 基础接口 wx.agentConfig
wx.agentConfig
最后更新:2022/09/15
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
wx.agentConfig
最后更新:2022/09/15

通过agentConfig注入应用的权限

调用 wx.agentConfig需要引入 jwxwork sdk

<script src="https://open.work.weixin.qq.com/wwopen/js/jwxwork-1.0.0.js"></script>
wx.agentConfig({
    corpid: '', // 必填,企业微信的corpid,必须与当前登录的企业一致
    agentid: '', // 必填,企业微信的应用id (e.g. 1000247)
    timestamp: , // 必填,生成签名的时间戳
    nonceStr: '', // 必填,生成签名的随机串
    signature: '',// 必填,签名,见附录-JS-SDK使用权限签名算法
    jsApiList: ['selectExternalContact'], //必填,传入需要使用的接口名称
	success: function(res) {
        // 回调
    },
    fail: function(res) {
        if(res.errMsg.indexOf('function not exist') > -1){
            alert('版本过低请升级')
        }
    }
});

生成签名算法详见:附录-JS-SDK使用权限签名算法

注意,参数agentid为企业微信的应用id

agentConfig的作用
config注入的是企业的身份与权限,而agentConfig注入的是应用的身份与权限。尤其是当调用者为第三方服务商时,通过config无法准确区分出调用者是哪个第三方应用,而在部分场景下,又必须严谨区分出第三方应用的身份,此时即需要通过agentConfig来注入应用的身份信息。

调用agentConfig的注意事项

  1. agentConfig与config的签名算法完全一样,但是jsapi_ticket的获取方法不一样,请特别注意,查看"获取应用身份的ticket".
  2. 企业微信3.0.24以前的老版本(可通过企业微信UA判断版本号),在调用wx.agentConfig之前,必须确保先成功调用wx.config
  3. 当前页面url中的域名必须是在该应用中设置的可信域名。
  4. agentConfig仅在企业微信2.5.0及以后版本支持,微信客户端不支持(微信开发者工具也不支持)
  5. 仅部分接口才需要调用agentConfig,需注意每个接口的说明
  6. 企业微信ios/mac 端如果出现 "wx.agentConfig undefined" 的报错,可将调用放在异步操作中进行,例如使用:setTimeout 包裹
上一篇
wx.checkJsApi
下一篇
获取进入H5页面的入口环境