获取家下指定房间的详情信息

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

请求参数

名称 类型 是否必选 示例值 描述
homeId String 50f5op1556f65de314b983fd5bca4f2f2810**** 家的 ID,生活物联网平台赋予家的唯一标识符。
roomId String 50f5op1556f65de314b983fd5bca4f2f2810**** 房间的 ID,生活物联网平台赋予房间的唯一标识符。

返回数据

名称 类型 示例值 描述
code Int

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

message String

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

localizedMsg String

本地语言的错误信息。

data JSON

房间详情信息。

roomId String

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

name String

房间的名称。

createMillis Long

房间的创建时间。

deviceCnt Int

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

backgroudImage String

房间的背景图标标识。

deviceOnlineCnt Int

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

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1",
		"iotToken": "token"
	},
	"params":{
		"homeId": "50f5op1556f65de314b983fd5bca4f2f2810****",
		"roomId": "50f5op1556f65de314b983fd5bca4f2f2810****"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "roomId":"xxx",
        "name":"房间名称",
        "backgroudImage":"https://xxx.png",
        "deviceCnt":10,
        "deviceOnlineCnt":7,
        "createMillis":1569232952000
    }
}

异常返回示例

JSON 格式

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