wechat-api
Version:
微信公共平台Node库 API
125 lines (98 loc) • 4.15 kB
Markdown
Wechat API
===========
微信公共平台API。
## 模块状态
- [](http://badge.fury.io/js/wechat)
- [](https://travis-ci.org/node-webot/wechat-api)
- [](https://david-dm.org/node-webot/wechat-api)
- [](https://coveralls.io/r/node-webot/wechat-api)
## 功能列表
- 发送客服消息（文本、图片、语音、视频、音乐、图文）
- 菜单操作（查询、创建、删除）
- 二维码（创建临时、永久二维码，查看二维码URL）
- 分组操作（查询、创建、修改、移动用户到分组）
- 用户信息（查询用户基本信息、获取关注者列表）
- 媒体文件（上传、获取）
- 群发消息（文本、图片、语音、视频、图文）
- 客服记录（查询客服记录，查看客服、查看在线客服）
- 群发消息
- 公众号支付（发货通知、订单查询）
- 微信小店（商品管理、库存管理、邮费模板管理、分组管理、货架管理、订单管理、功能接口）
- 模版消息
- 网址缩短
- 语义查询
- 数据分析
- JSSDK服务端支持
详细参见[API文档](http://doxmate.cool/node-webot/wechat-api/api.html)
企业版本请前往：<https://github.com/node-webot/wechat-enterprise>
## Installation
```sh
$ npm install wechat-api
```
## Usage
```js
var WechatAPI = require('wechat-api');
var api = new WechatAPI(appid, appsecret, );
api.updateRemark('open_id', 'remarked', function (err, data, res) {
// TODO
});
```
### 多进程
当多进程时，token需要全局维护，以下为保存token的接口。
```
var api = new API('appid', 'secret', function (callback) {
// 传入一个获取全局token的方法
fs.readFile('access_token.txt', 'utf8', function (err, txt) {
if (err) {return callback(err);}
callback(null, JSON.parse(txt));
});
}, function (token, callback) {
// 请将token存储到全局，跨进程、跨机器级别的全局，比如写到数据库、redis等
// 这样才能在cluster模式及多机情况下使用，以下为写入到文件的示例
fs.writeFile('access_token.txt', JSON.stringify(token), callback);
});
```
## Show cases
### Node.js API自动回复
欢迎关注。
代码：<https://github.com/JacksonTian/api-doc-service>
你可以在[CloudFoundry](http://www.cloudfoundry.com/)、[appfog](https://www.appfog.com/)、[BAE](http://developer.baidu.com/wiki/index.php?title=docs/cplat/rt/node.js)等搭建自己的机器人。
## 详细API
原始API文档请参见：[消息接口指南](http://mp.weixin.qq.com/wiki/index.php?title=消息接口指南)。
## License
The MIT license.
## 交流群
QQ群：157964097，使用疑问，开发，贡献代码请加群。
## 感谢
感谢以下贡献者：
```
project : wechat
repo age : 1 year, 8 months
active : 106 days
commits : 244
files : 60
authors :
206 Jackson Tian 84.4%
10 yelo 4.1%
4 realdog 1.6%
4 Bruce Lee 1.6%
3 Guo Yu 1.2%
2 zhongao 0.8%
2 Jesse Yang 0.8%
2 Lu Jun 0.8%
2 dan 0.8%
1 TooBug 0.4%
1 feichang.wyl 0.4%
1 feit 0.4%
1 ifeiteng 0.4%
1 p13766 0.4%
1 Rogerz Zhang 0.4%
1 xianda 0.4%
1 Lance Li 0.4%
1 Chen Wei 0.4%
```
## 捐赠
如果您觉得Wechat对您有帮助，欢迎请作者一杯咖啡
或者[](https://www.gittip.com/JacksonTian/)