https://github.com/abzico/wxbotserv

WeChat bot for normal user account that runs on server-side. Yes, server-side.
https://github.com/abzico/wxbotserv

bot china javascript js node nodejs serv server wechat wechat-bot wx

Last synced: about 9 hours ago
JSON representation

WeChat bot for normal user account that runs on server-side. Yes, server-side.

• Host: GitHub
• URL: https://github.com/abzico/wxbotserv
• Owner: abzico
• License: mit
• Created: 2017-11-15T13:12:42.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2017-11-26T16:12:16.000Z (about 7 years ago)
• Last Synced: 2024-04-28T03:18:53.583Z (9 months ago)
• Topics: bot, china, javascript, js, node, nodejs, serv, server, wechat, wechat-bot, wx
• Language: JavaScript
• Size: 74.2 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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=`

	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

```javascript

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

```javascript

{

	processMsgDelay: , // delay between each processing message

	debugLog:  // whether or not to print out debugging log to console

}

```

as follows

```javascript

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

wxbotserv(function(msgObj) {

	// ...

}, options);

```

# Project Status

- [x] notify QR Code image to Slack channel

- [ ] notify QR Code image to WeChat Official / Subscription account that has permission to send template message

- [x] support plain text message as response back from bot

- [ ] support more type of message (image, etc) as response back from bot 

- [x] 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)

- [x] listen to new unmuted message

- [x] listen to new muted messages

# License

[MIT](https://github.com/haxpor/wxbotserv/blob/master/LICENSE), Wasin Thonkaew, [abzi.co](https://abzi.co)