定时任务管理
更新时间:2026-07-30
查询设备定时任务列表
接口描述
查询当前设备下已启用的定时任务列表,无匹配任务时返回空数组。
请求语法
JSON
1GET /v2/aiagent/timing_tasks HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | String | 是 | RequestParam | 互动应用id |
| deviceId | String | 是 | RequestParam | 设备id |
请求示例
JSON
1GET https://rtc-aiagent.baidubce.com/v2/aiagent/timing_tasks?appId=appxxx&deviceId=devicexxx
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
响应参数
| 名称 | 类型 | 描述 |
|---|---|---|
| data | Array | 定时任务列表;该设备无已启用定时任务时返回空数组 |
| data[].id | Integer | 定时任务id |
| data[].appId | String | 互动应用id |
| data[].deviceId | String | 设备id |
| data[].description | String | 定时任务描述,来源于创建任务时的原始用户query |
| data[].createTime | String | 定时任务创建时间,格式为 yyyy-MM-dd HH:mm:ss,时区为 Asia/Shanghai |
| data[].scheduleConf | String | 调度配置,cron 表达式或服务端保存的调度配置字符串 |
响应示例
JSON
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3date: Mon, 05 Sep 2022 03:25:43 GMT
4transfer-encoding: chunked
5content-type: application/json;charset=UTF-8
6cache-control: no-cache
7
8{
9 "data": [
10 {
11 "id": 1001,
12 "appId": "appxxx",
13 "deviceId": "devicexxx",
14 "description": "每天上午9点提醒我开会",
15 "createTime": "2026-07-08 10:30:00",
16 "scheduleConf": "0 0 9 * * ?"
17 }
18 ]
19}
错误码
| HTTP状态码 | 错误信息 | 描述 |
|---|---|---|
| 400 | appId is required | appId 缺失或为空 |
| 400 | deviceId is required | deviceId 缺失或为空 |
| 500 | Internal Server Error | 服务端内部错误 |
删除设备定时任务
接口描述
按定时任务id批量删除当前设备下的定时任务。接口会校验任务归属,只删除属于请求中 appId 和 deviceId 的任务;不属于该设备或不存在的id会被跳过。
请求语法
JSON
1DELETE /v2/aiagent/timing_tasks HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | String | 是 | RequestBody | 互动应用id |
| deviceId | String | 是 | RequestBody | 设备id |
| ids | Array |
是 | RequestBody | 待删除的定时任务id列表,应传入非空数组;为空或不传时服务端不会删除任何任务 |
请求示例
JSON
1DELETE https://rtc-aiagent.baidubce.com/v2/aiagent/timing_tasks
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
6
7{
8 "appId": "appxxx",
9 "deviceId": "devicexxx",
10 "ids": [1001, 1002]
11}
响应参数
无
响应示例
JSON
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3date: Mon, 05 Sep 2022 03:25:43 GMT
4transfer-encoding: chunked
5content-type: application/json;charset=UTF-8
6cache-control: no-cache
错误码
| HTTP状态码 | 错误信息 | 描述 |
|---|---|---|
| 400 | appId is required | appId 缺失或为空 |
| 400 | deviceId is required | deviceId 缺失或为空 |
| 500 | Internal Server Error | 服务端内部错误 |
新增设备定时任务
接口描述
直接创建设备定时任务,不经过自然语言解析。支持 Quartz CRON 表达式和绝对时间两种调度格式。接口会校验任务数量上限(默认 100 条/设备)及调度时间有效性。
请求语法
JSON
1POST /v2/aiagent/timing_tasks HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| appId | String | 是 | RequestBody | 互动应用id |
| deviceId | String | 是 | RequestBody | 设备id |
| title | String | 是 | RequestBody | 任务标题;同时作为查询接口返回的 description 字段内容 |
| scheduleConf | String | 是 | RequestBody | 调度配置,支持两种格式:Quartz CRON 表达式(如 0 30 9 * ? ),Quartz CRON 格式共 7 个字段,空格分隔,年字段可省略: 秒 分 时 日 月 周 年,循环闹钟创建格式,或者绝对时间字符串(格式yyyy-MM-dd HH:mm:ss,仅触发一次;调度时间必须为未来时间 。例如:0 0 7,12,18 * ? 每天 7:00、12:00、18:00 各触发一次, 0 0 9 1 1 ? 2027 在 2027 年元旦 9:00,仅触发一次,0 30 8 * ? 每天早上 8:30 |
| alarmInfo | String | 否 | RequestBody | 到点播报文案;不传时由服务端根据 title 自动生成 |
请求示例
JSON
1POST https://rtc-aiagent.baidubce.com/v2/aiagent/timing_tasks
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
6
7{
8 "appId": "appxxx",
9 "deviceId": "devicexxx",
10 "title": "喝水提醒",
11 "scheduleConf": "0 0 9 * * ? *",
12 "alarmInfo": "该喝水了!"
13 }
响应参数
| 名称 | 类型 | 参数位置 | 描述 |
|---|---|---|---|
| id | Integer | RequestBody | 定时任务id |
响应示例
JSON
1HTTP/1.1 200 OK
2x-bce-request-id: b06a9214-04d6-4a08-9f5d-966b04604cfb
3date: Mon, 05 Sep 2022 03:25:43 GMT
4transfer-encoding: chunked
5content-type: application/json;charset=UTF-8
6cache-control: no-cache
7{
8 "id": 1003
9 }
错误码
| HTTP状态码 | 错误信息 | 描述 |
|---|---|---|
| 400 | InvalidParameter | 必填参数缺失或为空;或 scheduleConf 格式无法解析 |
| 400 | InvalidNewTime | 新 scheduleConf 对应的调度时间已过期或无效 |
| 400 | JobSizeLimitExceeded | 该设备下定时任务数量已达上限,需先删除部分任务 |
| 500 | Internal Server Error | 服务端内部错误 |
更新设备定时任务
接口描述
按任务id更新已有定时任务的字段,不经过自然语言解析。所有可选字段均支持部分更新:不传(null)表示保留原值;callBackUrl 传空字符串表示清空回调地址并切换回客户端推送模式。接口会校验任务归属,appId 或 deviceId 不匹配时拒绝更新。 字段更新顺序:scheduleConf → title → alarmInfo,显式传入的 alarmInfo 优先级最高,会覆盖由 title 变更自动生成的播报文案。
请求语法
JSON
1PUT /v2/aiagent/timing_tasks/{id} HTTP/1.1
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: <bce-authorization-string>
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 名称 | 类型 | 是否必选 | 参数位置 | 描述 |
|---|---|---|---|---|
| id | Long | 是 | PathVariable | 待更新的定时任务id |
| title | String | 否 | RequestBody | 新任务标题;更新时服务端同步刷新自动生成的播报文案,可被显式 alarmInfo 覆盖 |
| scheduleConf | String | 否 | RequestBody | 调度配置,支持两种格式:Quartz CRON 表达式(如 0 30 9 * ? ),Quartz CRON 格式共 7 个字段,空格分隔,年字段可省略: 秒 分 时 日 月 周 年,循环闹钟创建格式,或者绝对时间字符串(格式yyyy-MM-dd HH:mm:ss,仅触发一次;调度时间必须为未来时间 ,例如:0 0 7,12,18 * * ? │ 每天 7:00、12:00、18:00 各触发一次 |
| alarmInfo | String | 否 | RequestBody | 新播报文案;显式传入时优先级最高,覆盖由 title 自动生成的文案 |
请求示例
JSON
1PUT https://rtc-aiagent.baidubce.com/v2/aiagent/timing_tasks/1003
2host: rtc-aiagent.baidubce.com
3content-type: application/json
4authorization: {bce-authorization-string}
5x-bce-request-id: {bce-request-id}
6
7{
8 "id": "xxxx",
9 "scheduleConf": "0 30 10 * * ? *"
10 }
响应参数
响应示例
错误码
| HTTP状态码 | 错误信息 | 描述 |
|---|---|---|
| 400 | InvalidParameter | 必填参数 appId / deviceId 缺失;或任务id不存在;或归属校验不匹配;或 scheduleConf 格式无法解析 |
| 400 | InvalidNewTime | 新 scheduleConf 对应的调度时间已过期或无效 |
| 500 | Internal Server Error | 服务端内部错误 |
评价此篇文章
