Creates a scheduled task for an agent.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| TaskName |
string |
Yes |
The task name. |
Auto-reply to DingTalk messages |
| UserPrompt |
string |
Yes |
The user prompt. |
Open DingTalk and reply to the first 5 unread messages |
| CronExpression |
string |
Yes |
The cron expression. |
0 0 * * * |
| InstanceIds |
array |
Yes |
The list of instance IDs. |
["ai-instance-001"] |
|
string |
No |
The list of cloud phone instance IDs. You can associate up to 3 instances. |
acp-5hh4a31emkt6u**** |
|
| MaxExecutions |
integer |
No |
The maximum number of executions. |
1 |
| RunConfig |
object |
No |
The run configuration. |
{"maxSteps":10,"timeoutSeconds":3600} |
| Skills |
array |
No |
The list of skill IDs, up to 1. Written to aim_task_config.run_config when the scheduled task is created and read when the callback is delivered. |
["sk-abc"] |
|
string |
No |
|||
| MaxSteps |
integer |
No |
The maximum number of execution steps. |
10 |
| TimeoutSeconds |
integer |
No |
The timeout in seconds. |
3600 |
| ExtraParams |
string |
No |
The extended parameters as a JSON string. |
{"batchSize":"1000"} |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
ApiResponse |
||
| RequestId |
string |
The request ID. |
9A51B1DF-96FF-3BCC-B08C-783161D3**** |
| Code |
string |
The API status code. |
200 |
| Message |
string |
The response message. |
Success. |
| TotalCount |
integer |
The total number of records. |
1 |
| Tasks |
array<object> |
The list of creation results. |
|
|
array<object> |
The task. |
||
| ScheduledId |
string |
The scheduled task ID. |
sch-260705-agb***** |
| TaskConfigId |
string |
The task configuration ID. |
tsk-260705-0jj***** |
| InstanceResults |
array<object> |
The list of batch delivery results for instance scheduled tasks. |
|
|
object |
The instance result information. |
||
| InstanceId |
string |
The instance ID. |
acp-iuyb1zv1ap6nb**** |
| Success |
boolean |
Indicates whether the operation is successful. |
true |
| ErrorMessage |
string |
The error message. |
privateAccount not exist. |
Examples
Success response
JSON format
{
"RequestId": "9A51B1DF-96FF-3BCC-B08C-783161D3****",
"Code": "200",
"Message": "Success.",
"TotalCount": 1,
"Tasks": [
{
"ScheduledId": "sch-260705-agb*****",
"TaskConfigId": "tsk-260705-0jj*****",
"InstanceResults": [
{
"InstanceId": "acp-iuyb1zv1ap6nb****",
"Success": true,
"ErrorMessage": "privateAccount not exist."
}
]
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.