# hwamei
## 推荐使用 [DinglingDingling](https://dinglingdingling.com/?utm_source=github_hwamei) 替代本项目,无需部署,简单配置即可打通企业微信群机器人与Github、Gitlab、Sentry、Jenkins 等工具 webhook。
hwamei 是一个基于 hubot 的企业微信聊天机器人,它能够通过 webhook 将收集的信息发送到企业微信群中。
已兼容企业微信原生webhook机器人!!! 具体见 https://github.com/tlikai/hwamei/pull/2
## 预览
![企业微信群聊天机器人](http://p.qpic.cn/pic_wework/439528718/dadcc3d69e2a69710cbb7ce270aab93f77fa86e5d64bf11c/0)
## 工作流程
![工作流程](./data/flow.png)
## 安装
- `git clone https://github.com/tlikai/hwamei.git`
- 运行 `npm install`
- 复制 sample.env 为 .env
- 到企业微信后台创建一个应用
- 将企业微信的 corpId 和 新建应用的 secret 填入 .env 文件
## 使用
- 运行 `./bin/hubot` 即可启动 hwamei
- 目前支持通过命令管理企业微信群、管理 webhook
## 部署
见 https://github.com/hubotio/hubot/blob/master/docs/deploying.md
## 企业微信相关命令
- `hwamei>wxwork create chat {chatid} with {users}` 创建一个群, users 以英文逗号分隔
- `hwamei>wxwork destroy chat {chatid}` 删除一个群
- `hwamei>wxwork show {chatid}` 显示群信息
- `hwamei>wxwork add {userid} to {chatid}` 添加用户到指定群
- `hwamei>wxwork remove {userid} from {chatid}` 从指定群中删除用户
企业微信消息推送文档 https://work.weixin.qq.com/api/doc#90000/90135/90243
## webhook 相关命令
- `hwamei>webhook create {name} from {type} to {chatid}` 创建一个 webhook
- `hwamei>webhook list` 列出所有 webhook
- `hwamei>webhook delete all` 删除所有 webhook
- `hwamei>webhook delete {token}` 删除一个 webhook
- `hwamei>webhook update {token} {name|type|chat_id} to {value}` 修改一个 webhook
- `hwamei>webhook backup` 备份 webhooks 到 ./data/webhooks.json
- `hwamei>webhook restore` 恢复 webhooks
### webhook 使用
1. 先创建 webhook
- `hwamei>webhook create test_incoming_webhook from incoming to test`
- 上面命令会创建一个名为 test_incoming_webhook 的 webhook,接收 incoming 类型的输入,输出到 test 企业微信群
- 运行命令后系统会输出 webhook url,像这个 url 发送请求即可触发 webhook
- `There is your webhook url: /incoming/408dcc98-60a6-4a10-8c77-4679dd9a0a40`
2. 测试 webhook
- `shell>curl -XPOST http://localhost:8080/incoming/408dcc98-60a6-4a10-8c77-4679dd9a0a40 -H 'Content-type: application/json' -d '{ "message": "hello hwamei" }'`
- 运行上面的命令,正常情况下你的企业微信群应该就收到消息了
3. 目前支持下列几种类型的 webhook type
- incoming
- `{ "message": "hello hwamei" }`
- `{ "text": "hello hwamei" }`
- sentry
- gitlab
- github
## 扩展更多命令
查看 https://github.com/hubotio/hubot/blob/master/docs/scripting.md
没有合适的资源?快使用搜索试试~ 我知道了~
温馨提示
hwamei 推荐使用 替代本项目,无需部署,简单配置即可打通企业微信群机器人与Github、Gitlab、Sentry、Jenkins 等工具 webhook。 hwamei 是一个基于 hubot 的企业微信聊天机器人,它能够通过 webhook 将收集的信息发送到企业微信群中。 已兼容企业微信原生webhook机器人!!! 具体见 预览 工作流程 安装 git clone https://github.com/tlikai/hwamei.git 运行 npm install 复制 sample.env 为 .env 到企业微信后台创建一个应用 将企业微信的 corpId 和 新建应用的 secret 填入 .env 文件 使用 运行 ./bin/hubot 即可启动 hwamei 目前支持通过命令管理企业微信群、管理 webhook 部署 见 企业微信相关命令 hwamei>wxw
资源详情
资源评论
资源推荐
收起资源包目录
hwamei-master.zip (17个子文件)
hwamei-master
bin
hubot.cmd 156B
hubot 157B
package.json 404B
data
flow.png 6KB
.gitkeep 0B
external-scripts.json 49B
Procfile 24B
package-lock.json 53KB
sample.env 76B
.gitignore 63B
lib
wxwork.js 3KB
webhook_handlers.js 3KB
README.md 3KB
scripts
http.js 2KB
wxwork.js 3KB
webhook.js 3KB
.editorconfig 197B
共 17 条
- 1
梦小露
- 粉丝: 20
- 资源: 4640
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
评论0