在企业内部通讯中,微信企业号被广泛使用。而企业号作为一个平台,除了基本的通信功能,还提供了很多扩展功能,比如菜单、客服、消息推送、钉钉组织架构管理等等。但是,这些功能的开发需要调用微信企业号开发者平台提供的接口,比较繁琐。今天,我们来介绍一款简化微信企业号接口调用的 npm 包——wechat-work-js-sdk。
安装 wechat-work-js-sdk
我们可以使用 npm install 命令来安装 wechat-work-js-sdk:
npm install wechat-work-js-sdk --save
注意:在使用这个 npm 包之前,需要先在微信企业号开发者平台中注册企业应用,并获取对应的 AgentId、CorpId、Secret 等信息,具体的注册流程参见微信企业号开发者中心。
使用 wechat-work-js-sdk
初始化
在使用 wechat-work-js-sdk 之前,需要先初始化 SDK,具体的代码如下所示:
var WwjsSdk = require('wechat-work-js-sdk'); var wwjsSdk = new WwjsSdk({ agentid: agentid, corpid: corpid, secret: secret });
参数说明:
- agentid:应用的 ID。
- corpid:企业 ID。
- secret:应用的 secret。
调用方法
wechat-work-js-sdk 提供了很多方法,我们在这里以获取部门列表为例,来介绍如何调用方法。具体的代码如下所示:
wwjsSdk.api.department.list(function (err, data, res) { if (err) { console.error(err); } else { console.log(data.department); } });
其中,api.department.list
方法是获取部门列表的函数。
Promise 版本
如果你喜欢使用 Promise,wechat-work-js-sdk 也提供了 Promise 版本的方法。具体的代码如下所示:
wwjsSdk.api.department.listAsync().then(function (data) { console.log(data.department); }).catch(function (err) { console.error(err); });
其中,api.department.listAsync()
方法是获取部门列表的 Promise 版本。
示例代码
下面我们来完成一个简单的任务——获取用户列表,并输出其 UserId 和 Name。具体的代码如下所示:
-- -------------------- ---- ------- --- ------- - ------------------------------ --- ------- - ------ ----- --- --- ------ - ------ -- -- --- --- ------ - ------ -- --- ------- --- ------- - --- --------- -------- -------- ------- ------- ------- ------ --- ------------------------------ ----- ----- ---- - -- ----- - ------------------- - ---- - --- ---- - - -- - - --------------------- ---- - --------------------------------- - - - - - ------------------------- - - ---
这里我们使用了 api.user.list
方法来获取用户列表,并在控制台输出每个用户的 Name 和 UserId。
总结
wechat-work-js-sdk 是一款简化微信企业号接口调用的 npm 包,可以极大地简化企业号应用的开发工作。我们在实际工作中也可以使用该 npm 包,提高工作效率,减少出错概率。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6006710a8dd3466f61ffe044