Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/node-webot/wechat-mp
Utilities for wechat media platform API.
https://github.com/node-webot/wechat-mp
Last synced: 5 days ago
JSON representation
Utilities for wechat media platform API.
- Host: GitHub
- URL: https://github.com/node-webot/wechat-mp
- Owner: node-webot
- Created: 2013-04-20T03:13:40.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2016-04-13T10:38:51.000Z (over 8 years ago)
- Last Synced: 2024-10-30T07:46:13.514Z (15 days ago)
- Language: JavaScript
- Size: 43.9 KB
- Stars: 67
- Watchers: 9
- Forks: 27
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# wechat-mp 微信公众平台消息接口中间件 [](https://travis-ci.org/node-webot/wechat-mp)
Utilities for wechat offical account messaging API.
校验签名，接受并解析微信消息，处理回复内容为 XML ，并回复给微信。
如需使用自定义菜单等高级接口，可使用 [wechat-api](https://www.npmjs.org/package/wechat-api) 模块。
## Express Middlewares
本模块主要作为 Connect/Express 框架的中间件使用：
```javascript
var mp = require('wechat-mp')(process.env.WX_TOKEN)
var app = require('express')()
app.use('/wechat', mp.start())
app.post('/wechat', function(req, res, next) {
console.log(req.body)
res.body = {
msgType: 'text',
content: 'Hi.'
}
// or rich media message
res.body = {
msgType: 'music',
content: {
title: 'A beautiful song',
musicUrl: 'http://.....'
},
}
next()
}, mp.end())
```
如果要在 [koa](http://koajs.com/) 里使用，可尝试 [koa-wechat](https://www.npmjs.org/package/koa-wechat) 模块。
### require('wechat-mp')( *[options]* )
`options` can be either the token string or an object.
You can use these options both when initialization(`mp = require('wechat-mp')(options)`)
and `mp.start()`.
#### options.token
The token for wechat to check signature.
#### options.tokenProp
Default: 'wx\_token'
Will try get `req[tokenProp]` as token. Good for dynamically set token.
#### options.dataProp
Default: 'body'
Will put parsed data on `req[dataProp]`. So you can access wechat request message via `req.body` or `req.wx_data`, etc.
##### Parsed data properties mapping
We changed some of the properties' names of Wechat's incoming message, to make it more "JavaScript like",
typically, a request datum would be:
```js
{
uid: 'xahfai2oHaf2ka2M41', // FromUserName
sp: 'gh_xmfh2b32tmgkgagsagf', // ToUserName
type: '', // MsgType
createTime: new Date(2014-12..) // CreateTime
text: 'Hi.', // when it's a text message
param: {
lat: '34.193819105', // for a "LOCATION" message's Location_X
lng: '120.2393849201', // Location_Y
}
}
```
For more details, please refer to `lib/xml.js`.
#### options.session
Unless `options.session` is set to `false`,
the `mp.start()` middleware will set `req.sessionID` and `req.sessionId`
to `"wx.#{toUserName}.#{fromUserName}"`.
So you can use `req.session` to save information about one specific user.
The `sessionId` cannot be changed by any other following middlewares.
To make this work, `mp.start()` must go before express/connect's session middleware.
```
app.use('/wechat', mp.start())
app.use(connect.cookieParser())
app.use(connect.session({ store: ... }))
```
### mp.start()
The starting middleware, to parse a Wechat message request, and set `req.body` as a JS object.
### mp.end()
The ending middleware, to response a xml based on `res.body`.
For how to set `res.body` for multi media messages, see source code `lib/xml.js`.
If your set `res.body` to a string, will reply a text message. When `res.body` is an object,
a `res.body.msgType` is expected, otherwise it will be treated as text message,
and `res.body.content` will be replied as it was a string.
A typical response:
```js
{
msgType: 'news',
content: [{
title: 'news 1',
url: 'http://...',
picUrl: 'http://...'
}, {
title: 'news 2',
url: 'http://...',
picUrl: 'http://...'
}]
}
```
## weixin-robot
使用 [wexin-robot](https://github.com/node-webot/weixin-robot) 模块，更傻瓜化地定义自动回复功能。
## 调试
使用 [webot-cli](https://github.com/node-webot/webot-cli) 调试发送测试消息。
## License
the MIT license.