持续集成之企业微信通知:2:推送消息格式说明
发布日期:2021-06-30 20:16:11 浏览次数:2 分类:技术文章

本文共 2487 字,大约阅读时间需要 8 分钟。

在这里插入图片描述

这篇文章介绍一下目前企业微信所支持的推送消息的格式和使用方法,大部分内容来源于添加机器人后自带的配置说明文档。

推送消息示例

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" } }'

使用说明:

  • key是此机器人证明身份的标志,需要仔细保存
  • Content-Type使用json格式
  • json格式的消息类型(msgtype)支持text(文本)、image(图片)、markdown、news(图文)

注:本文使用的示例中的key的信息均为企业微信说明中提供

文本类型消息格式说明

  • 说明示例
{
"msgtype": "text", "text": {
"content": "广州今日天气:29度,大部分多云,降雨概率:60%", "mentioned_list":["wangqing","@all"], "mentioned_mobile_list":["13800001111","@all"] }}
参数 是否必填 说明
msgtype 消息类型,此时固定为text
content 文本内容,最长不超过2048个字节,必须是utf8编码
mentioned_list userid的列表,提醒群中的指定成员(@某个成员),@all表示提醒所有人,如果开发者获取不到userid,可以使用mentioned_mobile_list
mentioned_mobile_list 手机号列表,提醒手机号对应的群成员(@某个成员),@all表示提醒所有人

追加说明:

mentioned_list中的"userid列表"中的userid,如果使用微信号注册的企业微信,请注意此id为在此群中的企业微信中的id而不是微信号,需要单独@多个人的时候格式为"userid1","userid2"以逗号隔开
mentioned_mobile_list中的手机也是此微信群中的用户的手机号码,如果信息不对应时@操作会无法提醒。

markdown类型消息格式说明

  • 说明示例
{
"msgtype": "markdown", "markdown": {
"content": "实时新增用户反馈132例,请相关同事注意。\n >类型:用户反馈 \n >普通用户反馈:117例 \n >VIP用户反馈:15例" }}
参数 是否必填 说明
msgtype 消息类型,此时固定为markdown
content markdown内容,最长不超过4096个字节,必须是utf8编码

markdown语法支持

目前只支持部分markdown语法,所支持的内容如下

标题 (支持1至6级标题,注意#与文字中间要有空格)

# 标题一## 标题二### 标题三#### 标题四##### 标题五###### 标题六

加粗

**bold**

链接

[这是一个链接](http://work.weixin.qq.com/api/doc)

行内代码段(暂不支持跨行)

`code`

引用

> 引用文字

字体颜色(只支持3种内置颜色)

绿色灰色橙红色

图片类型消息格式说明

  • 说明示例
{
"msgtype": "image", "image": {
"base64": "DATA", "md5": "MD5" }}
参数 是否必填 说明
msgtype 消息类型,此时固定为image
base64 图片内容的base64编码
md5 图片内容(base64编码前)的md5值

注:图片(base64编码前)最大不能超过2M,支持JPG,PNG格式

图文类型消息格式说明

  • 说明示例
{
"msgtype": "news", "news": {
"articles" : [ {
"title" : "中秋节礼品领取", "description" : "今年中秋节公司有豪礼相送", "url" : "URL", "picurl" : "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png" } ] }}
参数 是否必填 说明
msgtype 消息类型,此时固定为news
articles 图文消息,一个图文消息支持1到8条图文
title 标题,不超过128个字节,超过会自动截断
description 描述,不超过512个字节,超过会自动截断
url 点击后跳转的链接。
picurl 图文消息的图片链接,支持JPG、PNG格式,较好的效果为大图 1068*455,小图150*150。

消息发送频率限制

每个机器人发送的消息不能超过20条/分钟。

推送消息白名单配置

为了防止被盗用,可以结合机器人提供的白名单功能进行设定,可设定用于推送消息的IP白名单地址,如果不设定,默认不做限制

在这里插入图片描述

参考内容

企业微信群机器人使用配置说明

转载地址:https://liumiaocn.blog.csdn.net/article/details/103736476 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:持续集成之企业微信通知:3:推送消息示例(text、markdown、news)
下一篇:持续集成之企业微信通知:1:群机器人使用方法介绍

发表评论

最新留言

初次前来,多多关照!
[***.217.46.12]2024年04月07日 03时44分26秒