Add Scheduled Task

Last Updated on : 2023-07-25 05:59:27download

Add a scheduled task under the specified device.

API address

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

Request parameter

Parameter name	Type	IN	Required	Description
device_id	String	path	true	The device ID.

Description of body

Parameter name	Type	IN	Required	Description
alias_name	String	body	true	The alias of the specified scheduled task.
time	String	body	true	The time when the specified scheduled task is run.
timezone_id	String	body	true	The ID of the specified time zone. Example: Asia/Shanghai.
date	String	body	false	The date when the specified scheduled task is run.
loops	String	body	false	If a request failed, the return value is a seven-digit number consisting of `0` and `1`. `0` indicates that the scheduled task is disabled, and `1` indicates that the scheduled task is enabled. For example, `0000001` means that the scheduled task is disabled on Sunday, Monday, Tuesday, Wednesday, Thursday, and Friday, and enabled on Saturday.
functions	List	body	true	The command to be executed at the specified time.
category	String	body	false	The category of the specified scheduled task.

Description of functions

Parameter name	Type	IN	Required	Description
code	String	body	true	The code of the specified command to be executed.
value	object	body	true	The value of the specified command to be executed.

Return parameter

Parameter name	Type	Description
result	Response	The returned result.

Description of result

Parameter name	Type	Description
time_id	String	The ID of the specified scheduled task.

Request example

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

{
  "alias_name": "Scheduled Task Test",
  "time": "14:52",
  "timezone_id": "Asia/Shanghai",
  "date": "20230330",
  "functions": [
    {
      "code": "switch_1",
      "value": true
    }
  ]
}

Return example

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

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocQuery Scheduled Task

Next DocModify Scheduled Task