跳到主要内容

消息详细类型描述文档

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":""
  },
  ....
}
参数名必选类型说明
userIDstring是用户 ID
nicknamestring是用户名
faceURLint是用户头像
exstring否扩展字段

图片消息​

{
  ...,
  "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":""
  }
  },
  ....
}
参数名必选类型说明
sourcePathstring否图片文件本地路径
sourcePictureobject是原图信息
bigPictureobject是大图信息
snapshotPictureobject是缩略图信息
uuidstring否图片文件唯一 ID
typestring是图片文件类型
sizeint否图片文件大小
widthint是图片宽度
heightint是图片高度
urlstring是图片下载地址

语音消息​

{
  ...,
  "content": {
      "uuid":"",
      "soundPath":"",
      "sourceUrl":"",
      "dataSize":0,
      "duration":0,
      "soundType":""
  },
  ....
}
参数名必选类型说明
uuidstring否语音文件唯一 ID
soundPathstring否语音文件的本地路径
sourceUrlstring是语音文件下载地址
dataSizeint否语音文件大小
durationint是语音时长
soundTypestring否语音文件类型

视频消息​

{
  ...,
  "content": {
      "videoPath":"",
      "videoUUID":"",
      "videoUrl":"",
      "videoType":"",
      "videoSize":0,
      "duration":0,
      "snapshotPath":"",
      "snapshotUUID":"",
      "snapshotSize":0,
      "snapshotUrl":"",
      "snapshotWidth":0,
      "snapshotHeight":0
  },
  ....
}
参数名必选类型说明
videoPathstring否视频文件本地路径
videoUUIDstring否视频文件唯一 ID
videoUrlstring否视频文件下载地址
videoTypestring是视频文件类型
videoSizeint是视频文件大小
durationint是视频时长
snapshotPathstring否视频封面图文件本地路径
snapshotUUIDstring否视频封面图唯一 ID
snapshotSizeint否视频封面图文件大小
snapshotUrlstring是视频封面图文件下载地址
snapshotWidthint是视频封面图宽度
snapshotHeightint是视频封面图高度

文件消息​

{
  ...,
  "content": {
      "filePath":"",
      "uuid":"",
      "sourceUrl":"",
      "fileName":"",
      "fileSize":0,
      "fileType":""
  },
  ....
}
参数名必选类型说明
filePathstring否文件本地路径
uuidstring否文件唯一 ID
sourceUrlstring是文件下载地址
fileNamestring是文件名称
fileSizeint是文件大小
fileTypestring否文件类型

表情消息​

{
  ...,
  "content":{
    "index": 0,
    "data": ""
  },
  ...
}
参数名必选类型说明
indexint是表情索引
datastring否表情自定义 json 数据

位置消息​

{
  ...,
  "content":{
  "description": "",
  "longitude": 0,
  "latitude": 0
  },
  ...,
}
参数名必选类型说明
descriptionstring否位置描述
longitudedouble是定位经度
latitudedouble是定位纬度

@消息​

{
  ...,
  "content": {
      "text": "",
      "atUserList": ['12312'],
      "isAtSelf": false,
  },
  ....
}
参数名必选类型说明
text否json string消息
atUserList是json string[]@的用户列表
isAtSelf否json string是否@自己

位置消息​

Description string mapstructure:"description" Longitude float64 mapstructure:"longitude" validate:"required" Latitude float64 mapstructure:"latitude" validate:"required"

{
  ...,
  "content": {
      "description": "",
      "longitude": 1.1,
      "latitude": 1.1
  },
  ....
}
参数名必选类型说明
description否json string扩展的描述信息为 json 对象转换后的 string
longitude是json number经度
latitude是json number纬度

自定义消息​

{
  ...,
  "content": {
      "data": "",
      "description": "",
      "extension": ""
  },
  ....
}
参数名必选类型说明
data是json string用户自定义的消息为 json 对象转换后的 string
description否json string扩展的描述信息为 json 对象转换后的 string，可以不使用
extension否json string扩展字段，暂时不使用

系统通知消息​

系统通知消息作为一种特别的自定义通知消息，客户端会产生一个独立的会话，固定的会话类型为 4，其中发送者 ID 必须为为后台 config 文件中配置的管理员 ID 中一个。

{
  ...,
  "content": {
      "notificationName": "公文管理",
      "notificationFaceURL": "http://www.head1.com",
      "notificationType": 1,
      "text": "大家好，今天是...",
      "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": ""
  },
  ....
}
参数名必选类型说明
notificationNamestring是通知标题
notificationFaceURLstring否通知头像
notificationTypeint是通知类型，如：1 代表入职通知，2 代表离职通知...
textstring是通知正文 e
externalUrlstring否通知点击后需要跳转到的地址链接(不填则无需跳转)
mixTypeint是通知混合类型
0：纯文字通知
1：文字+图片通知
2：文字+视频通知
3：文字+文件通知
4: 文字+语音通知
5: 文字+语音+图片通知
pictureElemobject否图片元素对象
sourcePictureobject否原图
bigPictureobject否大图
snapshotPictureobject否缩略图
soundElemobject否声音元素
videoElemobject否视频元素
fileElemobject否文件元素
exstring否扩展字段