Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/node-webot/co-wechat-api
Wechat API. Support Async Functions
https://github.com/node-webot/co-wechat-api
Last synced: about 2 months ago
JSON representation
Wechat API. Support Async Functions
- Host: GitHub
- URL: https://github.com/node-webot/co-wechat-api
- Owner: node-webot
- License: other
- Created: 2014-11-06T08:52:34.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2022-08-01T08:20:53.000Z (about 2 years ago)
- Last Synced: 2024-04-26T22:43:47.822Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 2.74 MB
- Stars: 723
- Watchers: 28
- Forks: 170
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: MIT-License
Awesome Lists containing this project
- awesome-interview - Wechat API(ES6 版)
README
Wechat API(ES6版)
===========
微信公共平台API。
## 模块状态
- [](http://badge.fury.io/js/co-wechat-api)
- [](https://travis-ci.org/node-webot/co-wechat-api)
- [](https://david-dm.org/node-webot/co-wechat-api)
- [](https://coveralls.io/r/node-webot/co-wechat-api)
## 功能列表
- 发送客服消息（文本、图片、语音、视频、音乐、图文、小程序卡片）
- 菜单操作（查询、创建、删除、个性化菜单）
- 二维码（创建临时、永久二维码，查看二维码URL）
- 分组操作（查询、创建、修改、移动用户到分组）
- 用户信息（查询用户基本信息、获取关注者列表）
- 媒体文件（上传、获取）
- 群发消息（文本、图片、语音、视频、图文）
- 客服记录（查询客服记录，查看客服、查看在线客服）
- 群发消息
- 公众号支付（发货通知、订单查询）
- 微信小店（商品管理、库存管理、邮费模板管理、分组管理、货架管理、订单管理、功能接口）
- 模版消息
- 网址缩短
- 语义查询
- 数据分析
- JSSDK服务端支持
- 素材管理
- 摇一摇周边
- 小程序订阅消息（暂仅支持发送）
详细参见[API文档](http://doxmate.cool/node-webot/co-wechat-api/api.html)
企业版本请前往：
## Installation
```sh
$ npm install co-wechat-api
```
## Usage
```js
var WechatAPI = require('co-wechat-api');
async function() {
var api = new WechatAPI(appid, appsecret);
var result = await api.updateRemark('open_id', 'remarked');
}
```
### 多进程
当多进程时，token需要全局维护，以下为保存token的接口：
```js
var api = new API('appid', 'secret', async function () {
// 传入一个获取全局token的方法
var txt = await fs.readFile('access_token.txt', 'utf8');
return JSON.parse(txt);
}, async function (token) {
// 请将token存储到全局，跨进程、跨机器级别的全局，比如写到数据库、redis等
// 这样才能在cluster模式及多机情况下使用，以下为写入到文件的示例
await fs.writeFile('access_token.txt', JSON.stringify(token));
});
```
## Show cases
### Node.js API自动回复
欢迎关注。
代码：
你可以在[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 : co-wechat-api
repo age : 2 years, 6 months
active : 37 days
commits : 109
files : 50
authors :
75 Jackson Tian 68.8%
7 肥鼠 6.4%
6 magicxie 5.5%
3 马剑 2.8%
2 TimZhang 1.8%
2 Ziyi Yan 1.8%
2 ken 1.8%
2 Lei 1.8%
2 pillarhou 1.8%
2 sunwf 1.8%
1 Jichao Wu 0.9%
1 HelloYou 0.9%
1 swfbarhr 0.9%
1 ladjzero 0.9%
1 三点 0.9%
1 mukaiu 0.9%
```
## 捐赠
如果您觉得Wechat对您有帮助，欢迎请作者一杯咖啡
