调用该接口查询用户的消息推送记录。

路径 /message/center/query/push/message
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 3000

请求参数

名称 类型 是否必选 示例值 描述
nextToken Int 0 推送记录查询偏移量,最小值为0。
maxResults Int 20 每次查询的条数。取值范围:1~100。
type String 'NOTICE' 推送类型,可取值:NOTICE(表示弹窗通知);MESSAGE(表示消息)。
startCreateTime Long 1600617600000 查询推送消息的起始时间。时间戳格式,查询范围最大为7天。
endCreateTime Long 1600676282000 查询推送消息的结束时间。时间戳格式,查询范围最大为7天。
sortType Int 0 查询结果排序类型。0(表示按照消息创建时间倒序);1(表示按照消息创建时间正序)。
messageType String 'device' 消息类型。可取值:share(表示设备分享);device(表示设备告警);announcement(表示公告)。
iotId String 'GJG0z***X000100' 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。
iotIds List ['GJG0zxxxxxx000101','GJG0zxxxxxx000102'] 设备ID的列表。
id Long 2000000001457719449 主键ID,每条消息对应唯一的主键ID。
isRead Int 0 消息状态。0(表示未读);1(表示已读)。
eventType Int 1 摄像头告警事件类型。

返回数据

名称 类型 示例值 描述
code Int

接口返回码。200表示成功。

message String

调用失败时,返回的出错信息。

localizedMsg String

本地语言的错误消息。

data JSON

接口返回的业务对象。

nextToken Int

返回的当前调用读取到的位置偏移量,为0代表数据已经读取完毕。

maxResults Int

本次返回的最大记录条数。

data JSON

返回的业务参数。

id Long

主键ID,每条消息对应唯一主键ID。

keyId String

主键的string格式。

gmtCreate Long

消息创建的时间。

gmtModified Long

消息记录的修改时间。

messageId String

消息ID,由消息通道返回的ID。

type String

推送类型,可取值:NOTICE(表示弹窗通知);MESSAGE(表示消息)。

deviceType String

设备类型,可取值:iOS,Android。

target String

推送目标,可取值:ACCOUNT(表示用户),DEVICE(表示设备)。

targetValue String

推送目标对应的ID。

title String

返回消息的标题。

body String

返回消息的内容。

isRead Int

消息状态, 0(表示未读);1(表示已读)。

messageType String

消息类型,可取值:SHARE(表示设备分享);DEVICE(表示设备告警);ANNOUNCEMENT(表示公告)。

tag Int

返回消息的标签。

eventId String

触发消息的事件ID。

iotId String

设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。

gatewayId String

IoT设备所属网关的网关设备ID。

extData JSON

扩展参数,由业务自定义的内容。

iotId String

设备ID。

productKey String

产品的Key,设备证书信息之一。创建产品时,生活物联网平台为该产品颁发的全局唯一标识。

productName String

产品名称

categoryId Long

产品分类ID。

icon String

消息对应的图标地址。

nickName String

设备的昵称或别名。

extParam String

其他自定义扩展参数。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1",
		"iotToken": "token"
	},
	"params":{
		"nextToken":0,
		"maxResults":20,
		"type": "'NOTICE'",
		"startCreateTime":1600617600000,
		"endCreateTime":1600676282000,
		"sortType":0,
		"messageType": " 'device'",
		"iotId": "'GJG0z***X000100'",
		"iotIds":[
			"GJG0zxxxxxx000101",
			"GJG0zxxxxxx000102"
		],
		"id":2000000001457719449,
		"isRead":0,
		"eventType":1
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": [
        {
            "body":"设备已被重置",
            "deviceType":"ALL",
            "eventId":"1234",
            "extData":{"categoryId":60,"icon":"http://****-paas-admin.oss-cn-shanghai.aliyuncs.com/026724807.png","iotId":"OYS3Gp6NudfxxxxUabd00102","nickName":"设备","productKey":"a2dkcxxxxMU","productName":"smart socket ","extParam":"xxx"},
            "gmtCreate":1576036624000,
            "gmtModified":1576036624000,
            "id":351793,
            "iotId":"OYS3Gp6****W000102",
            "isRead":0,
            "messageId":"-1",
            "messageType":"device",
            "tag":0,
            "target":"ACCOUNT",
            "targetValue":"50c9opb844a3c078cd7e8ce826ad67b81e101898",
            "title":"warning ",
            "type":"NOTICE"
        }
        ]
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}