调用该接口获取家下的房间列表。

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

请求参数

名称 类型 是否必选 示例值 描述
homeId String 是 50f5op1556f65de314b983fd5bca4f2f2810**** 家的 ID，生活物联网平台赋予家的唯一标识符。
pageNo Int 是 1 分页页码，从 1 开始。
pageSize Int 是 20 分页大小，取值范围：1~ 20。

返回数据

名称 类型 示例值 描述
code Int

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

调用失败时，返回的出错信息。
localizedMsg String

本地语言的错误信息。
data JSON

响应结果。
total Long

满足条件的房间总数。
pageNo Int

分页页码。
pageSize Int

分页大小。
items JSON

满足条件的房间详情。
roomId String

房间的 ID，生活物联网平台赋予房间的唯一标识符。
name String

房间的名称。
deviceCnt Int

归属于该房间的设备总数。
createMillis Long

房间的创建时间，UNIX 时间戳。单位：毫秒。
backgroudImage String

房间的背景图标标识。
deviceOnlineCnt Int

归属于该房间的在线设备总数。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1",
		"iotToken": "token"
	},
	"params":{
		"homeId": "50f5op1556f65de314b983fd5bca4f2f2810****",
		"pageNo":1,
		"pageSize":20
	}
}

正常返回示例

JSON 格式 

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "total":2,
        "pageNo":1,
        "pageSize":10,
        "items":[
            {
                "roomId":"xxx1",
                "name":"xxx1",
                "backgroudImage":"https://xxx.png",
                "deviceCnt":10,
                "deviceOnlineCnt":8,
                "createMillis":1569232952000
            },
            {
                "roomId":"xxx2",
                "name":"xxx2",
                "backgroudImage":"https://xxx.png",
                "deviceCnt":7,
                "deviceOnlineCnt":5,
                "createMillis":1569232952000
            }
        ]
    }
}

异常返回示例

JSON 格式 

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