企业微信消息推送配置说明(推送接口)

如何使用消息推送

  • 创建者可以在 创建消息推送页面、创建完成页面、消息推送详情页面,看到该消息推送特有的webhookurl。开发者可以按以下说明向这个地址发起HTTP POST 请求,即可实现给该群组发送消息。下面举个简单的例子.
    假设webhook是:https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693a91f6-7xxx-4bc4-97a0-0ec2sifa5aaa
特别特别要注意:一定要保护好消息推送的webhook地址,避免泄漏!不要分享到github、博客等可被公开查阅的地方,否则坏人就可以用你的消息推送来发垃圾消息了。

以下是用curl工具往群组推送文本消息的示例(注意要将url替换成你的消息推送webhook地址,content必须是utf8编码):

<span style="color:rgba(14, 19, 26, 0.8)"><span style="background-color:#ffffff"><span style="color:#000000"><code class="language-javascript">curl <span style="color:#2f9c0a">'https://qyapi.weixin.qq.com/cgi-bin/webhook/send?key=693axxx6-7aoc-4bc4-97a0-0ec2sifa5aaa'</span> \
   <span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">-</span></span><span style="color:#c92c2c">H</span> <span style="color:#2f9c0a">'Content-Type: application/json'</span> \
   <span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">-</span></span>d '
   <span style="color:#5f6364">{</span>
    	<span style="color:#2f9c0a">"msgtype"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span> <span style="color:#2f9c0a">"text"</span><span style="color:#5f6364">,</span>
    	<span style="color:#2f9c0a">"text"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span> <span style="color:#5f6364">{</span>
        	<span style="color:#2f9c0a">"content"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span> <span style="color:#2f9c0a">"hello world"</span>
    	<span style="color:#5f6364">}</span>
   <span style="color:#5f6364">}</span>'</code></span></span></span>
  • 当前自定义消息推送支持文本(text)、markdown(markdown、markdown_v2)、图片(image)、图文(news)、文件(file)、语音(voice)、模板卡片(template_card)八种消息类型。
  • 消息推送的text/markdown类型消息支持在content中使用<@userid>扩展语法来@群成员(markdown_v2类型消息不支持该扩展语法)

消息类型及数据格式

文本类型

<span style="color:rgba(14, 19, 26, 0.8)"><span style="background-color:#ffffff"><span style="color:#000000"><code class="language-javascript"><span style="color:#5f6364">{</span>
    <span style="color:#2f9c0a">"msgtype"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span> <span style="color:#2f9c0a">"text"</span><span style="color:#5f6364">,</span>
    <span style="color:#2f9c0a">"text"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span> <span style="color:#5f6364">{</span>
        <span style="color:#2f9c0a">"content"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span> <span style="color:#2f9c0a">"广州今日天气:29度,大部分多云,降雨概率:60%"</span><span style="color:#5f6364">,</span>
		<span style="color:#2f9c0a">"mentioned_list"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span><span style="color:#5f6364">[</span><span style="color:#2f9c0a">"wangqing"</span><span style="color:#5f6364">,</span><span style="color:#2f9c0a">"@all"</span><span style="color:#5f6364">]</span><span style="color:#5f6364">,</span>
		<span style="color:#2f9c0a">"mentioned_mobile_list"</span><span style="background-color:rgba(255, 255, 255, 0.5)"><span style="color:#a67f59">:</span></span><span style="color:#5f6364">[</span><span style="color:#2f9c0a">"13800001111"</span><span style="color:#5f6364">,</span><span style="color:#2f9c0a">"@all"</span><span style="color:#5f6364">]</span>
    <span style="color:#5f6364">}</span>
<span style="color:#5f6364">}</span></code></span></span></span>
参数是否必填说明
msgtype消息类型,此时固定为text
content文本内容,最长不超过2048个字节,必须是utf8编码
mentioned_listuserid的列表,提醒群中的指定成员(@某个成员),@all表示提醒所有人,如果开发者获取不到userid,可以使用mentioned_mobile_list
mentioned_mobile_list手机号列表,提醒手机号对应的群成员(@某个成员),@all表示提醒所有人

 

 

markdown类型

{
    "msgtype": "markdown",
    "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消息类型,此时固定为markdown
contentmarkdown内容,最长不超过4096个字节,必须是utf8编码

目前支持的markdown语法是如下的子集:

  1. 标题 (支持1至6级标题,注意#与文字中间要有空格)
    # 标题一
    ## 标题二
    ### 标题三
    #### 标题四
    ##### 标题五
    ###### 标题六
  2. 加粗
    **bold**
  3. 链接
    [这是一个链接](https://work.weixin.qq.com/api/doc)
  4. 行内代码段(暂不支持跨行)
    `code`
  5. 引用
    > 引用文字
  6. 字体颜色(只支持3种内置颜色)
    <font color="info">绿色</font>
    <font color="comment">灰色</font>
    <font color="warning">橙红色</font>

markdown_v2类型

{
	"msgtype": "markdown_v2",
	"markdown_v2": {
         "content": "# 一、标题\n## 二级标题\n### 三级标题\n# 二、字体\n*斜体*\n\n**加粗**\n# 三、列表 \n- 无序列表 1 \n- 无序列表 2\n  - 无序列表 2.1\n  - 无序列表 2.2\n1. 有序列表 1\n2. 有序列表 2\n# 四、引用\n> 一级引用\n>>二级引用\n>>>三级引用\n# 五、链接\n[这是一个链接](https:work.weixin.qq.com\/api\/doc)\n![](https://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png)\n# 六、分割线\n\n---\n# 七、代码\n`这是行内代码`\n```\n这是独立代码块\n```\n\n# 八、表格\n| 姓名 | 文化衫尺寸 | 收货地址 |\n| :----- | :----: | -------: |\n| 张三 | S | 广州 |\n| 李四 | L | 深圳 |\n"
	   }
}
参数是否必填说明
msgtype消息类型,此时固定为markdown_v2。
contentmarkdown_v2内容,最长不超过4096个字节,必须是utf8编码。
特殊的,
1. markdown_v2不支持字体颜色、@群成员的语法, 具体支持的语法可参考下面说明
2. 消息内容在客户端 4.1.36 版本以下(安卓端为4.1.38以下) 消息表现为纯文本,建议使用最新客户端版本体验

评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
红包 添加红包
表情包 插入表情
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值