帮助中心

Appearance

消息中心 ​

RemoteMessageService ​

com.magus.cloud.messagecenter.client.api.RemoteMessageService

sendSmsCaptcha ​

接口说明

发送手机短信验证码

请求地址

POST /message-center/sender/sms/captcha

请求参数

参数名父级类型是否必须示例值描述
smsCaptchaObjectcom.magus.cloud.messagecenter.base.model.request.SmsCaptcha
mobilesmsCaptchaString11344***4234手机号
codesmsCaptchaString1magustek编码
sendersmsCaptchaString0Admin发送方
ownersmsCaptchaString0admin所有者
useTemplatesmsCaptchaboolean0True是否使用模板
templateCodesmsCaptchaString010000模板编码
templateParamssmsCaptchaObject0{"code": "123456"}模板参数

响应状态

状态码说明schema
200OK
500服务响应异常CommonRsp

响应参数

参数名称参数说明类型schema

请求示例

{
  "mobile": "",
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true

sendSms ​

接口说明

发送手机短信通知

请求地址

POST /message-center/sender/sms

请求参数

参数名父级类型是否必须示例值描述
smsMessageObjectcom.magus.cloud.messagecenter.base.model.request.SmsMessage
mobilessmsMessageArray1[1344***4234]手机号
codesmsMessageString1magustek编码
sendersmsMessageString0admin发送方
ownersmsMessageString0admin所有者
useTemplatesmsMessageboolean0true是否使用模板
templateCodesmsMessageString010000模板编码
templateParamssmsMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "mobiles": [],
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true

sendEmail ​

接口说明

发送邮件

请求地址

POST /message-center/sender/email

请求参数

参数名父级类型是否必须示例值描述
emailMessageObjectcom.magus.cloud.messagecenter.base.model.request.EmailMessage
toemailMessageArray1["213@qq.com"]发送邮箱
ccemailMessageArray0["213@qq.com"]抄送邮箱
bcemailMessageArray0["213@qq.com"]密送邮箱
codeemailMessageString1magustek编码
senderemailMessageString0admin发送方
owneremailMessageString0admin所有者
useTemplateemailMessageboolean0true是否使用模板
templateCodeemailMessageString010000模板编码
templateParamsemailMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "to": [],
  "cc": [],
  "bc": [],
  "subject": "",
  "content": "",
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true

sendMsg ​

接口说明

发送站内信

请求地址

POST /message-center/sender/msg

请求参数

参数名父级类型是否必须示例值描述
innerMessageObjectcom.magus.cloud.messagecenter.base.model.request.InnerMessage
categoryIdinnerMessageInteger10消息分类ID
subCategoryIdinnerMessageInteger00消息子分类ID
receiversinnerMessageArray0["admin"]接收方
subjectinnerMessageString0告警标题
contentinnerMessageString0异常告警：数据不存在消息内容
codeinnerMessageString1magustek编码
senderinnerMessageString0admin发送方
ownerinnerMessageString0admin所有者
useTemplateinnerMessageboolean0true是否使用模板
templateCodeinnerMessageString010000模板编码
templateParamsinnerMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "categoryId": 0,
  "subCategoryId": 0,
  "receivers": [],
  "subject": "",
  "content": ""，
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true

sendTodo ​

接口说明

发送待办事项

请求地址

POST /message-center/sender/todo

请求参数

参数名父级类型是否必须示例值描述
todoMessageObjectcom.magus.cloud.messagecenter.base.model.request.TodoMessage
urltodoMessageString0Https://www.didi.comUrl
receiverstodoMessageArray0["admin"]接收方
subjecttodoMessageString0告警标题
contenttodoMessageString0异常告警：数据不存在消息内容
codetodoMessageString1magustek编码
sendertodoMessageString0admin发送方
ownertodoMessageString0admin所有者
useTemplatetodoMessageboolean0true是否使用模板
templateCodetodoMessageString010000模板编码
templateParamstodoMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "subject": "主题",
  "receivers": [
    "接收方"
  ],
  "content": "消息内容",
  "url": "链接地址",
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true

sendMessages ​

接口说明

批量发送

请求地址

POST /message-center/sender/batch

请求参数

参数名父级类型是否必须示例值描述
messagesArray1com.magus.cloud.messagecenter.base.model.AbstractMessage
typemessagesString0MSG消息类型:MSG,TODO,CAPTCHA,SMS,EMAIL,WECHAT,WECHAT_APP,DINGTALK,API,BATCH
codemessagesString1magustek编码
headermessagesObject0{}消息头
bodymessagesObject0{}消息体
ownermessagesString0admin消息所有者
sendermessagesString0admin消息发送者
retryProfilemessagesString0{}重试配置

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

[
  {
    "type": "",
    "owner": "",
    "header": {},
    "sender": "",
    "retryProfile": {},
    "code": "",
    "body": {}
  }
]

响应示例

true

sendRuleMessage ​

接口说明

规则发送

请求地址

POST /message-center/sender/rule

请求参数

参数名父级类型是否必须示例值描述
ruleMessageObject1com.magus.cloud.messagecenter.base.model.request.RuleMessage
coderuleMessageString1magustek编码
ruleCoderuleMessageString0Https://www.didi.com规则编码
senderruleMessageString0admin发送方
ownerruleMessageString0admin所有者
templateParamsruleMessageObject0{"code": "123456"}模板参数
emailMessageruleMessageObject邮件
toemailMessageArray1["213@qq.com"]发送邮箱
ccemailMessageArray0["213@qq.com"]抄送邮箱
bcemailMessageArray0["213@qq.com"]密送邮箱
codeemailMessageString1magustek编码
senderemailMessageString0admin发送方
owneremailMessageString0admin所有者
useTemplateemailMessageboolean0true是否使用模板
templateCodeemailMessageString010000模板编码
templateParamsemailMessageObject0{"code": "123456"}模板参数
innerMessageruleMessageObject站内信
categoryIdinnerMessageInteger10消息分类ID
subCategoryIdinnerMessageInteger00消息子分类ID
receiversinnerMessageArray0["admin"]接收方
subjectinnerMessageString0告警标题
contentinnerMessageString0异常告警：数据不存在消息内容
codeinnerMessageString1magustek编码
senderinnerMessageString0admin发送方
ownerinnerMessageString0admin所有者
useTemplateinnerMessageboolean0true是否使用模板
templateCodeinnerMessageString010000模板编码
templateParamsinnerMessageObject0{"code": "123456"}模板参数
smsMessageruleMessageObject短信
mobilessmsMessageArray1[1344***4234]手机号
codesmsMessageString1magustek编码
sendersmsMessageString0admin发送方
ownersmsMessageString0admin所有者
useTemplatesmsMessageboolean0true是否使用模板
templateCodesmsMessageString010000模板编码
templateParamssmsMessageObject0{"code": "123456"}模板参数
weChatAppMessageruleMessage企业微信
toUserweChatAppMessageArray0["10000"]成员ID
toPartyweChatAppMessageArray0["20000"]部门ID
toTagweChatAppMessageArray0["20000"]标签ID
titleweChatAppMessageString0告警标题
contentweChatAppMessageString0异常告警：数据不存在消息内容
urlweChatAppMessageStringhttps://www.sss.comurl
msgTypeweChatAppMessageStriTEXT消息类型 文本-TEXT(默认),图片-IMAGE,图文消息-NEWS
safeweChatAppMessageInteger0是否是保密消息 0表示可对外分享，1表示不能分享且内容显示水印，默认为0
codeweChatAppMessageString1magustek编码
senderweChatAppMessageString0admin发送方
ownerweChatAppMessageString0admin所有者
useTemplateweChatAppMessageboolean0true是否使用模板
templateCodeweChatAppMessageString010000模板编码
templateParamsweChatAppMessageObject0{"code": "123456"}模板参数
dingTalkMessageruleMessageObjectcom.magus.cloud.messagecenter.base.model.request.DingTalkMessage
mobilesdingTalkMessageArray0["15312834284"]手机号
usersdingTalkMessageArray0["admin"]用户
titledingTalkMessageString0告警标题
contentdingTalkMessageString0异常告警：数据不存在消息内容 tip:(消息类型为图片的,内容需要base64编码)
atAlldingTalkMessageBoolean0true是否@所有人，默认不@
msgTypedingTalkMessageString0TEXT消息类型 文本-TEXT(默认),图片-IMAGE,图文消息-NEWS
codedingTalkMessageString1magustek编码
senderdingTalkMessageString0admin发送方
ownerdingTalkMessageString0admin所有者
useTemplatedingTalkMessageboolean0true是否使用模板
templateCodedingTalkMessageString010000模板编码
templateParamsdingTalkMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "code": "",
  "ruleCode": "",
  "sender": "",
  "owner": "",
  "templateParams": {},
  "emailMessage": {//邮件
    "to": [
      "发送地址"
    ],
    "cc": [
      "抄送地址"
    ],
    "bc": [
      "密送地址"
    ],
    "subject": "主题",
    "content": "正文",
    "code": "编码",
    "sender": "发送方",
    "owner": "所有者",
    "useTemplate": false,//是否使用模板
    "templateCode": "模板编码",
    "templateParams": {}//模板参数
  },
  "innerMessage": {//站内信
    "categoryId": 0,//消息分类ID
    "subCategoryId": 0,//消息子分类ID
    "receivers": [
      "接收方"
    ],
    "subject": "标题",
    "content": "消息内容",
    "code": "编码",
    "sender": "发送方",
    "owner": "所有者",
    "useTemplate": false,//是否使用模板
    "templateCode": "模板编码",
    "templateParams": {}//模板参数
  },
  "smsMessage": {//短信
    "mobiles": [
      "手机号"
    ],
    "code": "编码",
    "sender": "发送方",
    "owner": "所有者",
    "useTemplate": false,//是否使用模板
    "templateCode": "模板编码",
    "templateParams": {}//模板参数
  },
  "weChatAppMessage": {//企业微信
    "toUser": [
      "成员ID"
    ],
    "toParty": [
      "部门ID"
    ],
    "toTag": [
      "标签ID"
    ],
    "title": "标题",
    "content": "消息内容",
    "url": "url",
    "msgType": [
      "TEXT",
      "TEXTCARD",
      "MARKDOWN",
      "IMAGE",
      "NEWS"
    ],//消息类型 文本-TEXT(默认),图片-IMAGE,图文消息-NEWS
    "safe": 0,//是否是保密消息 0表示可对外分享，1表示不能分享且内容显示水印，默认为0
    "code": "编码",
    "sender": "发送方",
    "owner": "所有者",
    "useTemplate": false,//是否使用模板
    "templateCode": ""//模板编码,
    "templateParams": {}//模板参数
  },
  "dingTalkMessage": {//钉钉
    "mobiles": [
      "手机号"
    ],
    "users": [
      "用户"
    ],
    "title": "标题",
    "content": "正文",
    "atAll": false,//是否@所有人，默认不@
    "msgType": [
      "TEXT",
      "MARKDOWN"
    ],//消息类型
    "code": "",//编码
    "sender": "",//发送方
    "owner": "",//所有者
    "useTemplate": false,//是否使用模板
    "templateCode": ""//模板编码
    "sender": "发送方",
    "owner": "所有者",
    "templateParams": {}//模板参数
  }
}

响应示例

true

sendWeChatApp ​

接口说明

发送企业微信消息-应用

请求地址

POST /message-center/sender/weChat/app

请求参数

参数名父级类型是否必须示例值描述
weChatAppMessageObjectcom.magus.cloud.messagecenter.base.model.request.WeChatAppMessage
toUserweChatAppMessageArray0["10000"]成员ID
toPartyweChatAppMessageArray0["20000"]部门ID
toTagweChatAppMessageArray0["20000"]标签ID
titleweChatAppMessageString0告警标题
contentweChatAppMessageString0异常告警：数据不存在消息内容 tip:(消息类型为图片的,内容需要base64编码)
urlweChatAppMessageStringhttps://www.sss.comurl
msgTypeweChatAppMessageStriTEXT消息类型 文本-TEXT(默认),图片-IMAGE,图文消息-NEWS
safeweChatAppMessageInteger0是否是保密消息 0表示可对外分享，1表示不能分享且内容显示水印，默认为0
codeweChatAppMessageString1magustek编码
senderweChatAppMessageString0admin发送方
ownerweChatAppMessageString0admin所有者
useTemplateweChatAppMessageboolean0true是否使用模板
templateCodeweChatAppMessageString010000模板编码
templateParamsweChatAppMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "toUser": [],
  "toParty": [],
  "toTag": [],
  "title": "",
  "content": "",
  "url": "",
  "msgType": [
    "TEXT",
    "TEXTCARD",
    "MARKDOWN",
    "IMAGE",
    "NEWS"
  ],
  "safe": 0,
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true

sendWeChat ​

接口说明

发送企业微信消息-webhook

请求地址

POST /message-center/sender/weChat/robot

请求参数

参数名父级类型是否必须示例值描述
weChatMessageObjectcom.magus.cloud.messagecenter.base.model.request.WeChatMessage
mobilesweChatMessageArray0["15312834284"]手机号
usersweChatMessageArray0["admin"]用户
contentweChatMessageString0异常告警：数据不存在消息内容 tip:(消息类型为图片的,内容需要base64编码)
msgTypeweChatMessageString0TEXT消息类型 文本-TEXT(默认),图片-IMAGE,图文消息-NEWS
codeweChatMessageString1magustek编码
senderweChatMessageString0admin发送方
ownerweChatMessageString0admin所有者
useTemplateweChatMessageboolean0true是否使用模板
templateCodeweChatMessageString010000模板编码
templateParamsweChatMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "mobiles": [],
  "users": [],
  "content": "",
  "msgType": [
    "TEXT",
    "TEXTCARD",
    "MARKDOWN",
    "IMAGE",
    "NEWS"
  ],
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true

sendDingTalk ​

接口说明

发送钉钉消息-webhook

请求地址

POST /message-center/sender/dingTalk

请求参数

参数名父级类型是否必须示例值描述
dingTalkMessageObjectcom.magus.cloud.messagecenter.base.model.request.DingTalkMessage
mobilesdingTalkMessageArray0["15312834284"]手机号
usersdingTalkMessageArray0["admin"]用户
titledingTalkMessageString0告警标题
contentdingTalkMessageString0异常告警：数据不存在消息内容 tip:(消息类型为图片的,内容需要base64编码)
atAlldingTalkMessageBoolean0true是否@所有人，默认不@
msgTypedingTalkMessageString0TEXT消息类型 文本-TEXT(默认),图片-IMAGE,图文消息-NEWS
codedingTalkMessageString1magustek编码
senderdingTalkMessageString0admin发送方
ownerdingTalkMessageString0admin所有者
useTemplatedingTalkMessageboolean0true是否使用模板
templateCodedingTalkMessageString010000模板编码
templateParamsdingTalkMessageObject0{"code": "123456"}模板参数

响应状态

状态码说明
200OK
500服务响应异常

响应参数

参数名称参数说明类型schema

请求示例

{
  "mobiles": [],
  "users": [],
  "title": "",
  "content": "",
  "atAll": false,
  "msgType": [
    "TEXT",
    "MARKDOWN"
  ],
  "code": "",
  "sender": "",
  "owner": "",
  "useTemplate": false,
  "templateCode": "",
  "templateParams": {}
}

响应示例

true