0.5.1 • Published 6 years ago

wxbotserv v0.5.1

Weekly downloads
4
License
MIT
Repository
github
Last release
6 years ago

wxbotserv

An automated Wechat bot to reply message for normal user account that run on server-side. Yes, you heard it right, on server-side.

How-To

Environment variables

Use environment variables to customize how the bot will work.

  • SLACK_WEBHOOK_URL=<your slack webhook url>

    	Bot will send QRCode image to Slack. Then you can use WeChat to scan in order to log in immediately. Please note that you cannot send image to WeChat and extract QRCode from there. __It needs actual scan.__

Start the Bot!

Install the bot via npm install wxbotserv (Required node version 6+).

Import the bot, and start it as follows

const wxbotserv = require('wxbotserv');
wxbotserv(function(msgObj) {
	if (msgObj.message === 'hello world') {
		return 'hello world to you too!';
	}
	else {
		return 'Please say hello world to me...';
	}
});

Or you could specify options object with following format

{
	processMsgDelay: <number>, // delay between each processing message
	debugLog: <boolean> // whether or not to print out debugging log to console
}

as follows

let options = { processMsgDelay: 150, debugLog: false };

wxbotserv(function(msgObj) {
	// ...
}, options);

Project Status

  • notify QR Code image to Slack channel
  • notify QR Code image to WeChat Official / Subscription account that has permission to send template message
  • support plain text message as response back from bot
  • support more type of message (image, etc) as response back from bot
  • list contacts especially to get WeChat user's ID and name
  • set to listen to new messages to only target users (so bot won't get rid of all your message notifications if not necessary)
  • listen to new unmuted message
  • listen to new muted messages

License

MIT, Wasin Thonkaew, abzi.co