messaging-api-wechat

> Messaging API client for WeChat

Table of Contents

- Installation
- Usage
- API Reference
- Send API
- Medai API
- Debug Tips
- Testing

Installation

``sh
npm i --save messaging-api-wechat
`

or

`sh
yarn add messaging-api-wechat
`

Usage

$3

`js
const { WechatClient } = require('messaging-api-wechat');

// get appId, appSecret from「微信公众平台-开发-基本配置」page
const client = new WechatClient({
appId: APP_ID,
appSecret: APP_SECRET,
});
`

$3

messaging-api-wechat uses axios as HTTP client. We use axios-error package to wrap API error instances for better formatting error messages. Directly calling console.log with the error instance will return formatted message. If you'd like to get the axios request, response, or config, you can still get them via those keys on the error instance.

`js
client.sendText(userId, text).catch((error) => {
console.log(error); // formatted error message
console.log(error.stack); // error stack trace
console.log(error.config); // axios request config
console.log(error.request); // HTTP request
console.log(error.response); // HTTP response
});
`

API Reference

All methods return a Promise.

$3

- sendText
- sendImage
- sendVoice
- sendVideo
- sendMusic
- sendNews
- sendMPNews
- sendWXCard
- sendMiniProgramPage

$3

- uploadMedia
- getMedia

Debug Tips

$3

To enable default request debugger, use following DEBUG env variable:

`sh
DEBUG=messaging-api:request
`

If you want to use a custom request logging function, just provide your own onRequest:

`js
const client = new WechatClient({
appId: APP_ID,
appSecret: APP_SECRET,
onRequest: ({ method, url, headers, body }) => {
/ /
},
});
`

Testing

$3

To avoid sending requests to real WeChat server, specify the origin option when constructing your client:

`js
const { WechatClient } = require('messaging-api-wechat');

const client = new WechatClient({
appId: APP_ID,
appSecret: APP_SECRET,
origin: 'https://mydummytestserver.com',
});
``

> Warning: Don't do this on your production server.