co-wechat NPM version Build Status Dependencies Status Coverage Status

升级注意事项

支持 Koa2

middleware 方法变更

app.use(wechat(config).middleware(async (message, ctx) => {
 // TODO
}));

上下文与返回值变更

async (message, ctx) => {
 return 'Hello world!';
}

取消 session 的支持

功能列表

Installation

$ npm install co-wechat

Use with koa2

const wechat = require('co-wechat');
const config = {
 token: 'THE TOKEN',
 appid: 'THE APPID',
 encodingAESKey: 'THE ENCODING AES KEY'
};
app.use(wechat(config).middleware(async (message, ctx) => {
 // 微信输入信息就是这个 message
 if (message.FromUserName === 'diaosi') {
 // 回复屌丝(普通回复)
 return 'hehe';
 } else if (message.FromUserName === 'text') {
 //你也可以这样回复text类型的信息
 return {
 content: 'text object',
 type: 'text'
 };
 } else if (message.FromUserName === 'hehe') {
 // 回复一段音乐
 return {
 type: "music",
 content: {
 title: "来段音乐吧",
 description: "一无所有",
 musicUrl: "http://mp3.com/xx.mp3",
 hqMusicUrl: "http://mp3.com/xx.mp3"
 }
 };
 } else if (message.FromUserName === 'kf') {
 // 转发到客服接口
 return {
 type: "customerService",
 kfAccount: "test1@test"
 };
 } else {
 // 回复高富帅(图文回复)
 return [
 {
 title: '你来我家接我吧',
 description: '这是女神与高富帅之间的对话',
 picurl: 'http://nodeapi.cloudfoundry.com/qrcode.jpg',
 url: 'http://nodeapi.cloudfoundry.com/'
 }
 ];
 }
}));

开启调试模式(用于微信公众平台接口调试工具调试)

//构造函数的第二个函数isDebug参数,为true或别的正值时表示开启,推荐用配置或是环境变量的方式传参
wechat(config, true)

回复消息

回复文本

async (message, ctx) => {
 return 'Hello world!';
}
// 或者
async (message, ctx) => {
 return {type: "text", content: 'Hello world!'};
}

回复图片

async (message, ctx) => {
 return {
 type: "image",
 content: {
 mediaId: 'mediaId'
 }
 };
}

回复语音

async (message, ctx) => {
 return {
 type: "voice",
 content: {
 mediaId: 'mediaId'
 }
 };
}

回复视频

async (message, ctx) => {
 return {
 type: "video",
 content: {
 mediaId: 'mediaId',
 thumbMediaId: 'thumbMediaId'
 }
 };
}

回复音乐

async (message, ctx) => {
 return {
 title: "来段音乐吧",
 description: "一无所有",
 musicUrl: "http://mp3.com/xx.mp3",
 hqMusicUrl: "http://mp3.com/xx.mp3"
 };
}

回复图文

async (message, ctx) => {
 return [
 {
 title: '你来我家接我吧',
 description: '这是女神与高富帅之间的对话',
 picurl: 'http://nodeapi.cloudfoundry.com/qrcode.jpg',
 url: 'http://nodeapi.cloudfoundry.com/'
 }
 ];
}

回复空串

async (message, ctx) => {
 return '';
}

转发到客服接口

async (message, ctx) => {
 return {
 type: "customerService",
 kfAccount: "test1@test" //可选
 };
}

集成到 Egg.js

// app/router.js
'use strict';
module.exports = app => {
 // 将 get/post 请求都转给 home.wechat
 app.all('/', 'home.wechat');
};

'use strict';
const wechat = require('co-wechat');
module.exports = app => {
 class HomeController extends app.Controller {}
 // 因为 Egg 需要用类的形式来组织,而 wechat 是通过 middleware 方法来生成中间件
 HomeController.prototype.wechat = wechat({
 token: 'token',
 appid: 'appid',
 encodingAESKey: ''
 }).middleware(async (message, ctx) => {
 // TODO
 });
 return HomeController;
};

相同路由支持多账号

// app/router.js
'use strict';
module.exports = app => {
 // 将 get/post 请求都转给 home.wechat
 app.all('/wechat/:appid', 'home.prehandle', 'home.wechat');
};

'use strict';
const WXBizMsgCrypt = require('wechat-crypto');
const wechat = require('co-wechat');
module.exports = app => {
 class HomeController extends app.Controller {
 async prehandle(ctx, next) {
 const appid = ctx.params.appid;
 const token = getTokenByAppid(appid);
 ctx.wx_token = token
 // 或者
 const encodingAESKey = getEncodingAESKeyByAppid(appid);
 ctx.wx_cryptor = new WXBizMsgCrypt(token, encodingAESKey, appid);
 await next();
 }
 }
 HomeController.prototype.wechat = wechat({
 // 当有前置中间件设置 ctx.wx_token 和 ctx.wx_cryptor 时,这里配置随意填写
 // token: 'token',
 // appid: 'appid',
 // encodingAESKey: ''
 }).middleware(async (message, ctx) => {
 // TODO
 });
 return HomeController;
};

Show cases

Node.js API 自动回复

详细API

交流群

捐赠

License

Contributors

 project : co-wechat
 repo age : 3 years, 1 month
 active : 21 days
 commits : 59
 files : 10
 authors :
 46 Jackson Tian 78.0%
 6 ifeiteng 10.2%
 3 lixiaojun 5.1%
 2 Andrew Lyu 3.4%
 1 Jealee3000 1.7%
 1 fancyoung 1.7%