定时管理

API 列表

API	描述
timer.add	设备添加定时任务
timer.list	查询设备下的定时任务列列表
timer.listByCategory	获取指定设备下某⼀个分类中的定时任务信息
timer.edit	更新设备的某⼀个定时任务的信息
timer.status	更新设备定时任务组的状态
timer.delete	删除设备下的所有定时任务
timer.deleteByCategory	删除某个定时分类的所有定时任务
timer.deleteByGroup	删除某个分类中的某个定时组的定时任务

设备添加定时任务

接口描述

该接口为设备添加定时任务。参数 loops 用于将任务设置为 循环定时任务 或 非循环定时任务。

• 循环定时：以一周为循环，可设定周一到周日的循环定时。
• 非循环定时：设定指定时间节点的定时任务，接口会对设定的时间节点做限定。该时间节点需要在当前时间之后，否则无法创建定时任务，并提示定时任务已过期。

请求地址

action: timer.add

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是
category	String	定时分类	是
loops	String	由 0 和 1 组成的七位数字。0 代表关闭，1代表开启。例如，0000010 代表周日、周一、周⼆、周三、周四、周六定时任务关闭，周五定时任务开启	是
time_zone	String	时区，中国区传 +08:00	是
timezone_id	String	时区 ID，比如 Asia/shanghai	是
instruct	Array	定时任务具体的时间和设备指令，⽀持同时设置多个定时任务	是

instruct 说明

参数名	类型	说明	必填
time	String	定时任务执行的时间	是
date	String	定时任务执行的日期。传 date 时，loops 为0000000，date 格式：20181212	否
functions	Array	定时执行的指令	是

functions 说明

参数名	类型	说明	必填
code	String	要执⾏指令的 code	是
value	Object	要执⾏指令的 value	是

请求示例

{
	"action": "timer.add",
	"params": {
    "device_id":"vdevo158417166464619",
    "loops":"0000000",
    "category":"test",
    "timezone_id":"Asia/Shanghai",
    "time_zone":"+8:00",
    "instruct":[
        {
            "functions":[
                {
                    "code":"switch",
                    "value":true
                },
                {
                	"code":"switch_vertical",
                    "value":true
                }
            ],
            "date":"20200320",
            "time":"17:41"
        }
    ]
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
group_id	String	定时任务的 ID

响应示例

{
    "success": true,
    "result": {
        "group_id": "0000002ftg"
		} 
}

查询设备下的定时任务列表

接口描述

可查询指定设备 ID 下已添加定时任务的详细信息列表。

接口地址

action: timer.list

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是

请求示例

{
	"action": "timer.list",
	"params": {
    "device_id":"vdevo158417166464619"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
groups	Array	定时任务信息列表
category	Object	定时任务的分类状态信息

groups 说明

参数名	类型	说明
timers	Object	定时任务信息
id	String	定时任务编号

category 说明

参数名	类型	说明
category	String	定时任务的分类
status	Integer	定时任务的分类的状态

timers 说明

参数名	类型	说明
date	String	设置定时的日期
timezone_id	String	时区 ID
loops	String	循环定时信息
time	String	设置的时间
status	Integer	定时任务的状态 0：关闭 1：开启 2：删除
functions	Array	定时的指令
group_order	Integer	指定排序
is_app_push	Boolean	是否推送 App （待定）
timer_id	Integer	定时信息的唯一标识

functions 说明

参数名	类型	说明	必填
code	String	要执⾏指令的 code	是
value	Object	要执⾏指令的 value	是

响应示例

{
    "result": [
        {
            "category": {
                "category": "test",
                "status": 1
            },
            "groups": [
                {
                    "id": "000000mwf3",
                    "timers": [
                        {
                            "date": "20200210",
                            "functions": [
                                {
                                    "code": "bright_value_v2",
                                    "value": 5000
                                },
                                {
                                    "code": "switch_led",
                                    "value": true
                                }
                            ],
                            "group_order": 0,
                            "is_app_push": false,
                            "loops": "0000000",
                            "status": 0,
                            "time": "17:30",
                            "timer_id": 4906528,
                            "timezone_id": "Asia/Shanghai"
                        }
                    ]
                }
            ]
        }
    ],
    "success": true,
    "t": 1581336613789
}

获取设备某一个分类中的定时任务信息

接口描述

获取指定设备下某⼀个分类中的定时任务信息。

接口地址

action: timer.listByCategory

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是
category	String	定时分类	是

请求示例

{
	"action": "timer.listByCategory",
	"params": {
    "device_id":"vdevo158132564936223",
    "category":"test"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Object	返回结果

result 说明

参数名	类型	说明
groups	Array	定时任务信息列表
category	Object	设备状态更新时间

groups 说明

参数名	类型	说明
timers	Object	定时任务信息
id	String	定时任务编号

category 说明

参数名	类型	说明
category	String	定时任务的分类
status	Integer	定时任务的分类的状态

timers 说明

参数名	类型	说明
date	String	设置定时的日期
timezone_id	String	时区 ID
loops	String	循环定时信息
time	String	设置的时间
status	Integer	定时任务的状态 0：关闭 1：开启 2：删除
functions	Array	定时的指令
group_order	Integer	指定排序
is_app_push	Boolean	是否推送 App（暂未开放）
timer_id	Integer	定时信息的唯一标识

functions 说明

参数名	类型	说明	必填
code	String	要执⾏指令的 code	是
value	Object	要执⾏指令的 value	是

响应示例

{
    "result": [
        {
            "category": {
                "category": "test",
                "status": 1
            },
            "groups": [
                {
                    "id": "000000mwf3",
                    "timers": [
                        {
                            "date": "20200202",
                            "functions": [
                                {
                                    "code": "bright_value_v2",
                                    "value": 5000
                                },
                                {
                                    "code": "switch_led",
                                    "value": true
                                }
                            ],
                            "group_order": 0,
                            "is_app_push": false,
                            "loops": "0000000",
                            "status": 0,
                            "time": "17:30",
                            "timer_id": 4906528,
                            "timezone_id": "Asia/Shanghai"
                        }
                    ]
                }
            ]
        }
    ],
    "success": true,
    "t": 1581336613789
}

更新设备的某⼀个定时任务组的信息

接口描述

更新设备的某一个定时任务组的信息。

接口地址

action: timer.edit

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是
group_id	String	定时任务组 ID	是
loops	String	由 0 和 1 组成的七位数字。0 代表关闭，1 代表开启。例如：0000010 代表周日、周⼀、周⼆、周三、周四、周六定时任务关闭，周五定时任务开启	是
category	String	定时任务类别	是
time_zone	String	时区，中国区传 +08:00	是
timezone_id	String	时区 ID，⽐如 Asia/shanghai	是
instruct	Array	定时任务具体的时间和设备指令，支持同时设置多个定时任务	是

instruct 说明

参数名	类型	说明	必填
time	String	定时任务执⾏的时间	是
date	String	定时任务执⾏的日期。传 date 时，loops 为 0000000，date 格式：20181212	否
functions	Array	定时执行的指令	是

functions 说明

参数名	类型	说明	必填
code	String	要执⾏指令的 code	是
value	Object	要执⾏指令的 value	是

请求示例

{
	"action": "timer.edit",
	"params": {
    "device_id":"vdevo158132564936223",
    "group_id":"000000mwf3",
    "loops":"0000000",
    "time_zone":"+08:00",
    "timezone_id":"Asia/ShangHai",
    "category":"test",
    "instruct":[
        {
            "time":"12:00",
            "date":"20181212",
            "functions":[
                {
                    "code":"switch",
                    "value":true
                },
                {
                    "code":"bright",
                    "value":100
                }
            ]
        },
        {
            "time":"12:10",
            "date":"20181212",
            "functions":[
                {
                    "code":"switch",
                    "value":false
                }
            ]
        }
		}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功，失败为空

响应示例

{
    "success": true,
    "result": true
}

更新设备定时任务组的状态

接口描述

更新设备定时任务组的状态。

接口地址

action: timer.status

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是
group_id	String	定时任务组 ID	是
category	String	定时任务组分类	是
status	String	定时任务状态 0：关闭 1：开启 2：删除	是

请求示例

{
	"action": "timer.status",
	"params": {
    "device_id":"vdevo158132564936223",
    "category":"test",
    "group_id":"000000mwf3",
    "status":"0"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功，失败为空

响应示例

{
    "success": true,
    "result": true
}

删除设备下的所有定时任务

接口描述

删除设备下的所有定时任务。

接口地址

action: timer.delete

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是

请求示例

{
	"action": "timer.delete",
	"params": {
    "device_id":"vdevo158132564936223"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功，失败为空

响应示例

{
    "success": true,
    "result": true
}

删除某个定时分类下的所有定时任务

接口描述

删除设备下的所有定时任务。

接口地址

action: timer.deleteByCategory

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是
category	String	定时任务组分类	是

请求示例

{
	"action": "timer.deleteByCategory",
	"params": {
    "device_id":"vdevo158132564936223",
    "category":"test"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功，失败为空

响应示例

{
    "success": true,
    "result": true
}

删除某个分类中的某个定时组的定时任务

接口描述

删除某个分类中的某个定时组的定时任务。

接口地址

action: timer.deleteByGroup

params 请求参数

参数名	类型	说明	必填
device_id	String	设备 ID	是
category	String	定时任务组分类	是
group_id	String	定时任务组 ID	是

请求示例

{
	"action": "timer.deleteByGroup",
	"params": {
    "device_id":"vdevo158132564936223",
    "category":"test",
    "group_id":"0000002ftg"
	}
}

响应参数

参数名	类型	说明
code	Integer	响应码
success	Boolean	是否成功 true：成功 false：失败
msg	String	请求失败的信息，成功为空
result	Boolean	是否成功，失败为空

响应示例

{
    "success": true,
    "result": true
}