消息中心发送消息 - SendMessage
功能介绍
向用户消息中心发送消息。
- 入参中的messageTemplateName（模板名称）需调用查询消息模板信息接口获取；
- fromUserAccountId（申请人账号ID）/receiver（接收用户）需要调用用户管理中心的查询用户信息接口获取。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限，具体权限要求请参见权限和授权项。
URI
POST /knowledge/public/api/v1/messages
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
Authorization | 是 | String | JWTToken |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
messageRequestList | 是 | Array of MessageRequest | 入参参数 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
fromSysId | 是 | String | 来源系统ID |
fromSys | 否 | String | 来源系统名称（此值需要在IPDCenter系统中有数据） |
fromSysMessageId | 是 | String | 来源系统内部消息标识（此值由“来源系统”定义且唯一） |
fromUserAccountId | 是 | String | 申请人账号ID |
sendTime | 是 | String | 申请时间（yyyy-MM-dd HH:mm:ss） |
messageType | 是 | String | 消息类型：
|
messageSubject | 否 | String | 消息主题（来源系统定义，如果未定义默认与messageTemplateName一致） |
messageTemplateName | 否 | String | 消息模板名称（调用查询消息模板信息接口获取） |
messageData | 否 | JSONObject | 消息数据 说明： 消息内容填充与消息模板相关，如消息模板中有占位符{type}，则此值中需存在名为type的key值。 如果在创建消息模板时{link}占位符存在于超链接网址中，则在发送消息时需要带上网络协议，如link: https://www.example.com。 |
messageContent | 否 | String | 消息内容（和消息模板二选一） |
messageRedirectUrl | 否 | String | 消息跳转地址 |
deliveryType | 是 | String | 消息投递类型：USER指定用户消息 |
receiver | 否 | Array of String | 消息接收者（MessageDeliveryType为USER时需要传User ID） |
tenantId | 否 | Long | 租户ID |
响应参数
状态码： 200
参数 | 参数类型 | 描述 |
|---|---|---|
errorCode | String | 返回码 |
errorMsg | String | 返回码描述 |
请求示例
示例一：
[
{
"fromSysId": "0",
"fromSysMessageId": "basic2234567415966011",
"fromUserAccountId": "1008600000015687941",
"sendTime": "2023-10-17 11:03:26",
"messageType": "AUTHORIZATION_NOTIFICATION",
"messageSubject": "消息主题06",
"messageContent": "消息内容06",
"messageRedirectUrl": "http://w3.huawei.com/next/indexa.html?locale=zh#path=home",
"deliveryType": "USER",
"receiver": ["1008600000055320663"]
}
] 示例二：
[
{
"fromSysId": "0",
"fromSysMessageId": "basic0templatemsgtest0001",
"fromUserAccountId": "75fa53d9-072a-4edc-85e9-7074b0d3e836",
"sendTime": "2023-10-17 11:03:26",
"messageType": "AUTHORIZATION_NOTIFICATION",
"messageSubject": "使用消息模板进行消息发送",
"messageTemplateName": "授权申请提醒",
"messageData": {
"username": "用户1",
"applyName": "基础服务"
},
"messageContent": "",
"messageRedirectUrl": "http://w3.huawei.com/next/indexa.html?locale=zh#path=home",
"deliveryType": "USER",
"receiver": [
"05209014da3a49faa68056102da7ba35"
],
"tenantId": "9190086000001150600"
}
] 响应示例
{
"errorCode": "0000",
"errorMsg": "success"
} 状态码
状态码 | 描述 |
|---|---|
200 | 成功返回SUCCESS |
错误码
请参见错误码。
