1. 接口描述
接口请求域名:
iot.cloud.tencent.com/api/exploreropen/tokenapi
。
本接口(AppCreateTimer)用于用户创建设备的定时任务。2. 输入参数
名称 | 类型 | 必选 | 描述 |
AccessToken | String | 是 | 公共参数,AccessToken 用于对一个已经登录的用户鉴权。 |
RequestId | String | 是 | 公共参数,唯一请求 ID,可自行生成,推荐使用 uuid。定位问题时,需提供该次请求的 RequestId。 |
Action | String | 是 | 公共参数,本接口取值 AppCreateTimer。 |
ProductId | String | 是 | 新建定时任务所属产品 ID。 |
DeviceName | String | 是 | 新建定时任务控制的设备名称。 |
TimerName | String | 是 | 定时器的名称。 |
Days | String | 是 | 定时器开启时间,每一位,0:关闭,1:开启,从左至右依次表示:周日、周一、周二、周三、周四、周五、周六。 |
TimePoint | String | 是 | 定时器开启时间点。 |
Repeat | int | 是 | 是否循环。 0:不需要。 1:需要。 |
Data | String | 是 | 定时器启动时下发的控制报文。 |
3. 输出参数
名称 | 类型 | 描述 |
RequestId | String | 公共参数,唯一请求 ID,与入参相同,定位问题时,需提供该次请求的 RequestId。 |
TimerId | String | 定时器 ID。 |
TimerName | String | 定时器名称。 |
4. 示例
输入示例
POST https://iot.cloud.tencent.com/api/exploreropen/tokenapi HTTP/1.1content-type: application/json{"RequestId": "req_1","Action": "AppCreateTimer","ProductId": "US4*****IK","DeviceName": "411_3","AccessToken": "c1******************847e","TimerName": "timer_test","Days": "1000000", // 每一位 0:关闭,1:开启, 从左至右依次表示: 周日 周一 周二 周三 周四 周五 周六"TimePoint": "06:30","Repeat": 1, //是否需要循环 0:不需要 1 需要"Data": "{\\"brightness\\": 25}"}
输出示例:成功
{"Response": {"Data": {"TimerId": "e0e23a2b33a24652b6**********a1cf","TimerName": "timer_test"},"RequestId": "req_1"}}
5. 错误码
错误码 | 描述 |
InternalError | 内部错误。 |
InvalidParameterValue | 参数取值错误。 |
InvalidParameterValue.InvalidAccessToken | Token 无效。 |