UpdateAiOutboundTask
Updates an outbound call task based on the instance ID and task ID.
Operation description
This operation allows you to update the task name, task description, outbound caller number, skill group ID, and other information. For more details, refer to Request parameters.
QPS limit
Per-user call frequency: not throttled.
API frequency: 20 calls per second.
If the total calls from multiple users exceed the API frequency, throttling is also triggered.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| InstanceId |
string |
Yes |
The ID of the Artificial Intelligence Cloud Call Service (AICCS) instance. You can obtain the instance ID from Instance Management in the left-side navigation pane of the Artificial Intelligence Cloud Call Service console. |
agent_*** |
| TaskId |
integer |
Yes |
The task ID. You can call the CreateAiOutboundTask operation and check the Data parameter in the response, or call the GetAiOutboundTaskList operation and check the TaskId parameter in the response. |
123 |
| Name |
string |
Yes |
The task name. The name must be 1 to 15 characters in length. |
SampleOutboundCall |
| Description |
string |
No |
The task description. The description can be up to 100 characters in length. |
PropertySales |
| OutboundNums |
array |
Yes |
The outbound caller numbers. |
|
|
string |
Yes |
The outbound caller numbers. |
150****0000 |
|
| NumRepeated |
integer |
Yes |
The called number deduplication policy. Valid values:
Valid values:
|
1 |
| HandlerId |
integer |
Yes |
The skill group ID for predictive outbound calls, or the IVR ID for automatic outbound calls. |
123 |
| ExecutionTime |
string |
Yes |
The task execution time. Use a JSON object to configure time periods by day of the week. The start and end values must be in the HH:mm format. The end time must be later than the start time. |
{"TUESDAY":[{"start":"06:00","end":"06:05"}],"MONDAY":[{"start":"09:00","end":"18:00"},{"start":"20:30","end":"21:45"},{"start":"22:30","end":"22:50"}],"WEDNESDAY":[{"start":"09:00","end":"18:00"}],"THURSDAY":[{"start":"09:00","end":"18:00"}],"FRIDAY":[{"start":"09:00","end":"18:00"}],"SATURDAY":[{"start":"09:00","end":"18:00"}],"SUNDAY":[{"start":"17:00","end":"23:45"}]} |
| ConcurrentRate |
integer |
No |
The concurrency for automatic outbound calls. |
10 |
| RecallRule |
object |
No |
The failed recall policy. Note
If this parameter is left empty, the system does not recall when an outbound call fails. |
|
| Count |
integer |
No |
The number of failed recall attempts. Valid values: 1 to 3. |
2 |
| Interval |
integer |
No |
The interval between failed recall attempts. Valid values: 1 to 60. Unit: minutes. |
5 |
| ForecastCallRate |
number |
No |
The fixed call ratio for predictive outbound calls. Valid values: ≥ 1. |
1.2 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
EE338D98-9BD3-4413-B165 |
| Message |
string |
The description of the status code. |
ok |
| Code |
string |
The status code. |
ok |
| Success |
boolean |
Indicates whether the call was successful. Valid values:
|
true |
Examples
Success response
JSON format
{
"RequestId": "EE338D98-9BD3-4413-B165",
"Message": "ok",
"Code": "ok",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.