news 2026/8/8 13:23:45

消息推送 API 的 Payload 构造与格式要求:支持富文本与卡片消息

作者头像

张小明

前端开发工程师

1.2k 24
文章封面图
消息推送 API 的 Payload 构造与格式要求:支持富文本与卡片消息

一、核心 API 接口与请求结构

实现向外部群(客户群)发送消息的核心接口是:

  • API 接口:POST /cgi-bin/appchat/send

  • 用途:应用向群聊发送消息。

  • 身份:消息以应用的身份发送。

  • 请求主体 (Payload) 结构:必须是JSON 格式

1.1 基础 JSON Payload 结构

所有发送给群聊的消息 JSON 必须包含以下基础字段:

字段名类型描述
chatidstring目标群聊的 ID
msgtypestring消息类型,如textimagefilelink等。
safeint是否是保密消息,0(否) 或1(是)。建议保持0
消息内容对象object根据msgtype命名的对象,包含消息的具体内容。

二、Payload 构造详解:主流消息类型

根据msgtype的不同,消息的具体内容对象(如text,image,link)的结构也不同。

2.1 文本消息 (msgtype: "text")

这是最简单也是最常用的消息类型。

字段名类型描述
text.contentstring消息文本。支持 2048 字节,超过会被截断。

JSON 示例 (文本消息):

JSON

{ "chatid": "wrU123456789", "msgtype": "text", "text": { "content": "📢 尊敬的客户,本周特惠产品已更新,请点击链接查看详情!" } }

2.2 图片消息 (msgtype: "image")

用于发送图片。消息主体中不能直接发送图片文件,必须提供一个已上传至企业微信的媒体 ID

字段名类型描述
image.media_idstring图片的临时素材 ID。必须通过媒体上传接口事先获取。

JSON 示例 (图片消息):

{ "chatid": "wrU123456789", "msgtype": "image", "image": { "media_id": "3M0uW32r2_P6_v4V04_X5u6F7I8T9N0K1L2J3H4G5F6E" } }

2.3 文件消息 (msgtype: "file")

用于发送 PDF、Excel 等文件。与图片消息类似,需要提供媒体 ID

字段名类型描述
file.media_idstring文件的临时素材 ID。通过媒体上传接口获取。

JSON 示例 (文件消息):

{ "chatid": "wrU123456789", "msgtype": "file", "file": { "media_id": "1V3uW12r2_P6_v4V04_X5u6F7I8T9N0K1L2J3H4G5F6E" } }

2.4 图文链接卡片消息 (msgtype: "link")

用于发送带有标题、描述和封面的外部链接,以卡片形式展示。

字段名类型描述
link.titlestring链接标题(必填)。
link.textstring链接描述。
link.picurlstring封面图片 URL
link.messageurlstring点击后跳转的 URL(必填)。

JSON 示例 (链接卡片):

{ "chatid": "wrU123456789", "msgtype": "link", "link": { "title": "🎉 2024 年终大促活动详情", "text": "点击查看所有产品的折扣力度和限时抢购时间表。", "picurl": "http://example.com/cover_image.jpg", "messageurl": "http://example.com/sale_details" } }

三、Payload 构造的注意事项

  1. 媒体 ID 的时效性:图片和文件使用的media_id有效期为 3 天(72 小时)。必须在有效期内使用。如果 ID 过期,需要重新上传获取新的 ID。

  2. JSON 编码:整个 Payload 必须进行正确的JSON 编码。任何特殊字符(如换行符、引号)必须被转义。

  3. URL 编码:在链接卡片中,messageurl字段的 URL 需确保已进行URL 编码,以防包含特殊字符。

  4. 字段校验:严格遵循企业微信 API 文档中对每个字段的长度和格式要求,缺失必填字段字段格式错误会导致 API 返回错误。例如,文本内容不能超过 2048 字节。

实施建议:客户联系功能启用步骤

操作步骤

  1. 权限申请
    请通过QiWe开放平台管理后台,提交“客户联系”功能的使用权限申请。
  2. 获取访问凭证
    请使用企业corpidcorpid(企业ID)和corpsecretcorpsecret(应用密钥)作为参数,调用相应接口以获取access_tokenaccess_token(访问令牌)。

目的

完成上述轻量级开发部署后,即可启用通过接口进行客户联系管理的能力。

版权声明: 本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若内容造成侵权/违法违规/事实不符,请联系邮箱:809451989@qq.com进行投诉反馈,一经查实,立即删除!
网站建设 2026/8/8 13:23:25

3分钟解锁MASA模组全家桶:中文界面让你从新手变专家

3分钟解锁MASA模组全家桶:中文界面让你从新手变专家 【免费下载链接】masa-mods-chinese 一个masa mods的汉化资源包 项目地址: https://gitcode.com/gh_mirrors/ma/masa-mods-chinese 还在为看不懂MASA模组的英文界面而烦恼吗?MASA模组汉化包正是…

作者头像 李华
网站建设 2026/8/8 13:22:51

鲸剪去重能过审吗,2026年视频去重工作流,5款对比横评

矩阵号发视频总被判重复,问题出在哪做短视频矩阵的同学,大概都经历过这种场景:同一套素材剪出 5–10 个版本分发,刚发布就提示「内容重复」「低质搬运」,流量直接被压。更头疼的是,单纯改分辨率、加个滤镜、…

作者头像 李华
网站建设 2026/8/8 13:21:52

Python虚拟环境管理:从Miniconda安装到实战避坑指南

1. 为什么你需要一个Python环境管理器? 如果你刚开始接触Python,或者已经写过一些脚本,大概率遇到过这样的场景:项目A需要 pandas 1.5.3 ,项目B却要求 pandas 2.0.0 ;好不容易装好了 TensorFlow &…

作者头像 李华
网站建设 2026/8/8 13:20:44

3分钟上手AutoLegalityMod:让宝可梦存档合法性验证变得简单高效

3分钟上手AutoLegalityMod:让宝可梦存档合法性验证变得简单高效 【免费下载链接】PKHeX-Plugins Plugins for PKHeX 项目地址: https://gitcode.com/gh_mirrors/pk/PKHeX-Plugins 还在为宝可梦存档的合法性验证而烦恼吗?AutoLegalityMod插件正是解…

作者头像 李华
网站建设 2026/8/8 13:17:17

基于TOP264vg的60W反激开关电源设计实战:从原理到PCB布局调试

1. 项目概述:从一颗芯片说起 最近在做一个工业控制板卡的项目,板子上需要给MCU、传感器和通讯模块提供多路隔离的直流电压。选型电源方案时,我再次把目光投向了Power Integrations(PI)的TOPSwitch系列,这次…

作者头像 李华