持续集成之企业微信通知:2:推送消息格式说明
這篇文章介紹一下目前企業(yè)微信所支持的推送消息的格式和使用方法,大部分內(nèi)容來(lái)源于添加機(jī)器人后自帶的配置說(shuō)明文檔。
推送消息示例
curl 'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=633a31f6-7f9c-4bc4-97a0-0ec1eefa5898' \-H 'Content-Type: application/json' \-d '{"msgtype": "text","text": {"content": "hello world"}}'使用說(shuō)明:
- key是此機(jī)器人證明身份的標(biāo)志,需要仔細(xì)保存
- Content-Type使用json格式
- json格式的消息類型(msgtype)支持text(文本)、image(圖片)、markdown、news(圖文)
注:本文使用的示例中的key的信息均為企業(yè)微信說(shuō)明中提供
文本類型消息格式說(shuō)明
- 說(shuō)明示例
| msgtype | 是 | 消息類型,此時(shí)固定為text |
| content | 是 | 文本內(nèi)容,最長(zhǎng)不超過(guò)2048個(gè)字節(jié),必須是utf8編碼 |
| mentioned_list | 否 | userid的列表,提醒群中的指定成員(@某個(gè)成員),@all表示提醒所有人,如果開(kāi)發(fā)者獲取不到userid,可以使用mentioned_mobile_list |
| mentioned_mobile_list | 否 | 手機(jī)號(hào)列表,提醒手機(jī)號(hào)對(duì)應(yīng)的群成員(@某個(gè)成員),@all表示提醒所有人 |
追加說(shuō)明:
mentioned_list中的"userid列表"中的userid,如果使用微信號(hào)注冊(cè)的企業(yè)微信,請(qǐng)注意此id為在此群中的企業(yè)微信中的id而不是微信號(hào),需要單獨(dú)@多個(gè)人的時(shí)候格式為"userid1","userid2"以逗號(hào)隔開(kāi)
mentioned_mobile_list中的手機(jī)也是此微信群中的用戶的手機(jī)號(hào)碼,如果信息不對(duì)應(yīng)時(shí)@操作會(huì)無(wú)法提醒。
markdown類型消息格式說(shuō)明
- 說(shuō)明示例
| msgtype | 是 | 消息類型,此時(shí)固定為markdown |
| content | 是 | markdown內(nèi)容,最長(zhǎng)不超過(guò)4096個(gè)字節(jié),必須是utf8編碼 |
markdown語(yǔ)法支持
目前只支持部分markdown語(yǔ)法,所支持的內(nèi)容如下
標(biāo)題 (支持1至6級(jí)標(biāo)題,注意#與文字中間要有空格)
# 標(biāo)題一 ## 標(biāo)題二 ### 標(biāo)題三 #### 標(biāo)題四 ##### 標(biāo)題五 ###### 標(biāo)題六加粗
**bold**鏈接
[這是一個(gè)鏈接](http://work.weixin.qq.com/api/doc)行內(nèi)代碼段(暫不支持跨行)
`code`引用
> 引用文字字體顏色(只支持3種內(nèi)置顏色)
<font color="info">綠色</font> <font color="comment">灰色</font> <font color="warning">橙紅色</font>圖片類型消息格式說(shuō)明
- 說(shuō)明示例
| msgtype | 是 | 消息類型,此時(shí)固定為image |
| base64 | 是 | 圖片內(nèi)容的base64編碼 |
| md5 | 是 | 圖片內(nèi)容(base64編碼前)的md5值 |
注:圖片(base64編碼前)最大不能超過(guò)2M,支持JPG,PNG格式
圖文類型消息格式說(shuō)明
- 說(shuō)明示例
| msgtype | 是 | 消息類型,此時(shí)固定為news |
| articles | 是 | 圖文消息,一個(gè)圖文消息支持1到8條圖文 |
| title | 是 | 標(biāo)題,不超過(guò)128個(gè)字節(jié),超過(guò)會(huì)自動(dòng)截?cái)?/td> |
| description | 否 | 描述,不超過(guò)512個(gè)字節(jié),超過(guò)會(huì)自動(dòng)截?cái)?/td> |
| url | 是 | 點(diǎn)擊后跳轉(zhuǎn)的鏈接。 |
| picurl | 否 | 圖文消息的圖片鏈接,支持JPG、PNG格式,較好的效果為大圖 1068*455,小圖150*150。 |
消息發(fā)送頻率限制
每個(gè)機(jī)器人發(fā)送的消息不能超過(guò)20條/分鐘。
推送消息白名單配置
為了防止被盜用,可以結(jié)合機(jī)器人提供的白名單功能進(jìn)行設(shè)定,可設(shè)定用于推送消息的IP白名單地址,如果不設(shè)定,默認(rèn)不做限制
參考內(nèi)容
企業(yè)微信群機(jī)器人使用配置說(shuō)明
總結(jié)
以上是生活随笔為你收集整理的持续集成之企业微信通知:2:推送消息格式说明的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: Zabbix 事件通知机制之微信通知
- 下一篇: 由freemarker毫秒级时间谈固定日