跳转至

消息类型和数据格式

NOTE: 消息发送支持用户和部门，这两个参数不能同时为空。

文本消息

{
     "toUser": "user1|user2|user3",
     "toDept": "deptId1|deptId2|deptId3",
     "msgType": "text",
     "text": {
        "content": "it is a text"
     }
}
参数 必须 说明
toUser 否 接收成员帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
msgType 是 消息类型，这里固定为：text
content 是 消息内容，支持表情，最长不超过600个字符，超出部分将自动截取

图片消息

{
   "toUser": "user1|user2|user3",
   "toDept": "deptId1|deptId2|deptId3",
   "msgType": "image",
   "image": {
        "media_id": "img_media_id"
    }
}
参数 必须 说明
toUser 否 接收成员的帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
msgType 是 消息类型，这里固定为：image
media_id 是 图片素材文件ID。通过上传素材文件接口获取

文件消息

{
   "toUser": "user1|user2|user3",
   "toDept": "deptId1|deptId2|deptId3",
   "msgType": "file",
   "file": {
      "media_id": "file_media_id"
    }
}
参数 必须 说明
toUser 否 接收成员的帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
msgType 是 消息类型，这里固定为：file
media_id 是 素材文件ID。通过上传素材文件接口获取

图文消息

{
   "toUser": "user1|user2|user3",
   "toDept": "deptId1|deptId2|deptId3",
   "msgType": "mpnews",
   "mpnews":  [
         {
             "title": "title",
             "media_id": "thumb_media_id",
             "content": "content",
             "digest": "digest",
             "showFront": 1
         },
         {
             "title": "title",
             "media_id": "thumb_media_id",
             "content": "content",
             "digest": "digest",
             "showFront": 0
         }
 ]
}
参数 必须 说明
toUser 否 接收成员帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
msgType 是 消息类型，这里固定为：mpnews
mpnews 是 图文详细信息，最多不超过5条
title 是 标题，最长不超过64个字符，超出部分将自动截取
media_id 是 封面图片ID。通过上传素材文件接口获取
content 是 正文，最长不超过600个字符，超出部分将自动截取
digest 否 摘要，最长不超过120个字符，超出部分将自动截取
showFront 否 正文是否显示封面图片。1：显示，0：不显示

隐式链接

{
   "toUser": "user1|user2|user3",
   "toDept": "deptId1|deptId2|deptId3",
   "msgType": "link",
   "link": {
       "title": "$title",
       "url": "$url",
       "action": 0
    }
}
参数 必须 说明
toUser 否 接收成员帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
msgType 是 消息类型，这里固定为：link
title 是 标题。最多允许64个字符
url 是 链接
action 否 链接打开方式。0：直接打开url；1：url后面带上有度客户端userName和token，可做单点登录

外链消息

  {
     "toUser": "user1|user2|user3",
     "toDept": "deptId1|deptId2|deptId3",
     "msgType": "exlink",
     "exlink": [
           {
            "title": "$title_1",
            "url": "$url_1",
            "digest": "$digest_1",
            "media_id": "$mediaId_1"
          },
           {
            "title": "$title_2",
            "url": "$url_1",
            "digest": "$digest_1",
            "media_id": "$mediaId_2"
          }
     ]
  }
参数 必须 说明
toUser 否 接收成员帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
msgType 是 消息类型，这里固定为：exlink
exlink 是 外链详细信息，最多不超过5条
title 是 标题。最多允许64个字符
url 是 链接
media_id 是 封面图片的ID。通过上传素材文件接口获取
digest 否 摘要，最长不超过120个字符，超出部分将自动截取

系统消息

请在有度管理后台-->管理工具-->系统消息页面中找到AppID和EncodingAESKey进行开发。

  {
     "toUser": "user1|user2|user3",
     "toDept": "deptId1|deptId2|deptId3",
     "toAll": {
         "onliyOnline": true/false
     },
     "msgType": "sysMsg",
     "sysMsg": {
         "title": "$title",
         "popDuration": 6,
         "msg":[
            {
                "text": {
                   "content": "it is a text"
                }
            },
            {
                "link": {
                  "title": "$title",
                  "url": "$url",
                  "action": 0
                }
           }
         ]
     }
  }
参数 必须 说明
toUser 否 接收成员帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
toAll 否 是否要发送给全体成员
onlyOnline 否 需要toAll时，此项必填。true：仅发送给全体在线成员，离线成员即使再上线也不会接收到该消息；false：发送给全体成员，离线成员再上线时也可以收到该消息
msgType 是 消息类型，这里固定为：sysMsg
title 是 系统消息标题。最多允许64个字符
popDuration 否 弹窗显示时间，0及负数弹窗不消失，正数为对应显示秒数
msg 是 消息详细内容。系统消息内容支持(1)文本和(5)隐式链接

短信消息（短信网关收到的手机回复的短信）

{
     "toUser": "user1|user2|user3",
     "toDept": "deptId1|deptId2|deptId3",
     "msgType": "sms",
     "sms": {
        "from": "13854675829",
        "content": "it is a sms"
     }
}
参数 必须 说明
toUser 否 接收成员帐号列表。多个接收者用竖线分隔，最多支持1000个
toDept 否 接收部门id列表。多个接收者用竖线分隔，最多支持100个。填0发送给组织架构全员
msgType 是 消息类型，这里固定为：sms
from 是 发送短信的手机号码
content 是 消息内容，支持表情，最长不超过600个字符，超出部分将自动截取

邮件消息

请在有度管理后台-->企业应用-->企业邮-->其他邮箱页面中找到AppID和EncodingAESKey进行开发。

{
   "toUser": "user1|user2|user3",
   "toEmail": "email1|email2|email3",
   "msgType": "mail",
   "mail": {
       "action": "$action",
       "subject": "$subject",
       "fromUser": "$fromUser",
       "fromEmail": "$fromEmail",
       "time": 1542699050,
       "link": "$link",
       "unreadCount": 5
    }
}
参数 必须 说明
toUser 否 接收成员帐号列表。多个接收者用竖线分隔，最多支持1000个
toEmail 否 接收成员邮件账号列表。多个接收者用竖线分隔，最多支持1000个。toUser不为空，toEmail值无效
msgType 是 消息类型，这里固定为：mail
action 否 邮件消息类型。new: 新邮件，unread: 未读邮件数
subject 否 邮件主题。action为new时有效，可为空
fromUser 否 发送者帐号，action为new时有效
fromEmail 否 发送者邮件帐号，action为new时有效。fromUser不为空，fromEmail值无效
time 否 邮件发送时间。为空默认取服务器接收到消息的时间
link 否 邮件链接。action为new时有效，点此链接即可打开邮件，为空时点击邮件消息默认执行企业邮箱单点登录
unreadCount 否 未读邮件数。action为unread时有效