开放平台API

# 消息类型说明

# 概述

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：1 文字；2 图文链接； 3 图片 ；4 视频； 5语音 ；6 文件；7 好友名片；8 小程序；11 视频号消息；12 视频号直播消息；13 地理位置信息；17 任意位置@成员的文本消息；20 接龙消息； 注：普通图片（普通图片是指jpg、png等静态图片格式的 ）大小超过10M将以文件形式发送 ；GIF动图超过5M将以文件形式发送
msg_content string 否 消息内容，最长20000个字符。1.若是图片或者链接则传图片地址[链接的图片不宜过大，建议160x160px，小于10k])；2.若是语音,则传语音的地址（仅支持silk格式）（示例：http://downsc.chinaz.net/Files/DownLoadsound1/201910/12087.silk）；3.若是个人名片，则传被分享的好友编号；4.若是小程序，需是json格式文件，进行base64编码后传入；5.其中Windows扫码号发送视频消息时，视频封面图必传
voice_time int 否 语音时长/视频时长，时长单位：秒；必须 传时长且时长要正确，当时长不正确时可能会有很大的封禁风险
href string 否 当消息为图文链接或视频时，传入链接URL，视频格式限制为mp4；
当消息为文件时，此处传文件的链接地址；
title string 否 当消息为图文链接时，填写图文链接的标题；当消息为文件时，填写文件名；
desc string 否 当消息为图文链接时，填写图文链接的描述
at_location int 否 @人在文本的所在位置 0 文本开始位置 1文本结束位置 (目前不支持任意位置at)
at int 否 仅文本消息或空消息支持@人 (0 不@人 1 @所有人 2 @部分群成员)
at_contact_id_list array 否 at部分群成员时，必填

# 各种消息类型中，相关的字段说明，仅列出该消息类型下有效的字段

# 文本

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：1 文字；
msg_content string 是 消息内容，最长20000个字符。

# 群聊文本消息@相关字段

字段 类型 必填 说明
at_location int 否 @人在文本的所在位置 0 文本开始位置 1文本结束位置 (目前不支持任意位置艾特)
at int 否 仅文本消息或空消息支持@人 (0 不@人 1 @所有人 2 @部分群成员)
at_contact_id_list array 否 at部分群成员时，必填

# 图文链接

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 2 图文链接
msg_content string 是 传图片地址[链接的图片不宜过大，建议160x160px，小于10k])
href string 是 链接URL
title string 是 图文链接的标题
desc string 否 图文链接的描述

# 图片

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型： 3 图片 ；普通图片（普通图片是指jpg、png等静态图片格式的 ）大小超过10M将以文件形式发送 ；GIF动图超过5M将以文件形式发送
msg_content string 是 传图片地址[链接的图片不宜过大，建议160x160px，小于10k])；

# 视频

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：4 视频；
msg_content string 是 发送视频消息时，视频封面图必传
voice_time int 是 视频时长，时长单位：秒；必须 传时长且时长要正确，当时长不正确时可能会有很大的封禁风险
href string 是 视频的链接地址（目前视频仅支持MP4格式）， 视频最大时长不可超过30秒

# 语音

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型： 5语音
msg_content string 是 传语音的地址（示例：http://downsc.chinaz.net/Files/DownLoadsound1/201910/12087.silk）
voice_time int 是 语音时长，时长单位：秒；必须 传时长且时长要正确，当时长不正确时可能会有很大的封禁风险

# 文件

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：6 文件
title string 是 文件名（一定要带后缀名，否则无法识别文件类型 如：xx.pdf）
href string 是 传文件的链接地址

# 好友名片

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：7 好友名片
msg_content string 是 个人名片，则传被分享的好友编号（获取方式：通过企微给机器人转发名片，在回调事件里面获取）

# 小程序

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：8 小程序
msg_content string 是 小程序json进行base64编码后传入
href string 否 小程序封面图

小程序json示例

{
    "username": "gh_f9d9fca26a50@app",
    "appid": "",
    "pagepath": "pages/tabBar/index/index.html?sampshare=%7B%22i%22%3A%2210A64ACBD53245E4BEDBDE766EF430AD%22%2C%22p%22%3A%22pages%2FtabBar%2Findex%2Findex%22%2C%22d%22%3A0%2C%22m%22%3A%22%E8%BD%AC%E5%8F%91%E6%B6%88%E6%81%AF%E5%8D%A1%E7%89%87%22%7D",
    "weappIconUrl": "http://mmbiz.qpic.cn/mmbiz_png/CZGnVGInyCTf8yJuKOlHqKvqtFzOKeibXCBUdibDmPXS0pnCGib8J5QXoU2RbCXXVjj8DRs15Z7AfRKHlEdF27Zuw/640?wx_fmt=png&wxfrom=200",
    "title": "寄快递，用顺丰",
    "desc": "顺丰速运+",
    "appName": "顺丰速运+"
}

# 位置信息

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：13 地理位置
msg_content string 是 位置信息的json进行base64编码后传入

地理位置信息json示例

{
    "location_title": "瑞云水榭东南164米", // 地址标题
    "location_desc": "广东省湛江市赤坎区",// 详细地址
    "location_latitude": "21.258178", // 纬度
    "location_longitude": "110.350619"// 经度
}

# 视频号消息（仅部分版本支持）

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：11 视频号消息
msg_content string 是 视频号消息json格式文件进行base64编码后的内容

# 视频号直播 （仅部分版本支持）

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：12 视频号直播
msg_content string 是 视频号直播消息json格式文件进行base64编码后的内容

# 聊天记录消息 （暂不支持发送）

字段 类型 必填 说明
msg_num int 是 消息num，消息序号，按照序号顺序发送，在list里面唯一，最小值为1，以1为步长递增
msg_type int 是 消息类型：14 聊天记录
msg_content string 是 聊天记录json格式文件进行base64编码后的内容

聊天记录消息json示例

{
    "messages": [
        {
            "uin": "0", // 发送者编号
            "time": 1770792867,// 消息时间
            "contenttype": 2, //  //消息类型 0纯文本  1图片 2富文本   4转发 5视频 6定位  7图文  13链接 14图片 15文件 16语音 23视频  38卡片消息 41好友名片 78APP消息 101微信图片 102微信文件 123PC复合消息  141视频号 146视频号直播
            "name": "包谷", 
            "avatar_url": "https://wx.qlogo.cn/mmhead/ver_1/u6YCJXDvuFjfiaibVicianAfzGj6l5oqegvguubsYqPiaV6ngSwO5kh3zKNKFBOmKR49AraibXWLrWN81o0UAmsAUgvqd3Y7DsxaCuydvJgbFJ9TIBEQjVq2nmAZkwbZGlibJ62/132",
            "conv_type": 0, //是否群聊，1-是。0-否
            "sender_name": "包谷",//发送者名称
            "sender_avatar_url": "https://wx.qlogo.cn/mmhead/ver_1/u6YCJXDvuFjfiaibVicianAfzGj6l5oqegvguubsYqPiaV6ngSwO5kh3zKNKFBOmKR49AraibXWLrWN81o0UAmsAUgvqd3Y7DsxaCuydvJgbFJ9TIBEQjVq2nmAZkwbZGlibJ62/132", //发送者头像
            "corp_id": "1970325134026788", //发送者企业编号
            "corp_name": "", //发送者企业名称
            "opemim_wx_openid": "",
            "extra_datas": "qr4BVgogD+Ps94hU7fC9fpSxO8FEiicErn+57uQH7Ph9hEmFi/0QAhowCLrPsMwGEAIaACIECAAQACoTNjg5MTgzMDQ4MTg1NzM2NjY4NDC09cPonoCAAzgC",
            "exten": "CgwIABIICgblsIblhps=" // 消息内容
        },
        {
            "uin": "0",
            "time": 1770792870,
            "contenttype": 2,
            "name": "橘子",
            "avatar_url": "https://wework.qpic.cn/wwpic3az/925200_k0YgqerIQZqQdKZ_1742554668/140",
            "conv_type": 0,
            "sender_name": "橘子",
            "sender_avatar_url": "https://wework.qpic.cn/wwpic3az/925200_k0YgqerIQZqQdKZ_1742554668/140",
            "corp_name": "广州唯快", // 企业名称（企业微信的账号才有）
            "opemim_wx_openid": "",
            "extra_datas": "qr4BVgogD+Ps94hU7fC9fpSxO8FEiicErn+57uQH7Ph9hEmFi/0QAhowCLrPsMwGEAIaACIECAAQACoTNjg5MTgzMDQ4MTg1NzM2NjY4NDC09cPonoCAAzgC",
            "exten": "CiYIABIiCiBb6K+l5raI5oGv57G75Z6L5pqC5LiN6IO95bGV56S6XQ=="
        }
    ],
    "message_title": "包谷和橘子的聊天记录" // 聊天记录标题
}

# 接龙消息

字段 类型 必填 说明
title string 否 接龙标题
example string 否 接龙格式
str_open_id object 是 发起机器人编号
content string 是 接龙内容
explanation string 否 补充文案

接龙信息json示例

{
    "title": "现摘新鲜葡萄来啦！",
    "example": "每斤仅需8.8 元",
    "str_open_id": "机器人id",
    "content": "xxx 3斤",
    "explanation": "🍬补充文案：谁能拒绝满口爆甜的葡萄啊"
}
最后更新时间: 2026/2/11 15:11:52

← 消息类型说明 →