企业内部开发 服务端API 消息推送 发送应用消息
发送应用消息
最后更新:2023/08/09
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
发送应用消息 最后更新:2023/08/09

目录

  • 接口定义
  • 消息类型
  • 文本消息
  • 图片消息
  • 语音消息
  • 视频消息
  • 文件消息
  • 文本卡片消息
  • 图文消息
  • 图文消息(mpnews)
  • markdown消息
  • 小程序通知消息
  • 模板卡片消息
  • 文本通知型
  • 图文展示型
  • 按钮交互型
  • 投票选择型
  • 多项选择型
  • 附录
  • 支持的markdown语法
  • id转译说明
  • 接口定义

    应用支持推送文本、图片、视频、文件、图文等类型。

    请求方式: POST( HTTPS
    请求地址: https://qyapi.weixin.qq.com/cgi-bin/message/send?access_token=ACCESS_TOKEN

    参数说明:

    - 各个消息类型的具体POST格式请阅后续“消息类型”部分。
    - 如果有在管理端对应用设置“在微工作台中始终进入主页”,应用在微信端只能接收到文本消息,并且文本消息的长度限制为20字节,超过20字节会被截断。同时其他消息类型也会转换为文本消息,提示用户到企业微信查看。
    - 支持id转译,将userid/部门id转成对应的用户名/部门名,目前仅 文本/文本卡片/图文/图文(mpnews)/任务卡片/小程序通知/模版消息/模板卡片消息 这八种消息类型的 部分字段 支持。仅第三方应用需要用到,企业自建应用可以忽略。具体支持的范围和语法,请查看附录
    id转译说明
    - 支持重复消息检查,当指定 "enable_duplicate_check": 1 开启: 表示在一定时间间隔内,同样内容(请求json)的消息,不会重复收到;时间间隔可通过 duplicate_check_interval 指定,默认 1800秒
    - 从2021年2月4日开始,企业关联添加的「小程序」应用,也可以发送文本、图片、视频、文件、图文等各种类型的消息了。
    调用建议 :大部分企业应用在每小时的0分或30分触发推送消息,容易造成资源挤占,从而投递不够及时,建议尽量避开这两个时间点进行调用。
    频率限制 :每应用不可超过账号上限数*200人次/天(注:若调用api一次发给1000人,算1000人次;若企业账号上限是500人,则每个应用每天可发送100000人次的消息)。每应用对同一个成员不可超过30次/分钟,超过部分会被丢弃不下发

    返回示例:

    "errcode" : 0 , "errmsg" : "ok" , "invaliduser" : "userid1|userid2" , "invalidparty" : "partyid1|partyid2" , "invalidtag" : "tagid1|tagid2" , "unlicenseduser" : "userid3|userid4" , "msgid" : "xxxx" , "response_code" : "xyzxyz"
    如果部分接收人无权限或不存在,发送仍然执行,但会返回无效的部分(即invaliduser或invalidparty或invalidtag或unlicenseduser),常见的原因是 接收人不在应用的可见范围内
    权限包含 应用可见范围 基础接口权限 (基础账号、互通账号均可),unlicenseduser中的用户在应用可见范围内但没有基础接口权限。
    如果 全部 接收人无权限或不存在,则本次调用返回失败,errcode为81013。
    返回包中的userid,不区分大小写,统一转为小写

    参数说明:

    参数 说明
    errcode 返回码
    errmsg 对返回码的文本描述内容
    invaliduser 不合法的userid,不区分大小写,统一转为小写
    invalidparty 不合法的partyid
    invalidtag 不合法的标签id
    unlicenseduser 没有基础接口许可(包含已过期)的userid
    msgid 消息id,用于 撤回应用消息
    response_code 仅消息类型为“按钮交互型”,“投票选择型”和“多项选择型”的模板卡片消息返回,应用可使用response_code调用 更新模版卡片消息 接口,72小时内有效,且只能使用一次

    消息类型

    文本消息

    请求示例:

    参数说明:

    touser、toparty、totag不能同时为空 ,后面不再强调。

    文本消息展现:

    特殊说明:
    其中text参数的content字段可以支持换行、以及A标签,即可打开自定义的网页(可参考以上示例代码)(注意:换行符请用转义过的\n)

    图片消息

    请求示例:

    请求参数:

    语音消息

    请求示例:

    参数说明:

    视频消息

    请求示例:

    参数说明:


    视频消息展现:

    文件消息

    请求示例:

    参数说明:


    文件消息展现:

    文本卡片消息

    请求示例:

    参数说明:

    文本卡片消息展现 :

    特殊说明
    卡片消息的展现形式非常灵活,支持使用br标签或者空格来进行换行处理,也支持使用div标签来使用不同的字体颜色,目前内置了3种文字颜色:灰色(gray)、高亮(highlight)、默认黑色(normal),将其作为div标签的class属性即可,具体用法请参考上面的示例。

    图文消息

    请求示例:

    参数说明:

    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:news
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    articles 图文消息,一个图文消息支持1到8条图文
    title 标题,不超过128个字节,超过会自动截断 (支持id转译)
    description 描述,不超过512个字节,超过会自动截断 (支持id转译)
    url 点击后跳转的链接。 最长2048字节,请确保包含了协议头(http/https),小程序或者url必须填写一个
    picurl 图文消息的图片链接,最长2048字节,支持JPG、PNG格式,较好的效果为大图 1068*455,小图150*150。
    appid 小程序appid,必须是与当前应用关联的小程序,appid和pagepath必须同时填写,填写后会忽略url字段
    pagepath 点击消息卡片后的小程序页面,最长128字节,仅限本小程序内的页面。appid和pagepath必须同时填写,填写后会忽略url字段
    enable_id_trans 表示是否开启id转译,0表示否,1表示是,默认0
    enable_duplicate_check 表示是否开启重复消息检查,0表示否,1表示是,默认0
    duplicate_check_interval 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时


    图文消息展现:

    图文消息(mpnews)

    mpnews类型的图文消息,跟普通的图文消息一致,唯一的差异是图文内容存储在企业微信。
    多次发送mpnews,会被认为是不同的图文,阅读、点赞的统计会被分开计算。

    请求示例:

    参数说明:

    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:mpnews
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    articles 图文消息,一个图文消息支持1到8条图文
    title 标题,不超过128个字节,超过会自动截断 (支持id转译)
    thumb_media_id 图文消息缩略图的media_id, 可以通过 素材管理 接口获得。此处thumb_media_id即上传接口返回的media_id
    author 图文消息的作者,不超过64个字节
    content_source_url 图文消息点击“阅读原文”之后的页面链接
    content 图文消息的内容,支持html标签,不超过666 K个字节 (支持id转译)
    digest 图文消息的描述,不超过512个字节,超过会自动截断 (支持id转译)
    safe 表示是否是保密消息,0表示可对外分享,1表示不能分享且内容显示水印,2表示仅限在企业内分享,默认为0;注意仅mpnews类型的消息支持safe值为2,其他消息类型不支持
    enable_id_trans 表示是否开启id转译,0表示否,1表示是,默认0
    enable_duplicate_check 表示是否开启重复消息检查,0表示否,1表示是,默认0
    duplicate_check_interval 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

    markdown消息

    目前仅支持 markdown语法的子集
    微工作台(原企业号)不支持展示markdown消息

    请求示例:

    "touser" : "UserID1|UserID2|UserID3" , "toparty" : "PartyID1|PartyID2" , "totag" : "TagID1 | TagID2" , "msgtype" : "markdown" , "agentid" : 1 , "markdown" : { "content" : "您的会议室已经预定,稍后会同步到`邮箱` \n>**事项详情** \n>事 项:<font color=\" info\ ">开会</font> \n>组织者:@miglioguan \n>参与者:@miglioguan、@kunliu、@jamdeezhou、@kanexiong、@kisonwang \n> \n>会议室:<font color=\" info\ ">广州TIT 1楼 301</font> \n>日 期:<font color=\" warning\ ">2018年5月18日</font> \n>时 间:<font color=\" comment\ ">上午9:00-11:00</font> \n> \n>请准时参加会议。 \n> \n>如需修改会议信息,请点击:[修改会议信息](https://work.weixin.qq.com)" "enable_duplicate_check" : 0 , "duplicate_check_interval" : 1800

    示例效果:

    参数说明:

    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:markdown
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    content markdown内容,最长不超过2048个字节,必须是utf8编码
    enable_duplicate_check 表示是否开启重复消息检查,0表示否,1表示是,默认0
    duplicate_check_interval 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

    小程序通知消息

    小程序通知消息只允许绑定了小程序的应用发送, 之前,消息会通过统一的会话【小程序通知】发送给用户
    从2019年6月28日起,用户收到的小程序通知会出现在各个独立的应用中。
    不支持@all全员发送
    微工作台(原企业号)不支持展示小程序通知消息

    请求示例:

    示例效果:

    参数说明:

    模板卡片消息

    投票选择型和多项选择型卡片仅企业微信3.1.12及以上版本支持
    文本通知型、图文展示型和按钮交互型三种卡片仅企业微信3.1.6及以上版本支持(但附件下载功能仍需更新至3.1.12)
    微工作台(原企业号)不支持展示模板卡片消息

    3.1.18版本新增

    1. source字段支持设置字体颜色
    2. horizontal_content_list新增type 3,代表点击跳转成员详情(仅企业微信3.1.18及以上版本支持)
    3. 新增action_menu(右上角菜单)(仅企业微信3.1.18及以上版本支持)
    4. quote_area(引用样式)、image_text_area(左图右文样式)、button_selection(按钮型卡片的下拉框样式)等字段

    特殊说明

    1. 仅有 按钮交互型、投票选择型、多项选择型 以及填写了action_menu字段的文本通知型、图文展示型的卡片支持回调更新或通过接口更新卡片。
    2. 支持回调更新的卡片可支持用户点击触发交互事件,需要开发者设置的回调接口来处理回调事件,回调协议可见文档 模板卡片事件推送 ,注意 没有配置回调接口的应用不可发送支持回调的卡片
    3. 开发者的服务收到回调事件后,需要根据协议返回相应的数据以更新卡片,对应的协议见文档 更新模版卡片消息
    4. 此接口发送支持回调更新的卡片消息之后,返回的参数里会带上response_code,可使用response_code调用 更新模版卡片消息 接口, response_code 72小时内有效,且只能调用一次接口

    文本通知型

    "touser" : "UserID1|UserID2|UserID3" , "toparty" : "PartyID1 | PartyID2" , "totag" : "TagID1 | TagID2" , "msgtype" : "template_card" , "agentid" : 1 , "template_card" : { "card_type" : "text_notice" , "source" : { "icon_url" : "图片的url" , "desc" : "企业微信" , "desc_color" : 1 "action_menu" : { "desc" : "卡片副交互辅助文本说明" , "action_list" : [ { "text" : "接受推送" , "key" : "A" } , { "text" : "不再推送" , "key" : "B" } "task_id" : "task_id" , "main_title" : { "title" : "欢迎使用企业微信" , "desc" : "您的好友正在邀请您加入企业微信" "quote_area" : { "type" : 1 , "url" : "https://work.weixin.qq.com" , "title" : "企业微信的引用样式" , "quote_text" : "企业微信真好用呀真好用" "emphasis_content" : { "title" : "100" , "desc" : "核心数据" "sub_title_text" : "下载企业微信还能抢红包!" , "horizontal_content_list" : [ "keyname" : "邀请人" , "value" : "张三" "type" : 1 , "keyname" : "企业微信官网" , "value" : "点击访问" , "url" : "https://work.weixin.qq.com" "type" : 2 , "keyname" : "企业微信下载" , "value" : "企业微信.apk" , "media_id" : "文件的media_id" "type" : 3 , "keyname" : "员工信息" , "value" : "点击查看" , "userid" : "zhangsan" "jump_list" : [ "type" : 1 , "title" : "企业微信官网" , "url" : "https://work.weixin.qq.com" "type" : 2 , "title" : "跳转小程序" , "appid" : "小程序的appid" , "pagepath" : "/index.html" "card_action" : { "type" : 2 , "url" : "https://work.weixin.qq.com" , "appid" : "小程序的appid" , "pagepath" : "/index.html" "enable_id_trans" : 0 , "enable_duplicate_check" : 0 , "duplicate_check_interval" : 1800

    参数说明:

    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:template_card
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    card_type 模板卡片类型,文本通知型卡片填写 "text_notice"
    source 卡片来源样式信息,不需要来源样式可不填写
    source.icon_url 来源图片的url,来源图片的尺寸建议为72*72
    source.desc 来源图片的描述,建议不超过20个字, (支持id转译)
    source.desc_color 来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
    action_menu 卡片右上角更多操作按钮
    action_menu.desc 更多操作界面的描述
    action_menu.action_list 操作列表,列表长度取值范围为 [1, 3]
    action_menu.action_list.text 操作的描述文案
    action_menu.action_list.key 操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
    main_title.title 一级标题,建议不超过36个字,文本通知型卡片本字段非必填,但不可本字段和sub_title_text都不填, (支持id转译)
    main_title.desc 标题辅助信息,建议不超过44个字, (支持id转译)
    quote_area 引用文献样式
    quote_area.type 引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
    quote_area.url 点击跳转的url,quote_area.type是1时必填
    quote_area.appid 点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
    quote_area.pagepath 点击跳转的小程序的pagepath,quote_area.type是2时选填
    quote_area.title 引用文献样式的标题
    quote_area.quote_text 引用文献样式的引用文案
    emphasis_content 关键数据样式
    emphasis_content.title 关键数据样式的数据内容,建议不超过14个字
    emphasis_content.desc 关键数据样式的数据描述内容,建议不超过22个字
    sub_title_text 二级普通文本,建议不超过160个字, (支持id转译)
    horizontal_content_list 二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
    horizontal_content_list.type 链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
    horizontal_content_list.keyname 二级标题,建议不超过5个字
    horizontal_content_list.value 二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字, (支持id转译)
    horizontal_content_list.url 链接跳转的url,horizontal_content_list.type是1时必填
    horizontal_content_list.media_id 附件的media_id,horizontal_content_list.type是2时必填
    horizontal_content_list.userid 成员详情的userid,horizontal_content_list.type是3时必填
    jump_list 跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
    jump_list.type 跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
    jump_list.title 跳转链接样式的文案内容,建议不超过18个字
    jump_list.url 跳转链接的url,jump_list.type是1时必填
    jump_list.appid 跳转链接的小程序的appid,必须是与当前应用关联的小程序,jump_list.type是2时必填
    jump_list.pagepath 跳转链接的小程序的pagepath,jump_list.type是2时选填
    card_action 整体卡片的点击跳转事件,text_notice必填本字段
    card_action.type 跳转事件类型,1 代表跳转url,2 代表打开小程序。text_notice卡片模版中该字段取值范围为[1,2]
    card_action.url 跳转事件的url,card_action.type是1时必填
    card_action.appid 跳转事件的小程序的appid,必须是与当前应用关联的小程序,card_action.type是2时必填
    card_action.pagepath 跳转事件的小程序的pagepath,card_action.type是2时选填
    task_id 任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节,填了action_menu字段的话本字段必填
    enable_id_trans 表示是否开启id转译,0表示否,1表示是,默认0
    enable_duplicate_check 表示是否开启重复消息检查,0表示否,1表示是,默认0
    duplicate_check_interval 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

    图文展示型

    "touser" : "UserID1|UserID2|UserID3" , "toparty" : "PartyID1 | PartyID2" , "totag" : "TagID1 | TagID2" , "msgtype" : "template_card" , "agentid" : 1 , "template_card" : { "card_type" : "news_notice" , "source" : { "icon_url" : "图片的url" , "desc" : "企业微信" , "desc_color" : 1 "action_menu" : { "desc" : "卡片副交互辅助文本说明" , "action_list" : [ { "text" : "接受推送" , "key" : "A" } , { "text" : "不再推送" , "key" : "B" } "task_id" : "task_id" , "main_title" : { "title" : "欢迎使用企业微信" , "desc" : "您的好友正在邀请您加入企业微信" "quote_area" : { "type" : 1 , "url" : "https://work.weixin.qq.com" , "title" : "企业微信的引用样式" , "quote_text" : "企业微信真好用呀真好用" "image_text_area" : { "type" : 1 , "url" : "https://work.weixin.qq.com" , "title" : "企业微信的左图右文样式" , "desc" : "企业微信真好用呀真好用" , "image_url" : "https://img.iplaysoft.com/wp-content/uploads/2019/free-images/free_stock_photo_2x.jpg" "card_image" : { "url" : "图片的url" , "aspect_ratio" : 1.3 "vertical_content_list" : [ "title" : "惊喜红包等你来拿" , "desc" : "下载企业微信还能抢红包!" "horizontal_content_list" : [ "keyname" : "邀请人" , "value" : "张三" "type" : 1 , "keyname" : "企业微信官网" , "value" : "点击访问" , "url" : "https://work.weixin.qq.com" "type" : 2 , "keyname" : "企业微信下载" , "value" : "企业微信.apk" , "media_id" : "文件的media_id" "type" : 3 , "keyname" : "员工信息" , "value" : "点击查看" , "userid" : "zhangsan" "jump_list" : [ "type" : 1 , "title" : "企业微信官网" , "url" : "https://work.weixin.qq.com" "type" : 2 , "title" : "跳转小程序" , "appid" : "小程序的appid" , "pagepath" : "/index.html" "card_action" : { "type" : 2 , "url" : "https://work.weixin.qq.com" , "appid" : "小程序的appid" , "pagepath" : "/index.html" "enable_id_trans" : 0 , "enable_duplicate_check" : 0 , "duplicate_check_interval" : 1800
    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:template_card
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    card_type 模板卡片类型,图文展示型卡片此处填写 "news_notice"
    source 卡片来源样式信息,不需要来源样式可不填写
    source.icon_url 来源图片的url,来源图片的尺寸建议为72*72
    source.desc 来源图片的描述,建议不超过20个字, (支持id转译)
    source.desc_color 来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
    action_menu 卡片右上角更多操作按钮
    action_menu.desc 更多操作界面的描述
    action_menu.action_list 操作列表,列表长度取值范围为 [1, 3]
    action_menu.action_list.text 操作的描述文案
    action_menu.action_list.key 操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
    main_title.title 一级标题,建议不超过36个字, (支持id转译)
    main_title.desc 标题辅助信息,建议不超过44个字, (支持id转译)
    quote_area 引用文献样式
    quote_area.type 引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
    quote_area.url 点击跳转的url,quote_area.type是1时必填
    quote_area.appid 点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
    quote_area.pagepath 点击跳转的小程序的pagepath,quote_area.type是2时选填
    quote_area.title 引用文献样式的标题
    quote_area.quote_text 引用文献样式的引用文案
    image_text_area 左图右文样式,news_notice类型的卡片,card_image和image_text_area两者必填一个字段,不可都不填
    image_text_area.type 左图右文样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
    image_text_area.url 点击跳转的url,image_text_area.type是1时必填
    image_text_area.appid 点击跳转的小程序的appid,必须是与当前应用关联的小程序,image_text_area.type是2时必填
    image_text_area.pagepath 点击跳转的小程序的pagepath,image_text_area.type是2时选填
    image_text_area.title 左图右文样式的标题
    image_text_area.desc 左图右文样式的描述
    image_text_area.image_url 左图右文样式的图片url
    card_image 图片样式,news_notice类型的卡片,card_image和image_text_area两者必填一个字段,不可都不填
    card_image.url 图片的url
    card_image.aspect_ratio 图片的宽高比,宽高比要小于2.25,大于1.3,不填该参数默认1.3
    vertical_content_list 卡片二级垂直内容,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过4
    vertical_content_list.title 卡片二级标题,建议不超过38个字
    vertical_content_list.desc 二级普通文本,建议不超过160个字
    horizontal_content_list 二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
    horizontal_content_list.type 链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
    horizontal_content_list.keyname 二级标题,建议不超过5个字
    horizontal_content_list.value 二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字, (支持id转译)
    horizontal_content_list.url 链接跳转的url,horizontal_content_list.type是1时必填
    horizontal_content_list.media_id 附件的media_id,horizontal_content_list.type是2时必填
    horizontal_content_list.userid 成员详情的userid,horizontal_content_list.type是3时必填
    jump_list 跳转指引样式的列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过3
    jump_list.type 跳转链接类型,0或不填代表不是链接,1 代表跳转url,2 代表跳转小程序
    jump_list.title 跳转链接样式的文案内容,建议不超过18个字
    jump_list.url 跳转链接的url,jump_list.type是1时必填
    jump_list.appid 跳转链接的小程序的appid,必须是与当前应用关联的小程序,jump_list.type是2时必填
    jump_list.pagepath 跳转链接的小程序的pagepath,jump_list.type是2时选填
    card_action 整体卡片的点击跳转事件,news_notice必填本字段
    card_action.type 跳转事件类型,1 代表跳转url,2 代表打开小程序。news_notice卡片模版中该字段取值范围为[1,2]
    card_action.url 跳转事件的url,card_action.type是1时必填
    card_action.appid 跳转事件的小程序的appid,必须是与当前应用关联的小程序,card_action.type是2时必填
    card_action.pagepath 跳转事件的小程序的pagepath,card_action.type是2时选填
    task_id 任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节,填了action_menu字段的话本字段必填
    enable_id_trans 表示是否开启id转译,0表示否,1表示是,默认0
    enable_duplicate_check 表示是否开启重复消息检查,0表示否,1表示是,默认0
    duplicate_check_interval 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

    按钮交互型

    "touser" : "UserID1|UserID2|UserID3" , "toparty" : "PartyID1 | PartyID2" , "totag" : "TagID1 | TagID2" , "msgtype" : "template_card" , "agentid" : 1 , "template_card" : { "card_type" : "button_interaction" , "source" : { "icon_url" : "图片的url" , "desc" : "企业微信" , "desc_color" : 1 "action_menu" : { "desc" : "卡片副交互辅助文本说明" , "action_list" : [ { "text" : "接受推送" , "key" : "A" } , { "text" : "不再推送" , "key" : "B" } "main_title" : { "title" : "欢迎使用企业微信" , "desc" : "您的好友正在邀请您加入企业微信" "quote_area" : { "type" : 1 , "url" : "https://work.weixin.qq.com" , "title" : "企业微信的引用样式" , "quote_text" : "企业微信真好用呀真好用" "sub_title_text" : "下载企业微信还能抢红包!" , "horizontal_content_list" : [ "keyname" : "邀请人" , "value" : "张三" "type" : 1 , "keyname" : "企业微信官网" , "value" : "点击访问" , "url" : "https://work.weixin.qq.com" "type" : 2 , "keyname" : "企业微信下载" , "value" : "企业微信.apk" , "media_id" : "文件的media_id" "type" : 3 , "keyname" : "员工信息" , "value" : "点击查看" , "userid" : "zhangsan" "card_action" : { "type" : 2 , "url" : "https://work.weixin.qq.com" , "appid" : "小程序的appid" , "pagepath" : "/index.html" "task_id" : "task_id" , "button_selection" : { "question_key" : "btn_question_key1" , "title" : "企业微信评分" , "option_list" : [ "id" : "btn_selection_id1" , "text" : "100分" "id" : "btn_selection_id2" , "text" : "101分" "selected_id" : "btn_selection_id1" "button_list" : [ "text" : "按钮1" , "style" : 1 , "key" : "button_key_1" "text" : "按钮2" , "style" : 2 , "key" : "button_key_2" "enable_id_trans" : 0 , "enable_duplicate_check" : 0 , "duplicate_check_interval" : 1800
    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:template_card
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    card_type 模板卡片类型,按钮交互型卡片填写"button_interaction"
    source 卡片来源样式信息,不需要来源样式可不填写
    source.icon_url 来源图片的url,来源图片的尺寸建议为72*72
    source.desc 来源图片的描述,建议不超过20个字, (支持id转译)
    source.desc_color 来源文字的颜色,目前支持:0(默认) 灰色,1 黑色,2 红色,3 绿色
    action_menu 卡片右上角更多操作按钮
    action_menu.desc 更多操作界面的描述
    action_menu.action_list 操作列表,列表长度取值范围为 [1, 3]
    action_menu.action_list.text 操作的描述文案
    action_menu.action_list.key 操作key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复
    main_title.title 一级标题,建议不超过36个字, (支持id转译)
    main_title.desc 标题辅助信息,建议不超过44个字, (支持id转译)
    quote_area 引用文献样式
    quote_area.type 引用文献样式区域点击事件,0或不填代表没有点击事件,1 代表跳转url,2 代表跳转小程序
    quote_area.url 点击跳转的url,quote_area.type是1时必填
    quote_area.appid 点击跳转的小程序的appid,必须是与当前应用关联的小程序,quote_area.type是2时必填
    quote_area.pagepath 点击跳转的小程序的pagepath,quote_area.type是2时选填
    quote_area.title 引用文献样式的标题
    quote_area.quote_text 引用文献样式的引用文案
    sub_title_text 二级普通文本,建议不超过160个字, (支持id转译)
    horizontal_content_list 二级标题+文本列表,该字段可为空数组,但有数据的话需确认对应字段是否必填,列表长度不超过6
    horizontal_content_list.type 链接类型,0或不填代表不是链接,1 代表跳转url,2 代表下载附件,3 代表点击跳转成员详情
    horizontal_content_list.keyname 二级标题,建议不超过5个字
    horizontal_content_list.value 二级文本,如果horizontal_content_list.type是2,该字段代表文件名称(要包含文件类型),建议不超过30个字, (支持id转译)
    horizontal_content_list.url 链接跳转的url,horizontal_content_list.type是1时必填
    horizontal_content_list.media_id 附件的media_id,horizontal_content_list.type是2时必填
    horizontal_content_list.userid 成员详情的userid,horizontal_content_list.type是3时必填
    card_action 整体卡片的点击跳转事件
    card_action.type 跳转事件类型,0或不填代表不是链接,1 代表跳转url,2 代表打开小程序
    card_action.url 跳转事件的url,card_action.type是1时必填
    card_action.appid 跳转事件的小程序的appid,必须是与当前应用关联的小程序,card_action.type是2时必填
    card_action.pagepath 跳转事件的小程序的pagepath,card_action.type是2时选填
    task_id 任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节
    button_selection.question_key 下拉式的选择器的key,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节
    button_selection.title 下拉式的选择器左边的标题
    button_selection.option_list 选项列表,下拉选项不超过 10 个,最少1个
    button_selection.selected_id 默认选定的id,不填或错填默认第一个
    button_selection.option_list.id 下拉式的选择器选项的id,用户提交后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
    button_selection.option_list.text 下拉式的选择器选项的文案,建议不超过16个字
    button_list 按钮列表,列表长度不超过6
    button_list.type 按钮点击事件类型,0 或不填代表回调点击事件,1 代表跳转url
    button_list.text 按钮文案,建议不超过10个字
    button_list.style 按钮样式,目前可填1~4,不填或错填默认1
    button_list.key 按钮key值,用户点击后,会产生回调事件将本参数作为EventKey返回,回调事件会带上该key值,最长支持1024字节,不可重复,button_list.type是0时必填
    button_list.url 跳转事件的url,button_list.type是1时必填

    备注:
    按钮样式

    投票选择型

    "touser" : "UserID1|UserID2|UserID3" , "toparty" : "PartyID1 | PartyID2" , "totag" : "TagID1 | TagID2" , "msgtype" : "template_card" , "agentid" : 1 , "template_card" : { "card_type" : "vote_interaction" , "source" : { "icon_url" : "图片的url" , "desc" : "企业微信" "main_title" : { "title" : "欢迎使用企业微信" , "desc" : "您的好友正在邀请您加入企业微信" "task_id" : "task_id" , "checkbox" : { "question_key" : "question_key1" , "option_list" : [ "id" : "option_id1" , "text" : "选择题选项1" , "is_checked" : true "id" : "option_id2" , "text" : "选择题选项2" , "is_checked" : false "mode" : 1 "submit_button" : { "text" : "提交" , "key" : "key" "enable_id_trans" : 0 , "enable_duplicate_check" : 0 , "duplicate_check_interval" : 1800

    参数说明:

    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:template_card
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    card_type 模板卡片类型,投票选择型卡片填写"vote_interaction"
    source 卡片来源样式信息,不需要来源样式可不填写
    source.icon_url 来源图片的url,来源图片的尺寸建议为72*72
    source.desc 来源图片的描述,建议不超过20个字, (支持id转译)
    main_title.title 一级标题,建议不超过16个字, (支持id转译)
    main_title.desc 二级普通文本,建议不超过160个字, (支持id转译)
    task_id 任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节
    checkbox 选择题样式
    checkbox.question_key 选择题key值,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节
    checkbox.mode 选择题模式,单选:0,多选:1,不填默认0
    checkbox.option_list 选项list,选项个数不超过 20 个,最少1个
    checkbox.option_list.id 选项id,用户提交选项后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
    checkbox.option_list.text 选项文案描述,建议不超过17个字
    checkbox.option_list.is_checked 该选项是否要默认选中
    submit_button 提交按钮样式
    submit_button.text 按钮文案,建议不超过10个字,不填默认为提交
    submit_button.key 提交按钮的key,会产生回调事件将本参数作为EventKey返回,最长支持1024字节
    enable_id_trans 表示是否开启id转译,0表示否,1表示是,默认0
    enable_duplicate_check 表示是否开启重复消息检查,0表示否,1表示是,默认0
    duplicate_check_interval 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

    多项选择型

    "touser" : "UserID1|UserID2|UserID3" , "toparty" : "PartyID1 | PartyID2" , "totag" : "TagID1 | TagID2" , "msgtype" : "template_card" , "agentid" : 1 , "template_card" : { "card_type" : "multiple_interaction" , "source" : { "icon_url" : "图片的url" , "desc" : "企业微信" "main_title" : { "title" : "欢迎使用企业微信" , "desc" : "您的好友正在邀请您加入企业微信" "task_id" : "task_id" , "select_list" : [ "question_key" : "question_key1" , "title" : "选择器标签1" , "selected_id" : "selection_id1" , "option_list" : [ "id" : "selection_id1" , "text" : "选择器选项1" "id" : "selection_id2" , "text" : "选择器选项2" "question_key" : "question_key2" , "title" : "选择器标签2" , "selected_id" : "selection_id3" , "option_list" : [ "id" : "selection_id3" , "text" : "选择器选项3" "id" : "selection_id4" , "text" : "选择器选项4" "submit_button" : { "text" : "提交" , "key" : "key" "enable_id_trans" : 0 , "enable_duplicate_check" : 0 , "duplicate_check_interval" : 1800

    参数说明:

    参数 是否必须 说明
    touser 成员ID列表(消息接收者,多个接收者用‘|’分隔,最多支持1000个)。特殊情况:指定为@all,则向关注该企业应用的全部成员发送
    toparty 部门ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    totag 标签ID列表,多个接收者用‘|’分隔,最多支持100个。当touser为@all时忽略本参数
    msgtype 消息类型,此时固定为:template_card
    agentid 企业应用的id,整型。企业内部开发,可在应用的设置页面查看;第三方服务商,可通过接口 获取企业授权信息 获取该参数值
    card_type 模板卡片类型,多项选择型卡片填写 "multiple_interaction"
    source 卡片来源样式信息,不需要来源样式可不填写
    source.icon_url 来源图片的url,来源图片的尺寸建议为72*72
    source.desc 来源图片的描述,建议不超过20个字, (支持id转译)
    main_title.title 一级标题,建议不超过36个字, (支持id转译)
    main_title.desc 标题辅助信息,建议不超过160个字, (支持id转译)
    task_id 任务id,同一个应用任务id不能重复,只能由数字、字母和“_-@”组成,最长128字节
    select_list 下拉式的选择器列表,multiple_interaction类型的卡片该字段不可为空,一个消息最多支持 3 个选择器
    select_list.question_key 下拉式的选择器题目的key,用户提交选项后,会产生回调事件,回调事件会带上该key值表示该题,最长支持1024字节,不可重复
    select_list.title 下拉式的选择器上面的title
    select_list.option_list 选项列表,下拉选项不超过 10 个,最少1个
    select_list.selected_id 默认选定的id,不填或错填默认第一个
    select_list.option_list.id 下拉式的选择器选项的id,用户提交选项后,会产生回调事件,回调事件会带上该id值表示该选项,最长支持128字节,不可重复
    select_list.option_list.text 下拉式的选择器选项的文案,建议不超过16个字
    submit_button 提交按钮样式
    submit_button.text 按钮文案,建议不超过10个字,不填默认为提交
    submit_button.key 提交按钮的key,会产生回调事件将本参数作为EventKey返回,最长支持1024字节
    enable_id_trans 表示是否开启id转译,0表示否,1表示是,默认0
    enable_duplicate_check 表示是否开启重复消息检查,0表示否,1表示是,默认0
    duplicate_check_interval 表示是否重复消息检查的时间间隔,默认1800s,最大不超过4小时

    附录

    支持的markdown语法

    目前应用消息中支持的markdown语法是如下的子集:

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

    id转译说明

    1.支持的消息类型和对应的字段