action-wechat-work/README.md

# WeChat Work for GitHub Actions

通过企业微信机器人发送消息

![WeChat Work Logo](wechat-work-logo.png "WeChat Work Logo")

<hr/>

## 用法

### 纯文本格式消息

![WeChat Work message](wechat-work-msg-text.png "WeChat Work message")

```yaml
- name: WeChat Work notification by text
  uses: chf007/action-wechat-work@master
  env:
    WECHAT_WORK_BOT_WEBHOOK: ${{secrets.WECHAT_WORK_BOT_WEBHOOK}}
  with:
    msgtype: text
    content: 广州今日天气：29 度，大部分多云，降雨概率：60%
    mentioned_list: '["wangqing","@all"]'
    mentioned_mobile_list: '["13800001111","@all"]'
```

参数 | 必须 | 说明
------------ | ------------- | -------------
msgtype | true | 消息类型，此时固定为 text
content | true | 文本内容，最长不超过 2048 个字节，必须是 utf8 编码
mentioned_list | false | userid 的列表，提醒群中的指定成员(@某个成员)，@all表示提醒所有人，如果开发者获取不到 userid，可以使用 mentioned_mobile_list，必须是序列化后的 JSON 字符串
mentioned_mobile_list | false | 手机号列表，提醒手机号对应的群成员(@某个成员)，@all表示提醒所有人，必须是序列化后的 JSON 字符串

### Markdown 格式消息

![WeChat Work message](wechat-work-msg-markdown.png "WeChat Work message")

```yaml
- name: WeChat Work notification by markdown
  uses: chf007/action-wechat-work@master
  env:
    WECHAT_WORK_BOT_WEBHOOK: ${{secrets.WECHAT_WORK_BOT_WEBHOOK}}
  with:
    msgtype: markdown
    content: "实时新增用户反馈<font color=\"warning\">132例</font>，请相关同事注意。\n
    > 类型:<font color=\"comment\">用户反馈</font> \n
    > 普通用户反馈:<font color=\"comment\">117例</font> \n
    > VIP用户反馈:<font color=\"comment\">15例</font>"
```

参数 | 必须 | 说明
------------ | ------------- | -------------
msgtype | true | 消息类型，此时固定为 markdown
content | true | markdown 内容，最长不超过 4096 个字节，必须是 utf8 编码 支持的格式详见 https://work.weixin.qq.com/api/doc/90000/90136/91770

### 图片格式消息

![WeChat Work message](wechat-work-msg-image.png "WeChat Work message")

```yaml
- name: WeChat Work notification by image
  uses: chf007/action-wechat-work@master
  env:
    WECHAT_WORK_BOT_WEBHOOK: ${{secrets.WECHAT_WORK_BOT_WEBHOOK}}
  with:
    msgtype: image
    base64: iVBORw0KGgoAAAANSUhEUgAAAPEAAAByCAYAAACC7zd/AAAgAElEQVR4nO19CZRc1Xnm/2qv6lartXa3urUrktDeaiQBJoBBSGxWItszJDEZFMwyoBxPOGPOBBzMsZWB8XDGOMcGA7IVnMMk48nYYBmBJMAOiQwWjdQICe1rJLW6W2tvVV3rm/+7772qV/ur7nqNCt3vqPS6Xt13l//+2733v/cpPb39KklISFQsHJ91BSQkJIYGKcQSEhUOKcQSEhUOKcQSEhUOKcQSEhUOKcQSEhUOKcQSEhUOKcQSEhUOKcQSEhUOV9EUne/Qd35K9NATy6l+16v0wMs7ciSaQKu//RjdUYe/u+jNp7dSwxP3UMOWZ+mN+sfo/oW4v5t+8nQn3YV80p5NpW/mbx38zJMb21M/L7mP1q+Zb0r7DL12OvXzsgefo7s6Mp5pvJPWZZWjA21oW2jKMxvd3d104MA+Cg8MFCBMaVAUhTxeL82adRWNHDmybPlKSBQX4gw0rXqcnlo53nRHF0IW4LZXHqUXWvXbaw1hf5S2m1JvX7tJ/6uFHnleE9xMQDCF4EOBvJX5a+o5CPwbWfXSlEU+dHScoaaGFQXbaFWAnU6nuMbj8Zy/me+rqiryRN5Ll15TNG8JCasoKMRmoXxybRutXtWQI1UntbNlxC/Nax6nR1i6mheON+XxKtGahbTj6c10esJt9NQaSlrkM5z/A2ahZ6u7LlcRadhBL6xNeQPLHtSupzY+Qw9s1G+yJb4rz9NnzrRrlS2ATAE2hBUwCyb+xm9mYTanzfVcJBwuXHgBiP5oz/AyzN5RmtdiPY8076dAHsWezVbwZuheFJmfN3tWZm/OBFP7zPlbrfOVgIJC3LzmOVp/e7o73dqBXzLcWibi/QTC/ow2Mr1feFkj7rIHH6cJQmbm0/1PzNc6ZO0Z0VnoxHoj/+920Kqkdd1coEbj6Y4nnqM7THfQmS/RvbT++U76ydrNNCEXIyTRRZDhU9Qp8rKCiRMn0uTJkykajYrvAyzgu3btEgJ69dVXk9vtTqb94IMPaMKECeJj3Mdzhw8fpvPnz4vvsMglAx7JdzdR45KWjB/Y68DQgGln9MlPdulejNU8+P5LGxvYu3mM6Z8nj3zPcn8+uaOZ1j2P/uS6rP0ZvbkoN/3BG60sqGa0vfIMtbY8TuufyNMXKPdl4ro9x3Uz5U8W6nwFoWR3WkO2MAH1Kx+jh+hV2vl1JnQHNOgzmpYkkxZ/fgXtfJotsK6R6eM2Fqp2tq4k3ORCRjJrvJyEyQp/91HW9pR7XNz5CbWenkBNtIvaWLHkcuVzltvRIQQRWLZsGVVVVdHo0aOFYOI+BHrq1Knic+zYMTp58iQtXLiQTp06RZcuXcrpbpeEuuX01PPLhdBsT2s+K8c1xt/jqYFlpLWji2hhDqHIm0cmWAllTibkeVYMTVpW6DSeTy1LNtAOoeQh9G20xFCoUBQs7A/d2UFPGqMpvreR+eGhNRl17Uw9uxi8seQ2vZ+0/Dd+3EV3LLJQ5ysI1oT49KakO53mtiaR7Qp11K/QLQQ06KvUwtp0vf5bSgGwFj3TQMsaG6jl6/W08ZXd9FABKYaSWL/S+IZ8N9BpdrFWnXmGXqDiLlUHMwWtupcVzc/opS1d1JzX9UvHmDFjxBXCC/T399O8efNoz5494juEFMJ77bXXJoUaaYYXu2lH6wRmfmttSgIC+iA8pEfFVzEfkdeTSUd9PfPDpk+oYyWUpeblnG6AEtGFXoD7+KcslKzY61mxJ8GK8RRLHhS68OgMpVuXehb6oKkhVZkG1lKnzrAXtXLwdf48ooAQm1xmg8Bwp1fdR0t27ErOJuec2GKf+rWM3LavzZzVbmGlcIbam+9ll3urxkxrkAe7xFmaVkPaxJmY4HpOuPFErCCEq74hlTjLEu+mN1j5gMnr626jxrVbqW1l7om1TMCFvnjxovjMmDEjKcwGzGNfAEKNNEg/ZCtsEW2vaArtft3ywf09JX7JM9ZMgvtv0w4x3oRye/JlKFxrdKGF99AjbY+ygt8kylm2ZEJWEuFGt9xLT6H8DtN9tuLUyp9vc9/pvPPSlgUFxtQaNKEeQp0/hyggxLrLrC8xpVBHd9xJ9ABbTVi+ZCfhJ4xx11gvvG3LO7SYxzE7DRdLaPMGashiOFjdXdxRj9PqdmMsrk1wCS1MGUtfOVzpNCZn1+yuVZvpSb0NxQCrCtcZwgqBhivd3t4uBBrWGIKKv+F2A5lCbTeEcoMnYghAndkSFgb677UJxrOP0Tp6tiQvpTnZ51DmP6MJt6evXOzc0U6nTqd7b08+TbTuTna5lixMKpfm5hZ6oS17rkJYXv2eMSk51Dp/3jC4MTFr4HUdz2qWTwiMmXiam7s978Mpy9C8EozWlfoJY1YWvYdyPdZYL8bLZwaxxIR0YjxuGn/Vr7yXVrOn8Z0thWZU9bT19UmXGoAAAxDmG264QUxe4fPRRx+J+8NlfQ1vqf1OFqShTOq0d7KRnC9cYggdZc6fWcGurex9NdO6NAWcMXcCb2lTvaZg2Tg0te6itjXa3ERb246spb/6Rc3UtNFIYxoufFymOn9OMMiJLbim+gzH6Q4WLEqfQCoQbNH2yrMifS60vbWJH30u+7nOTjo9oU6/X9oSk+aCQ/Az6wMGe5yIheCBM/nH05ikgtDmEkxjltqAOQ1+KxvS3GPS3FexHLdZ80peTq3FJ9fYLeaxfg0rsx3P6C4xafcylVreZ8mksE007syY2MqFjLF4sty0Z5fTQ6ue5fJSY1+R30oLdb6CoBQ6Yys5G2yswyXX7MyBGrrlTa7VWbfEGvQxNSa2jKWsZNpUXpqlpazoLhERxu70dzpWpFliYx06a101BzLXPz/88PdljdYyw+vzyWAPibKioBBfqbAj7BKAAMuwS4lyQwqxhESFQ+5ikpCocEghlpCocEghlpCocEghlpCocEghlpCocEghlpCocBSM2PJ4XGLNNBgMUiKREEfMYD8srgD+xn2Hw0EqX+1eq0I5KM9OmNv2eSjH4UCfDUc5zANqguwsBiRTlOHhAfROwobGgE6BQICqq6uZVkpZ8iwoxAh22LN7t2gUwgtReF9fH/l8PiHYU6ZMoRnTp9PeAwdp+qyZ5C1LlXID5AxGiarcRZMOCRH+gEd8NvsoAwl0KCtKe4uhUIzI7Rp0fK1loG+83Dd2bv1AUGuYywnYzANMMopyYX4bGoPQXOwxT/BVcZSnVwrmcuHCBRo3bhz5/X4hyJFIRGwEwLW2tlYIM3Do4GHy19ZRwOe3TeMj397ebqoZWUt2mXyFrdZAiL2OeIIC1SOEd2EHoI37+3rJ4XSQzx/gcuxpEMrp6ekmr9fDXpXPtr5RUE73RVbyVeR0uezpHzZasViMQsF+5oFRtvWNxucDgsdHjBhpi9WPk5/aO8/TlIYxxRNbQBF32kPz5xffqufijnPABSmPd5AXMI6iCJvKUcRH0d02G8vR808WYWM5DiXVJruArB2mNtnZPw67y0jSy8QHZYbL5SyrEqqoiS0ZH3oZY7g6RzJBFipKiCUkJLJRUUJss7cuMRQMV+dIJshCRQmx7YNuiSFASvFnhcoS4uHCsCgLyfSXMyqJalKIMzGcvTdcnkUlcWQBDJsjVmH0kkIsUUZUGPd/TlAWIVaGQUUqejl2lqWF2ymp9VsbkVwntpl2ip2LqqYyjHbY1R5z/vazm00LxOYSyph/0bgvvF8IkT44bxlXBHYgcgafxsZGmjZtGoVCWmw1Qspsi9HlfFFmnD92LRViAT4Wj3Fb4nyN2xYVhBhjtAURW2iPHTG6WjmgWZzLYbrFnfZF0yVU0Y440w68aUcxYHnwlyiH25RQ7YvYQju09sRti9NGGeVCQSHGu4Q2bNhAq1atoqNHj4oXheH41lGjRomNEYilxn0c6zq/JUyJWDSLUQppnFxMlS890iLkDkrEahn5mDZfetw3FBLssbHpo5T6W6kPwiGD/f1CiCEA+fIpNf/MZ1BOKNjHDOnRlF+O/AbbBjNEe7hvuCXcP+70NKqaU+kOhi+g+BAW63K7k8I1VBplptfCLsM
    md5: 0582d8564cdee3187207666898f75205
```

参数 | 必须 | 说明
------------ | ------------- | -------------
msgtype | true | 消息类型，此时固定为 image
base64 | true | 图片内容的 base64 编码 注：图片（base64 编码前）最大不能超过 2 M，支持 JPG、PNG 格式
md5 | true | 图片内容（base64 编码前）的 md5 值

### 图文格式消息

![WeChat Work message](wechat-work-msg-news.png "WeChat Work message")

```yaml
- name: WeChat Work notification by news
  uses: chf007/action-wechat-work@master
  env:
    WECHAT_WORK_BOT_WEBHOOK: ${{secrets.WECHAT_WORK_BOT_WEBHOOK}}
  with:
    msgtype: news
    articles: '[{"title":"中秋节礼品领取","description":"今年中秋节公司有豪礼相送","url":"URL","picurl":"http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"}]'
```
参数 | 必须 | 说明
------------ | ------------- | -------------
msgtype | true | 消息类型，此时固定为 news
articles | true | 图文消息，一个图文消息支持 1 到 8 条图文，必须是序列化后的 JSON 字符串
articles.title | true | 标题，不超过 128 个字节，超过会自动截断
articles.description | false | 描述，不超过 512 个字节，超过会自动截断
articles.url | false | 点击后跳转的链接。
articles.picurl | false | 图文消息的图片链接，支持 JPG、PNG 格式，较好的效果为大图 1068*455，小图 150*150。

### 文件格式消息

![WeChat Work message](wechat-work-msg-file.png "WeChat Work message")

```yaml
- name: WeChat Work notification by file
  uses: chf007/action-wechat-work@master
  env:
    WECHAT_WORK_BOT_WEBHOOK: ${{secrets.WECHAT_WORK_BOT_WEBHOOK}}
  with:
    msgtype: file
    media_id: 3a8asd892asd8asd
```

参数 | 必须 | 说明
------------ | ------------- | -------------
msgtype | true | 消息类型，此时固定为 file
media_id | true | 文件 id，通过 [文件上传接口](https://work.weixin.qq.com/api/doc/90000/90136/91770) 获取

### WECHAT_WORK_BOT_WEBHOOK

* **`WECHAT_WORK_BOT_WEBHOOK`**: 企业微信 Webhook URL (**required**)
* 在 GitHub 仓库的 Settings - Secrets 中设置

### 更多企业微信机器人详细说明，参见 [https://work.weixin.qq.com/api/doc/90000/90136/91770](https://work.weixin.qq.com/api/doc/90000/90136/91770)