调用该接口同时查询场景和自动化的列表。

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

请求参数

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

返回数据

名称 类型 示例值 描述
code Int

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

message String

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

localizedMsg String

本地语言的错误消息。

data JSON

响应的结果。

manual JSON

场景列表信息。

total Int

场景总数。

scenes JSON

场景列表。

id String

场景的ID。

status Int

场景的状态。1(表示上线);2(表示下线)。

enable Boolean

APP上的场景开关。true(表示场景置为打开);false(表示场景置为关闭)。

icon String

场景图标的链接。

name String

场景的名称。

description String

对场景的描述。

iconColor String

场景的图标颜色。

valid Boolean

场景是否有效。当场景中的设备被解绑时,自动化会变为无效状态,此时该字段为true。

catalogId String

场景分类。0 (表示手动场景即 App 上的 “场景”);1(表示自动场景,即 App 上的 “自动化”);空(表示老版场景)。

pageNo Int

返回的当前页号。

pageSize Int

返回当前页的大小。

automatic JSON

自动化列表信息。

total Int

自动化总数。

scenes JSON

自动化列表。

id String

自动化场景ID。

status Int

自动化的状态。1(表示上线);2(表示下线)。

enable Boolean

APP上的自动化开关。true(表示打开);false(表示关闭)。

icon String

自动化图标。

name String

自动化名称。

description String

对自动化的描述。

iconColor String

自动化图标颜色。

valid Boolean

自动化是否有效。当自动化中的设备被解绑时,自动化会变为无效状态,此时该字段为true。

catalogId String

场景分类。0 (表示手动场景即 App 上的 “场景”);1(表示自动场景,即 App 上的 “自动化”);空(表示老版场景)。

pageNo Int

返回的当前页号。

pageSize Int

返回的页大小。

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.2",
		"iotToken": "token"
	},
	"params":{
		"pageNo":1,
		"pageSize":10,
		"homeId": "123"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": {
        "automatic":{
            "total":1,
            "pageNo":1,
            "scenes":[
                {
                    "valid":true,
                    "catalogId":"1",
                    "enable":true,
                    "icon":"http://gaic.alicdn.com/ztms/cloud-intelligence-icons/icons/scene_img_choice_icon_4.png",
                    "name":"testAutomationName",
                    "iconColor":"#FFFFFF",
                    "description":"信息提醒",
                    "id":"c47e5fb1921e4f2db0ebb83d965049e6",
                    "status":1
                }
            ],
            "pageSize":10
        },
        "manual":{
            "total":1,
            "pageNo":1,
            "scenes":[
                {
                    "valid":true,
                    "catalogId":"0",
                    "enable":true,
                    "icon":"http://gaic.alicdn.com/ztms/cloud-intelligence-icons/icons/scene_img_choice_icon_4.png",
                    "name":"日常灯智能-工作模式 - 柔和",
                    "iconColor":"#FFFFFF",
                    "description":"日常灯智能_主灯开关_关闭",
                    "id":"7c642f6ec5034bfcbff779035e6cd438"
                }
            ],
            "pageSize":10
        }
    }
}

异常返回示例

JSON 格式

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