消息服务
更新时间：2018-06-08 11:35:49
提供一组消息记录的操作服务接口，客户端应用通过本组服务接口可以实现对推送到用户客户端的消息记录的查询、统计和删除等操作。
统计用户的消息记录数量
定义描述
|
path
|
版本
|
描述
|
是否需要用户身份的鉴权
|
|
/message/center/record/messagetype/count
|
1.0.1
|
统计当前用户的消息记录数量
|
是，客户端SDK需启用身份的鉴权
|
请求参数
|
字段名
|
子键
|
类型
|
是否必填
|
备注
|
|
requestDTO
|
Map
|
|||
|
startCreateTime
|
Date
|
N
|
查询开始时间
|
|
|
endCreateTime
|
Date
|
N
|
查询结束时间
|
|
|
messageType
|
String
|
N
|
不传则三种都查
|
|
|
type
|
String
|
Y
|
MESSAGE: 透传
NOTICE:推送
|
|
|
maxId
|
Long
|
N
|
查询条件：id <maxId
|
|
|
minId
|
Long
|
N
|
查询条件: id >minId
|
|
|
isRead
|
Integer
|
N
|
0: 未读
1：已读
|
返回参数
|
字段名
|
类型
|
描述
|
|
data
|
Map<String, Long>
|
k: device：设备 announcement：通知 share：分享
v:数量
|
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"requestDTO": {
"type": "NOTICE"
}
}
}
正常返回示例
{
"code": 200,
"data": {
"share": 6,
"device": 0,
"announcement": 0
},
"message": "success"
}
错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|
查询用户的消息记录
定义描述
|
path
|
版本
|
描述
|
是否需要用户身份的鉴权
|
|
/message/center/record/query
|
1.0.1
|
查询当前用户的消息记录
|
是，客户端SDK需启用身份的鉴权
|
请求参数
|
字段名
|
子键
|
类型
|
是否必填
|
备注
|
|
requestDTO
|
Map
|
|||
|
startCreateTime
|
Date
|
N
|
查询开始时间
|
|
|
endCreateTime
|
Date
|
N
|
查询结束时间
|
|
|
messageType
|
String
|
Y
|
device：设备
announcement：通知
share：分享
|
|
|
type
|
String
|
Y
|
MESSAGE: 透传
NOTICE:推送
|
|
|
maxId
|
Long
|
N
|
查询条件：id <maxId
|
|
|
minId
|
Long
|
N
|
查询条件: id >minId
|
|
|
pageNo
|
Integer
|
Y
|
||
|
pageSize
|
Integer
|
Y
|
最大100
|
|
|
isRead
|
Integer
|
N
|
0:未读
1：已读
|
|
|
sortType
|
Integer
|
N
|
null or 0: gmtCreate倒排
1: gmtCreate正排
|
返回参数
|
字段名
|
子键
|
二级子键
|
三级子键
|
三级子键
|
类型
|
描述
|
|
data
|
Map
|
|||||
|
count
|
Long
|
总数
|
||||
|
data
|
id
|
List<Map>
|
||||
|
gmtCreate
|
Date
|
创建时间
|
||||
|
gmtModified
|
Date
|
修改时间
|
||||
|
appKey
|
Long
|
|||||
|
title
|
String
|
|||||
|
body
|
String
|
|||||
|
messageType
|
String
|
消息类型
设备、共享、通知
|
||||
|
isRead
|
Integer
|
阅读状态
|
||||
|
extData
|
Map
|
附加信息
|
||||
|
device
|
Map
|
设备信息
|
||||
|
iotId
|
String
|
设备id
|
||||
|
productKey
|
String
|
产品key
|
||||
|
productName
|
String
|
产品名称
|
||||
|
icon
|
String
|
图标
|
||||
|
nickName
|
String
|
昵称
|
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"requestDTO": {
"type": "NOTICE",
"pageNo": 1,
"pageSize": 20
}
}
}
正常返回示例
{
"code": 200,
"data": {
"count": 102,
"data": [{
"appKey": 1234567,
"body": "温度高",
"deviceType": "iOS",
"extData": {
"device": {
"categoryId": 100,
"iotId": "iotId1",
"productKey": "p1",
"productName": "1"
}
},
"gmtCreate": 1525351832000,
"gmtModified": 1525351851000,
"id": 1000000000000200439,
"isRead": 1,
"messageId": "-1",
"messageType": "device",
"scopeId": "scopeId1",
"target": "ACCOUNT",
"targetValue": "userId",
"tenantId": "tenantId",
"title": "测试",
"type": "NOTICE"
}],
"queryPageNo": 1,
"queryPageSize": 10
},
"message": "success"
}
错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|
逻辑删除用户的消息记录
定义描述
|
path
|
版本
|
描述
|
是否需要用户身份的鉴权
|
|
/message/center/record/delete
|
1.0.1
|
逻辑删除当前用户的消息记录
|
是，客户端SDK需启用身份的鉴权
|
请求参数
| 字段名 | 子键 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| requestDTO | Map | |||
| type | String | Y | MESSAGE: 透传 NOTICE:推送 | |
| messageType | String | N | ||
| id | Long | N | 消息记录id | |
| maxId | Long | N | 查询条件：id <maxId | |
| minId | Long | N | 查询条件: id >minId |
返回参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| data | Integer | 删除的记录数量 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"requestDTO": {
"type": "NOTICE"
}
}
}
正常返回示例
{
"code": 200,
"data": 10,
"message": "success"
}
错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|
物理删除用户的消息记录
定义描述
|
path
|
版本
|
描述
|
是否需要用户的身份鉴权
|
|
/message/center/record/delete/physical
|
1.0.1
|
物理删除当前用户的消息记录
|
是，客户端SDK需启用身份的鉴权
|
请求参数
| 字段名 | 子键 | 类型 | 是否必填 | 备注 |
|---|---|---|---|---|
| requestDTO | Map | |||
| type | String | Y | MESSAGE: 透传 NOTICE:推送 | |
| messageType | String | N | ||
| id | Long | N | 消息记录id | |
| maxId | Long | N | 查询条件：id <maxId | |
| minId | Long | N | 查询条件: id >minId |
返回参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| data | Integer | 删除的记录数量 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"requestDTO": {
"type": "NOTICE"
}
}
}
正常返回示例
{
"code": 200,
"data": 10,
"message": "success"
}
错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|
更新用户的消息记录
定义描述
|
path
|
版本
|
描述
|
是否需要用户身份的鉴权
|
|
/message/center/record/modify
|
1.0.1
|
更新当前用户的消息记录
目前仅支持更新只读状态
|
是，客户端SDK需启用身份的鉴权
|
请求参数
|
字段名
|
子键
|
类型
|
是否必填
|
备注
|
|
requestDTO
|
Map
|
|||
|
id
|
Long
|
N
|
消息记录id
|
|
|
type
|
String
|
Y
|
MESSAGE: 透传 NOTICE:推送
|
|
|
messageType
|
String
|
N
|
||
|
maxId
|
Long
|
N
|
查询条件：id <maxId
|
|
|
minId
|
Long
|
N
|
查询条件: id >minId
|
|
|
isRead
|
Integer
|
N
|
需要更新的阅读状态
0：未读
1：已读
|
返回参数
| 字段名 | 类型 | 描述 |
|---|---|---|
| data | Integer | 更新的记录数量 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request": {
"apiVer": "1.0.1",
"iotToken": "token"
},
"params": {
"requestDTO": {
"type": "NOTICE"
}
}
}
正常返回示例
{
"code": 200,
"data": 5,
"message": "success"
}
错误码
| 错误码 | 错误信息 | 描述 |
|---|---|---|