本文档提供一组消息记录的历史操作服务接口，生活物联网平台已推出相应的新接口，建议您切换至新接口。

查询用户的消息记录（历史接口）

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/center/push/record/query 1.0.1 查询当前用户的消息记录 是，客户端SDK需启用身份的鉴权，进行身份认证
说明 平台已新增查询用户的消息记录接口/message/center/query/push/message，新接口可以兼容原有的查询消息记录的逻辑，并提升了性能，推荐您使用该接口。

请求参数

字段名 子键 类型 是否必填 备注
requestDTO JSON 是 查询当前用户消息的请求信息列表
startCreateTime Long 否 查询的开始时间，单位毫秒
endCreateTime Date 否 查询的结束时间，单位毫秒
messageType String 否 消息类型，取值为device表示设备；announcement表示通知；share表示分享。如果该参数为空，则查询所有类型的数据
type String 是 推送类型
  • NOTICE：弹窗通知消息，推荐
  • MESSAGE：非弹窗类型消息，如透传消息
maxId Long 否 查询条件：id <maxId
minId Long 否 查询条件：id >minId
pageNo Integer 是 分页页数，从1开始
pageSize Integer 是 分页大小，最大100
isRead Integer 否 0：未读； 1：已读
sortType Integer 否
  • null或0：gmtCreate倒排
  • 1：gmtCreate正排
iotId String 否 设备ID，生活物联网平台为设备颁发的ID，设备的唯一标识符。
gatewayId String 否 网关ID，用于过滤网关及网关下所有子设备的消息记录

返回参数

参数 子参数 二级子参数 类型 描述
total Long 返回的消息记录的总条数
pageNo Integer 返回的消息记录所在的当前页
pageSize Integer 返回消息记录的分页大小
data JSON Array 返回的消息记录的详细信息
id Long 消息id
gmtCreate Long 创建时间，单位毫秒
gmtModified Date 修改时间，单位毫秒
appKey Long 应用的appKey
title String 消息记录的标题
body String 消息内容
messageType String 否 消息类型，取值为device表示设备；announcement表示通知；share表示分享。如果该参数为空，则查询所有类型的数据
isRead Integer 阅读状态， 0：未读； 1：已读
extData JSON 附加信息
iotId String 设备id
productKey String 产品key
productName String 产品名称
icon String 图标
extParam String 业务附加信息

示例

  • 请求示例 
    {
    "id": "1509086454180", 
    "version": "1.0", 
    "request": {
        "apiVer": "1.0.1", 
        "iotToken": "token"
    }, 
    "params": {
        "requestDTO": {
            "type": "NOTICE", 
            "pageNo": 1, 
            "pageSize": 20
        }
    }
}
  • 正常返回示例 
    {
    "code": 200, 
    "data": {
        "total": 1, 
        "pageNo": 1, 
        "pageSize": 20, 
        "data": [
            {
                "appKey": 1234567, 
                "body": "温度高", 
                "extData": {
                    "categoryId": 100, 
                    "iotId": "iotId1", 
                    "productKey": "xxxxxx", 
                    "productName": "xxxxxx", 
                    "extParam": ""
                }, 
                "gmtCreate": 1525351832000, 
                "gmtModified": 1525351851000, 
                "id": 1000000000000200400, 
                "isRead": 1, 
                "messageId": "-1", 
                "messageType": "device", 
                "title": "测试", 
                "type": "NOTICE"
            }
        ]
    }, 
    "message": "success"
}

查询用户的消息记录（历史接口）

定义描述

path 版本 描述 是否需要用户身份的鉴权
/message/center/record/query 1.0.6 查询当前用户的消息记录 是，客户端SDK需启用身份的鉴权，进行身份认证

请求参数

字段名 子键 类型 是否必填 备注
requestDTO JSON
startCreateTime Long N 查询的开始时间，单位毫秒
endCreateTime Date N 查询的结束时间，单位毫秒
messageType String N 消息类型分为设备（device）、通知（announcement）、分享（share），如果三个类型都不指定（该参数为空），则查询返回所有的数据
type String Y
  • MESSAGE：透传消息
  • NOTICE：通知消息
maxId Long N 查询条件：id <maxId
minId Long N 查询条件：id >minId
pageNo Integer Y 分页页数，从1开始
pageSize Integer Y 分页大小，最大100
isRead Integer N 0：未读； 1：已读
sortType Integer N null or 0: gmtCreate倒排 1: gmtCreate正排
iotId String N 设备id：从 1.0.6起开放

返回参数

子键 二级子键 三级子键 四级子键 类型 描述
JSON
count Long 总数
data JSON List
id Long 消息id
gmtCreate Long 创建时间
gmtModified Date 修改时间
appKey Long
title String
body String
messageType String 消息类型：设备、共享、通知
isRead Integer 阅读状态， 0：未读； 1：已读
extData JSON 附加信息
device JSON 设备信息
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": "温度高",
            "extData": {
                "device": {
                    "categoryId": 100,
                    "iotId": "iotId1",
                    "productKey": "p1",
                    "productName": "1"
                }
            },
            "gmtCreate": 1525351832000,
            "gmtModified": 1525351851000,
            "id": 100000xxxx200439,
            "isRead": 1,
            "messageId": "-1",
            "messageType": "device",
            "title": "测试",
            "type": "NOTICE"
        }]
    },
    "message": "success"
}

物理删除用户的消息记录（历史接口）

定义描述

path 版本 描述 是否需要用户的身份鉴权
/message/center/record/delete/physical 1.0.6 物理删除当前用户的消息记录 是，客户端SDK需启用身份的鉴权，进行身份认证
说明 接口/message/center/record/delete已兼容物理删除当前用户消息记录的能力，推荐您使用该接口。

请求参数

字段名 子键 类型 是否必填 备注
requestDTO JSON
type String 是 推送类型
  • NOTICE：弹窗通知消息，推荐
  • MESSAGE：非弹窗类型消息，如透传消息
messageType String 否 消息类型，取值为device表示设备；announcement表示通知；share表示分享。如果该参数为空，则查询所有类型的数据
id Long 否 消息记录id
maxId Long 否 删除条件：id < maxId
minId Long 否 删除条件：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"
}