新增设备定时

更新时间：2023-07-25 05:59:25下载pdf

本文介绍新增设备定时的 API。

接口描述

为指定设备新增一个定时任务。

接口地址

POST: /v2.0/cloud/timer/device/{device_id}

请求参数

参数名	类型	参数位置	是否必填	说明
device_id	String	path	true	设备 ID。

body 说明

参数名	类型	参数位置	是否必填	说明
alias_name	String	body	true	定时任务别名。
time	String	body	true	执行定时任务的时间。
timezone_id	String	body	true	时区 ID，比如 Asia/Shanghai。
date	String	body	false	执行定时任务的日期。
loops	String	body	false	如果请求失败，返回由 `0` 和 `1` 组成的七位数字。`0` 代表关闭，`1` 代表开启。例如，`0000001` 代表周日、周一、周⼆、周三、周四、周五定时任务关闭，周六定时任务开启。
functions	List	body	true	定时执行的指令。
category	String	body	false	定时任务的分类。

functions 说明

参数名	类型	参数位置	是否必填	说明
code	String	body	true	将要执⾏指令的 code。
value	object	body	true	将要执⾏指令的 value。

返回参数

参数名	类型	说明
result	Response	返回结果。

result 说明

参数名	类型	说明
time_id	String	定时任务 ID。

请求示例

POST: /v2.0/cloud/timer/device/6ccb7dc348****

{
  "alias_name": "测试定时",
  "time": "14:52",
  "timezone_id": "Asia/Shanghai",
  "date": "20230330",
  "functions": [
    {
      "code": "switch_1",
      "value": true
    }
  ]
}

返回示例

{
    "tid": "74e53698d1f611ed9aa2525400d49d82",
    "result": {
        "timer_id": "1****"
    },
    "t": 1680509198203,
    "success": true
}

错误码

参考错误码。

调用频率限制

参考调用频率限制。