消息模板管理
功能及平台机制说明
维护用于发送消息时,选择定义的消息模板进行消息推送功能。
具体操作
- 系统管理员打开消息中心下【消息模板管理】功能,新增消息模板即可。默认系统内置的有任务管理和服务注册失败模板,任务管理模板默认可用于业务流程任务消息推送。如模板中要推送短信消息,可以在【系统统一通用配置/短信】参数配置中定义短信模板,并在消息模板管理【短信模板】中选择自定义的短信模板
- 此处设置后,在发送消息页面,供消息模板选择,
,
- 在使用消息接口时,用于消息接口中templateCode参数定义(注:templateCode指消息模板中管理中模板的编码)
url: $platformUrl/message/main/message/sendmessage
method: post
request cookie:
user_session: $user_session //用户登录后获取的user_session
request body(application/json)
{
"templateCode": "template1", //消息微服务中定义的模板
"params": { //消息参数
"url": "消息打开的功能地址",
"变量名": "变量值" // url, code, submitter为平台内置变量
},
"receiverId": "", //消息接收者id,支持部门或人的id
"senderId": "", //消息发送者id
"senderName": "", //消息发送者名称
"channel": "" //消息发送通道: portal,email,sms,wx,dingtalk,多通道使用逗号分隔
}
response body(application/json)
{
"success": true, //状态, 取值范围true, false
"msg": "" //错误消息
}
response status: 200表示成功,其它表示失败
- 消息内容模板可以使用${变量名}的方式定义变量
发送消息时需要给出相应变量的值。有三个变量名(code, url, submitter)是内置名称,不允许使用。
任务消息模板是一个特殊的消息模板,如短息模板中格式设置类似如下:
收到${submiter}提交的新任务: ${title}, 请查看`http://entryhcr0096-vip.a.xcaas.net/entry/pcapp/pc/sms.w?code=${code}`
收到的短信中,点击此链接将会自动唤起app并打开相应的功能页面。