消息类型说明
概述
字段 | 类型 | 必填 | 说明 |
msg_num | int | 是 | 消息num,消息序号,按照序号顺序发送,在list里面唯一,最小值为1,以1为步长递增 |
msg_type | int | 是 | 消息类型:1 文字;2 图文链接; 3 图片 ;4 视频; 5语音 ;6 文件;7 好友名片;8 小程序;11 视频号消息;12 视频号直播消息; 注:普通图片(普通图片是指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 | 否 | 小程序封面图 |
视频号消息(仅部分版本支持)
字段 | 类型 | 必填 | 说明 |
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编码后的内容 |