消息详细类型描述文档
ContentType 📄
简要描述
msg/send_msg
API 请求字段中contentType
支持的消息类型说明以及消息content
的具体字段说明。
ContentType 消息类型说明
ContentType 值 | 类型说明 |
---|---|
101 | 文本消息 |
102 | 图片消息 |
103 | 音频消息 |
104 | 视频消息 |
105 | 文件消息 |
106 | @消息 |
109 | 位置消息 |
110 | 自定义消息 |
1400 | 系统通知类型消息 |
Content 具体内容 📋
content
内部为具体的 json 对象,不同的消息类型是不同的 json 对象
文本消息 📜
{
...,
"content": {
"content": "nihao"
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
content | 是 | string | 文本消息的具体内容 |
名片消息 🏷️
{
...,
"content": {
"userID":"",
"nickname":"",
"faceURL":"",
"ex":""
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userID | 是 | string | 用户 ID |
nickname | 是 | string | 用户名 |
faceURL | 是 | string | 用户头像 |
ex | 否 | string | 扩展字段 |
图片消息 📷
{
...,
"content": {
"sourcePath":"",
"sourcePicture":{
"uuid":"",
"type":"",
"size":0,
"width":0,
"height":0,
"url":""
},
"bigPicture":{
"uuid":"",
"type":"",
"size":0,
"width":0,
"height":0,
"url":""
},
"snapshotPicture":{
"uuid":"",
"type":"",
"size":0,
"width":0,
"height":0,
"url":""
}
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
sourcePath | 否 | string | 图片文件本地路径 |
sourcePicture | 是 | object | 原图信息 |
bigPicture | 是 | object | 大图信息 |
snapshotPicture | 是 | object | 缩略图信息 |
uuid | 否 | string | 图片文件唯一 ID |
type | 是 | string | 图片文件类型 |
size | 否 | int | 图片文件大小 |
width | 是 | int | 图片宽度 |
height | 是 | int | 图片高度 |
url | 是 | string | 图片下载地址 |
语音消息 🎤
{
...,
"content": {
"uuid":"",
"soundPath":"",
"sourceUrl":"",
"dataSize":0,
"duration":0,
"soundType":""
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
uuid | 否 | string | 语音文件唯一 ID |
soundPath | 否 | string | 语音文件的本地路径 |
sourceUrl | 是 | string | 语音文件下载地址 |
dataSize | 否 | int | 语音文件大小 |
duration | 是 | int | 语音时长 |
soundType | 否 | string | 语音文件类型 |
视频消息 📹
{
...,
"content": {
"videoPath":"",
"videoUUID":"",
"videoUrl":"",
"videoType":"",
"videoSize":0,
"duration":0,
"snapshotPath":"",
"snapshotUUID":"",
"snapshotSize":0,
"snapshotUrl":"",
"snapshotWidth":0,
"snapshotHeight":0
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
videoPath | 否 | string | 视频文件本地路径 |
videoUUID | 否 | string | 视频文件唯一 ID |
videoUrl | 是 | string | 视频文件下载地址 |
videoType | 是 | string | 视频文件类型 |
videoSize | 是 | int | 视频文件大小 |
duration | 是 | int | 视频时长 |
snapshotPath | 否 | string | 视频封面图文件本地路径 |
snapshotUUID | 否 | string | 视频封面图唯一 ID |
snapshotSize | 否 | int | 视频封面图文件大小 |
snapshotUrl | 是 | string | 视频封面图文件下载地址 |
snapshotWidth | 是 | int | 视频封面图宽度 |
snapshotHeight | 是 | int | 视频封面图高度 |
文件消息 📁
{
...,
"content": {
"filePath":"",
"uuid":"",
"sourceUrl":"",
"fileName":"",
"fileSize":0,
"fileType":""
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
filePath | 否 | string | 文件本地路径 |
uuid | 否 | string | 文件唯一 ID |
sourceUrl | 是 | string | 文件下载地址 |
fileName | 是 | string | 文件名称 |
fileSize | 是 | int | 文件大小 |
fileType | 否 | string | 文件类型 |
表情消息 😄
{
...,
"content":{
"index": 0,
"data": ""
},
...
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
index | 是 | int | 表情索引 |
data | 否 | string | 表情自定义 json 数据 |
位置消息 📍
{
...,
"content":{
"description": "",
"longitude": 0,
"latitude": 0
},
...,
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
description | 否 | string | 位置描述 |
longitude | 是 | double | 定位经度 |
latitude | 是 | double | 定位纬度 |
@消息 📢
{
...,
"content": {
"text": "",
"atUserList": ['12312'],
"isAtSelf": false,
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
text | 否 | string | 消息文本内容 |
atUserList | 是 | array | @的用户列表 |
isAtSelf | 否 | boolean | 是否@自己 |
**
自定义消息** 🖌️
{
...,
"content": {
"data": "",
"description": "",
"extension": ""
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
data | 是 | string | 用户自定义的消息内容 |
description | 否 | string | 扩展的描述信息 |
extension | 否 | string | 扩展字段 |
系统通知消息 📢
系统通知消息作为一种特别的自定义通知消息,客户端会产生一个独立的会话,固定的会话类型为 4,其中发送者 ID 为通知号 userID。
{
...,
"content": {
"notificationName": "notification",
"notificationFaceURL": "http://www.head1.com",
"notificationType": 1,
"text": "hello!",
"externalUrl":"",
"mixType": 0,
"pictureElem": {
"sourcePath": "",
"sourcePicture": {
"uuid": "",
"type": "",
"size": 0,
"width": 0,
"height": 0,
"url": ""
},
"bigPicture": {
"uuid": "",
"type": "",
"size": 0,
"width": 0,
"height": 0,
"url": ""
},
"snapshotPicture": {
"uuid": "",
"type": "",
"size": 0,
"width": 0,
"height": 0,
"url": ""
}
},
"soundElem": {
"uuid": "",
"soundPath": "",
"sourceUrl": "",
"dataSize": 0,
"duration": 0
},
"videoElem": {
"videoPath": "",
"videoUUID": "",
"videoUrl": "",
"videoType": "",
"videoSize": 0,
"duration": 0,
"snapshotPath": "",
"snapshotUUID": "",
"snapshotSize": 0,
"snapshotUrl": "",
"snapshotWidth": 0,
"snapshotHeight": 0
},
"fileElem": {
"filePath": "",
"uuid": "",
"sourceUrl": "",
"fileName": "",
"fileSize": 0
},
"ex": ""
},
....
}
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
notificationName | 是 | string | 通知标题 |
notificationFaceURL | 否 | string | 通知头像 |
notificationType | 是 | int | 通知类型,如:1 代表入职通知;2 代表离职通知... |
text | 是 | string | 通知正文 |
externalUrl | 否 | string | 通知点击后需要跳转到的地址链接(不填则无需跳转) |
mixType | 是 | int | 通知混合类型 0:纯文字通知 1:文字+图片通知 2:文字+视频通知 3:文字+文件通知 4: 文字+语音通知 5: 文字+语音+图片通知 |
pictureElem | 否 | object | 图片元素对象 |
sourcePicture | 否 | object | 原图 |
bigPicture | 否 | object | 大图 |
snapshotPicture | 否 | object | 缩略图 |
soundElem | 否 | object | 声音元素 |
videoElem | 否 | object | 视频元素 |
fileElem | 否 | object | 文件元素 |
ex | 否 | string | 扩展字段 |