参数说明:
- 各个消息类型的具体POST格式请阅后续“消息类型”部分。
- 如果有在管理端对应用设置“在微工作台中始终进入主页”,应用在微信端只能接收到文本消息,并且文本消息的长度限制为20字节,超过20字节会被截断。同时其他消息类型也会转换为文本消息,提示用户到企业微信查看。
- 支持id转译,将userid/部门id转成对应的用户名/部门名,在企业授权了会话内容存档接口权限时,也可以将消息id和群id转成对应的消息内容/群名称,目前仅 文本/文本卡片/图文/图文(mpnews)/任务卡片/小程序通知/模版消息/模板卡片消息这八种消息类型的 部分字段支持。具体支持的范围和语法,请查看附录id转译说明。
- 支持重复消息检查,当指定 开启: 表示在一定时间间隔内,同样内容(请求json)的消息,不会重复收到;时间间隔可通过指定,默认。
- 从2021年2月4日开始,企业关联添加的「小程序」应用,也可以发送文本、图片、视频、文件、图文等各种类型的消息了。
调用建议:大部分企业应用在每小时的0分或30分触发推送消息,容易造成资源挤占,从而投递不够及时,建议尽量避开这两个时间点进行调用。
频率限制:每应用不可超过账号上限数*200人次/天(注:若调用api一次发给1000人,算1000人次;若企业账号上限是500人,则每个应用每天可发送人次的消息)。每应用对同一个成员不可超过30次/分钟,1000次/小时,超过部分会被丢弃不下发
返回示例:
</div><blockquote data-sign="e1caa8c7249fcd38c23cd_4" data-lines="4">如果部分接收人无权限或不存在,发送仍然执行,但会返回无效的部分(即invaliduser或invalidparty或invalidtag或unlicenseduser),常见的原因是<strong>接收人不在应用的可见范围内</strong>。<br>权限包含<strong>应用可见范围</strong>和<strong>基础接口权限</strong>(基础账号、互通账号均可),unlicenseduser中的用户在应用可见范围内但没有基础接口权限。<br>如果<strong>全部</strong>接收人无权限或不存在,则本次调用返回失败,errcode为81013。<br>返回包中的userid,不区分大小写,统一转为小写</blockquote><p data-sign="br2" data-type="br" data-lines="2"> </p><p data-sign="ad759d87b8cb9a916b94e12c82e1e8e6" data-type="p" data-lines="2"> <strong>参数说明:</strong><br> </p><p data-sign="fa377d970a64d86d33472be9bf" data-type="p" data-lines="1"> <strong>请求示例:</strong></p><div data-sign="ad5d894bbce5aa11a19c8642f47bca11" data-type="codeBlock" data-lines="17"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><blockquote data-sign="6677a8f14e14c5e8dcec99727_2" data-lines="2"><font color="red">touser、toparty、totag不能同时为空</font>,后面不再强调。</blockquote><p data-sign="02b467e4acf34edaeacb98bb84931fd4" data-type="p" data-lines="3"><strong>文本消息展现:</strong><br><img src="https://res.mail..com/node/ww/wwopenmng/images/independent/doc/test_msg$5bc63c26.png" style="width:360px;"></p><p data-sign="9bc40854bfe8db70552e2ad32d0330e7" data-type="p" data-lines="3"><strong>特殊说明:</strong><br>其中text参数的content字段可以支持换行、以及A标签,即可打开自定义的网页(可参考以上示例代码)(注意:换行符请用转义过的
讯享网
)
请求示例:
讯享网</div><p data-sign="25dcd258c66e39f907f7c7cc33" data-type="p" data-lines="2"><strong>请求参数:</strong></p><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="1"><strong>请求示例:</strong></p><div data-sign="bb706ed4cfc5493f5d84de4168" data-type="codeBlock" data-lines="15"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="1"><strong>请求示例:</strong></p><div data-sign="9ef4de4bfa63fd0" data-type="codeBlock" data-lines="18"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="6fbb1f62e6f26e4f2a8fcafa4d" data-type="p" data-lines="3"> <br><strong>视频消息展现:</strong><br><img src="https://p.qpic.cn/pic_wework//9d9bdfdd1d95e8ddddfc0f3/0" style="width:360px;"></p><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="1"><strong>请求示例:</strong></p><div data-sign="12fb40bfc24df24927" data-type="codeBlock" data-lines="16"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="fbed61f8d47cfaedb1403fb21" data-type="p" data-lines="4"> <br><strong>文件消息展现:</strong><br><img src="https://res.mail..com/node/ww/wwopenmng/images/independent/doc/filemsg.jpeg" style="width:360px;"></p><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="1"><strong>请求示例:</strong></p><div data-sign="e6fdbda154edf31997" data-type="codeBlock" data-lines="19"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="f69f0eff42612fa9a2cceeb3ca" data-type="p" data-lines="3"><strong>文本卡片消息展现 :</strong><br><img src="https://res.mail..com/node/ww/wwopenmng/images/independent/doc/cardmsg.jpeg" style="width:360px"></p><p data-sign="01e18575cce47d23d48de0a" data-type="p" data-lines="3"><strong>特殊说明</strong>:<br>卡片消息的展现形式非常灵活,支持使用br标签或者空格来进行换行处理,也支持使用div标签来使用不同的字体颜色,目前内置了3种文字颜色:灰色(gray)、高亮(highlight)、默认黑色(normal),将其作为div标签的class属性即可,具体用法请参考上面的示例。</p><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="1"><strong>请求示例:</strong></p><div data-sign="c92eeff7944bf599bc" data-type="codeBlock" data-lines="25"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="e19be9380de5eec74047fe2fdee83f12" data-type="p" data-lines="3"> <br><strong>图文消息展现:</strong><br><img src="https://p.qpic.cn/pic_wework//7a7c92760b2bd396e3b856a660f43c8b7db11271bddb3f34/0" style="width:360px;"></p><blockquote data-sign="1b89452dab3299ed6f30cde4_1" data-lines="1">mpnews类型的图文消息,跟普通的图文消息一致,唯一的差异是图文内容存储在企业微信。<br>多次发送mpnews,会被认为是不同的图文,阅读、点赞的统计会被分开计算。</blockquote><p data-sign="br2" data-type="br" data-lines="2"> </p><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="1"><strong>请求示例:</strong></p><div data-sign="01075ed28b2a8b08fb63a764e8727d76" data-type="codeBlock" data-lines="27"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><blockquote data-sign="ad672ca9dafe9bddf2cad1f_1" data-lines="1">目前仅支持markdown语法的子集<br>微工作台(原企业号)不支持展示markdown消息</blockquote><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="2"><strong>请求示例:</strong></p><div data-sign="e6c7548dc421aec050307dfa35321e0f" data-type="codeBlock" data-lines="15"> </div><p data-sign="72e2aa93d867e3bec00806cc752fde42" data-type="p" data-lines="2"><strong>示例效果:</strong><br><img src="https://p.qpic.cn/pic_wework//dddbcdd097e5fcd7f99e0ebbb9348c4ec/0" alt=""></p><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="br2" data-type="br" data-lines="2"> </p><blockquote data-sign="d5eb0fa21c02c14c7338f033ddc9ecf0_3" data-lines="3">小程序通知消息只允许绑定了小程序的应用发送,<del>之前,消息会通过统一的会话【小程序通知】发送给用户</del>。<br>从2019年6月28日起,用户收到的小程序通知会出现在各个独立的应用中。<br>不支持@all全员发送<br>微工作台(原企业号)不支持展示小程序通知消息</blockquote><p data-sign="0eaf88df03cdd00af1ca68a35" data-type="p" data-lines="1"><strong>请求示例:</strong></p><div data-sign="9ad8993c933bb850c5861b8fdd0e2366" data-type="codeBlock" data-lines="36"> </div><p data-sign="ac9c6402d908f541c1d1d9667fde5334" data-type="p" data-lines="2"><strong>示例效果:</strong><br><img src="https://p.qpic.cn/pic_wework//c4c2b9c84342e6ef5f62bbace170e85d7a5c58779bc60fc4/0" alt=""></p><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="br4" data-type="br" data-lines="4"> </p><p data-sign="972c590dce97f2d1210aaf725ff09c82" data-type="p" data-lines="1"></p><blockquote data-sign="bb8dd20c8acf413f43dfc3c341_2" data-lines="2">投票选择型和多项选择型卡片仅企业微信3.1.12及以上版本支持<br>文本通知型、图文展示型和按钮交互型三种卡片仅企业微信3.1.6及以上版本支持(但附件下载功能仍需更新至3.1.12)<br>微工作台(原企业号)不支持展示模板卡片消息</blockquote><p data-sign="24e3175e559a614cb8705f8442e1635d" data-type="p" data-lines="1"><strong>3.1.18版本新增</strong></p><p data-sign="f34ec67df7422dc25a423febf" data-type="p" data-lines="1"><strong>特殊说明</strong></p><h4 id="%E6%96%87%E6%9C%AC%E9%80%9A%E7%9F%A5%E5%9E%8B" data-sign="6e3a23a962ac4494f39c188cbfa2ed06" data-lines="2">文本通知型</h4><p data-sign="a8fe0599a4e4574e1dc3b274" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_QOJtTyeUTBuAk_G_/0" style="width:640px;"></p><div data-sign="180a2f92c3e369e1a8211f09119c5a76" data-type="codeBlock" data-lines="87"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><h4 id="%E5%9B%BE%E6%96%87%E5%B1%95%E7%A4%BA%E5%9E%8B" data-sign="3e411b0a39305f6347d87eb1b08f5b3c" data-lines="2">图文展示型</h4><p data-sign="4a9ca2ce8d1ae6be9a5331fe9c9e7e6e" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/93182_HHrOrbdjTNW9ieM_/0" style="width:640px;"></p><div data-sign="0371b819cebeeefe5d3a662ef" data-type="codeBlock" data-lines="99"> </div><h4 id="%E6%8C%89%E9%92%AE%E4%BA%A4%E4%BA%92%E5%9E%8B" data-sign="3506a358c876cc16a8ea18" data-lines="2">按钮交互型</h4><p data-sign="9ba9ffca234a6eb48426ce716a" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_wYaFgfHsRIOPzL1_/0" style="width:640px;"></p><div data-sign="b31db02c155c43c26e6762ee201bb054" data-type="codeBlock" data-lines="97"> </div><p data-sign="b14a02f4fe2fd0291c42fd924e058aa7" data-type="p" data-lines="4">备注:<br>按钮样式<br><br><img src="https://wework.qpic.cn/wwpic/_iKxTyYPiRBamTcX_/0" width="360/"></p><h4 id="%E6%8A%95%E7%A5%A8%E9%80%89%E6%8B%A9%E5%9E%8B" data-sign="cadb6758d586b82ee0e53ba0" data-lines="2">投票选择型</h4><p data-sign="51a78935c06d3b2a1ebe93d018b0565b" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_UiGowMtcSD-EyEq_/0" style="width:640px;"></p><div data-sign="91deb426a2e7c7aa949f637de44dd6f7" data-type="codeBlock" data-lines="45"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><h4 id="%E5%A4%9A%E9%A1%B9%E9%80%89%E6%8B%A9%E5%9E%8B" data-sign="c2053dbea5b37230d2d9c2176" data-lines="2">多项选择型</h4><p data-sign="30bd0054b4c1f5393f25cd46b29e492d" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_JDisThiPRXam-GG_/0" style="width:640px;"></p><div data-sign="710f47bf6a6b2185de43485e3ed1f8ea" data-type="codeBlock" data-lines="61"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="bab38e2d869bd7253f8da" data-type="p" data-lines="1">目前应用消息中支持的markdown语法是如下的子集:</p><p data-sign="334a5096ed383bb536e3eca36acc6c71" data-type="p" data-lines="1">1.支持的消息类型和对应的字段</p><p data-sign="c0b868f3e8315a2ba786a8d93" data-type="p" data-lines="2">2.id转译模版语法</p><div data-sign="0d0e2d06a4ecc0f7c8072fcbc5" data-type="codeBlock" data-lines="7"> </div><p data-sign="bb2be820de8dbfaf" data-type="p" data-lines="6">其中 DEPARTMENT_ID 是数字类型的部门id,USERID 是成员账号。<br>譬如,<br>将替换成部门id为对应的部门名,如“企业微信部”;<br>将替换成userid为对应的用户姓名,如“李四”;<br>将替换成userid为对应的用户别名,如“lisi”;<br>将替换成userid为对应的用户别名或姓名,别名优先级高于姓名,如"lisi";</p><blockquote data-sign="afd108f80188a353bf1b7f79a0d0a2f4_2" data-lines="2">若输入的模板不符合语法、不在权限范围内或无效的userid或者部门ID,则不替换该项内容,保留原样<br>转译userAlias时,如果用户没有别名,则不替换该项内容,保留原样<br>转译userAliasOrName时,如果用户有别名,则替换为别名;否则,将替换为姓名</blockquote><p data-sign="3beb967e5467cfaab10b63b8fb10c884" data-type="p" data-lines="1">在<strong>企业授权了会话内容存档接口权限</strong>时,也支持转译消息内容和群聊名称,语法如下:</p><div data-sign="6f4f48a56ab6ade6d0a378d38" data-type="codeBlock" data-lines="5"> </div><p data-sign="b1aade75ec89a87d5baf7c" data-type="p" data-lines="4">譬如,<br>将替换成群聊ID为对应的群聊名称;<br>将替换成消息ID为对应的消息内容,其中获取会话记录接口返回的这条消息对应的 encrypted_secretkey 字段进行解密得到的密钥为;<br>将 替换成客户ID为 对应的客户名称;</p><blockquote data-sign="8acdd76a8f0ab0a1ccaeab1e9b_3" data-lines="3">若输入的模板不符合语法、群聊ID无效、消息ID无效或对应的密钥不正确,则不替换该项内容,保留原样<br>当企业没有授权会话内容存档接口权限是,也不替换该项内容,保留原样<br>为防止意外泄漏,消息ID转译失败的情况下,将只会展示MSGID部分的内容,SECRET-KEY部分的内容不会展示</blockquote><p data-sign="8946ae0c38fd00935dd9136b" data-type="p" data-lines="7">群聊ID<br>支持转译内部群和外部群的名称;<br>不包括单聊;<br>对于无名称的企业内部群聊,展示为;<br>对于无名称的企业客户群聊,展示为;<br>对于非企业客户群,展示为。。</p><p data-sign="b801b5e3b63771f12ccc720b3dbb6882" data-type="p" data-lines="1">消息ID</p><blockquote data-sign="d3391a3fbfa4ae680a19953f8fe21654_3" data-lines="3">其他特殊情况转译结果说明:<br>企微后台系统失败->消息获取失败<br>msgid不存在或者过期->消息已过期,消息内容无法展示<br>SECRET-KEY错误->消息密钥错误</blockquote>
应用可以发送模板卡片消息,发送之后可再通过接口更新可回调的用户任务卡片消息的替换文案信息(仅原卡片为 按钮交互型、投票选择型、多项选择型的卡片以及填写了action_menu字段的文本通知型、图文展示型可以调用本接口更新)。
参数说明:
请求示例:
仅原卡片为 按钮交互型、投票选择型、多项选择型的卡片可以更新按钮,可以将按钮更新为不可点击状态,并且自定义文案
</div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="be4df1ea25f0489f753bbb85b0d2cb6e" data-type="p" data-lines="1">可回调的卡片可以更新成任何一种模板卡片</p><p data-sign="a8fe0599a4e4574e1dc3b274" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_QOJtTyeUTBuAk_G_/0" style="width:640px;"></p><div data-sign="eb5296cc9e84169aff58fe9f6d" data-type="codeBlock" data-lines="83"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="4a9ca2ce8d1ae6be9a5331fe9c9e7e6e" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/93182_HHrOrbdjTNW9ieM_/0" style="width:640px;"></p><div data-sign="9478c2eab6cedc39bc84aed1cc15d685" data-type="codeBlock" data-lines="96"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="9ba9ffca234a6eb48426ce716a" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_wYaFgfHsRIOPzL1_/0" style="width:640px;"></p><div data-sign="1d25955cd95d12a206b3b130a811b2ab" data-type="codeBlock" data-lines="95"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="c5a0cfe0463aa2cc8" data-type="p" data-lines="4">备注:<br>按钮样式<br><img src="https://wework.qpic.cn/wwpic/_DpCjnJFpSGuTG_q_/0" style="width:360px;"></p><p data-sign="51a78935c06d3b2a1ebe93d018b0565b" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_UiGowMtcSD-EyEq_/0" style="width:640px;"></p><div data-sign="9f65b5cb9eba963bf0060ea58" data-type="codeBlock" data-lines="43"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="br2" data-type="br" data-lines="2"> </p><p data-sign="30bd0054b4c1f5393f25cd46b29e492d" data-type="p" data-lines="2"><img src="https://wework.qpic.cn/wwpic/_JDisThiPRXam-GG_/0" style="width:640px;"></p><div data-sign="707b2f843e21a2eaff40668ae" data-type="codeBlock" data-lines="62"> </div><p data-sign="f2ecadd2d5b0f8a3eedbae8d" data-type="p" data-lines="2"><strong>参数说明:</strong></p><p data-sign="br2" data-type="br" data-lines="2"> </p><p data-sign="cc39e7d843cf38f5c4bc1ce95b65cf90" data-type="p" data-lines="2"> <strong>返回示例:</strong><br> </p><div data-sign="74eda48922b8f9af253fdd7de6768d30" data-type="codeBlock" data-lines="7"> </div><blockquote data-sign="9d7340ac404ef73edcfada3a7105e836_2" data-lines="2">如果部分指定的用户无权限或不存在,更新仍然执行,但会返回无效的部分(即invaliduser),常见的原因是<strong>用户不在应用的可见范围内或者不在消息的接收范围内</strong>。</blockquote>

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容,请联系我们,一经查实,本站将立刻删除。
如需转载请保留出处:https://51itzy.com/kjqy/207938.html