调用该接口更新当前用户的消息记录,目前仅支持更新只读状态。
路径 | /message/center/record/modify |
版本号 | 1.0.10 |
协议 | HTTP,HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 是 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
requestDTO | Struct | 是 | { "type": "NOTICE", "isRead": 1, "keyId": "8000**********7302", "keyIds": [ "8000**********7303", "8000**********7502" ] } | 请求的内容。包含以下参数:type(消息类型)、isRead(传固定值1)、keyId(主键ID的字符串格式,每条消息对应唯一的主键ID)、keyIds(KeyId的列表);每次最多可以更新10条消息。 |
keyId | String | 否 | 8000**********7302 | 主键ID的字符串格式,每条消息对应唯一的主键ID。 |
keyIds | List | 否 | ["8000**********7302","8000**********7303","8000**********7304"] | KeyId字符串格式的列表,数组最大长度为10。 |
isRead | Int | 是 | 1 | 传固定值1。 |
type | String | 是 | NOTICE | 消息类型,可选值:MESSAGE、NOTICE。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
接口返回码。200表示成功。 |
|
message | String |
调用失败时,返回的出错信息。 |
|
localizedMsg | String |
本地语言的错误消息。 |
|
data | Int |
返回更新消息状态的行数。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.10",
"iotToken": "token"
},
"params":{
"requestDTO":{
"type": "NOTICE",
"isRead":1,
"keyId": "8000**********7302",
"keyIds":[
"8000**********7303",
"8000**********7502"
]
}
}
}
正常返回示例
JSON
格式
{
"id":"4de2c367-c1db-417c-****-8c585e595d92",
"code":200,
"message":"success",
"localizedMsg":null,
"data":8
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 4047,
"message": "PushRecordServiceFacadeImpl.update.arg0.targetValue The targetValue can't be null.",
"localizedMsg": "无效的参数",
"data": null
}