消息发送
功能及平台机制说明
平台提供的消息发送页面可用于测试,在实际应用中通过提供的api接口进行调用发送消息
在页面中选择消息模板、接收者、消息通道,消息参数填写定义消息模板中的{参数:值}方式发送即可。
消息发送接口
消息中心应用提供了消息发送接口和批量消息发送接口,应用还提供了消息发送功能,里面调用了消息发送接口
1. 消息发送接口
消息发送接口api如下
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表示成功,其它表示失败
2. 批量消息发送接口
批量消息发送接口api如下
url: $platformUrl/message/main/message/sendmessagelist
批量消息发送接口和消息发送接口的用法一样,区别在于参数为JSON数组,例如下面的代码表示发送两条消息
[{
"templateCode": "TASK_MANAGE",
"params": {
"url": "",
"title": "hello"
},
"receiverid": "/nXeWxDG33oAoY0mpL4A.ogn/nXeWEBy33W8qNkslqxO.psm",
"senderId": "system",
"senderName": "system",
"channel": "portal"
},
{
"templateCode": "TASK_MANAGE",
"params": {
"url": "",
"title": "hello world"
},
"receiverid": "/nXeWxDG33oAoY0mpL4A.ogn/nXeWEBy33W8qNkslqxO.psm",
"senderId": "system",
"senderName": "system",
"channel": "portal"
}]