调用该接口获取设备预约定时场景的列表。

路径 /scene/timing/list/get
版本号 1.0.5
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权
超时时间 15000

请求参数

名称 类型 是否必选 示例值 描述
pageNo Int 1 分页页码,从 1 开始。
pageSize Int 20 分页大小。取值范围:1~100。
associatedId String testDeviceIotId 场景关联的ID。可传入设备ID、控制组ID。传入设备ID则定时与设备关联;传入控制组ID则定时与控制组关联。
idType String DEVICE 场景关联ID的类别。可传入:DEVICE(表示定时属于设备);CONTROL_GROUP(表示定时属于控制组)。

返回数据

名称 类型 示例值 描述
code Int

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

message String

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

localizedMsg String

本地语言的错误消息。

data JSON

场景信息列表。

total Int

场景总数。

pageNo Int

返回当前页序号,从1开始。

pageSize Int

分页大小。

scenes JSON

场景列表。

id String

场景的ID。

enable Boolean

APP上的场景开关状态。true(表示打开,场景可以正常被触发执行);false(表示关闭,即便达到触发条件,场景也不会执行)。

icon String

场景的图标。

iconColor String

场景图标的颜色。

name String

场景的名称。

description String

场景描述。

valid Boolean

场景是否有效。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.5",
		"iotToken": "token"
	},
	"params":{
		"pageNo":1,
		"pageSize":20,
		"associatedId": "testDeviceIotId",
		"idType": "DEVICE"
	}
}

正常返回示例

JSON 格式

{
    "code":200,
    "data":{
        "total":2,
        "pageNo":1,
        "pageSize":15,
        "scenes":[
            {
                "id":"testSceneId01",
                "enable":false,
                "icon":"https://www.xxx.com/xxx.png",
                "name":"测试场景名01",
                "description":"这是一个测试场景",
                "valid":1
            },
            {
                "id":"testSceneId02",
                "enable":false,
                "icon":"https://www.xxx.com/xxx.png",
                "name":"测试场景名01",
                "description":"这是一个测试场景",
                "valid":1
            }
        ]
    },
    "message":"success"
}

异常返回示例

JSON 格式

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