GetAiOutboundTaskDetail
Retrieves the details of an outbound call task based on the instance ID and task ID.
Operation description
The outbound call task details include the task ID, task status, task type, outbound caller number, callee number deduplication policy, and other information. For more information, see Response elements.
QPS limit
Per-user call rate: 100 calls per second.
API call rate: 100 calls per second.
If the total calls from multiple users exceed the API call rate, throttling is 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. |
123456 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| RequestId |
string |
The request ID. |
D9CB3933-9FE3-4870-BA8E-2BEE91B69D23 |
| Message |
string |
The description of the status code. |
OK |
| Data |
object |
The details of the outbound call task. |
|
| Status |
integer |
The task status. Valid values:
|
1 |
| HandlerId |
integer |
The skill group ID (for predictive outbound calls) or IVR ID (for automatic outbound calls). |
123456 |
| TaskId |
integer |
The task ID. |
123 |
| Description |
string |
The task description. |
Real estate sales |
| Name |
string |
The task name. |
xxxxx outbound call |
| StatusDesc |
string |
The task status description. |
Not started |
| ExecutionTime |
string |
The task execution time. Time periods are configured by day of the week using a JSON object. The start and end values are in the HH:mm format. |
{"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"}]} |
| Type |
integer |
The task type. Valid values:
|
2 |
| ConcurrentRate |
integer |
The concurrency for automatic outbound calls. |
10 |
| NumRepeated |
integer |
The callee number deduplication policy.
|
0 |
| OutboundNums |
array |
The outbound caller numbers. |
|
|
string |
The outbound caller numbers. |
150****0000 |
|
| RecallRule |
object |
The failed recall policy. |
|
| Count |
integer |
The number of recall attempts. |
2 |
| Interval |
integer |
The recall interval. Unit: minutes. |
2 |
| HandlerName |
string |
The skill group name or IVR name. |
Hotline skill group |
| ForecastCallRate |
number |
The fixed call rate for predictive outbound calls. |
1.2 |
| Code |
string |
The status code. |
OK |
| Success |
boolean |
Indicates whether the call was successful.
|
true |
Examples
Success response
JSON format
{
"RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
"Message": "OK",
"Data": {
"Status": 1,
"HandlerId": 123456,
"TaskId": 123,
"Description": "房产销售",
"Name": "xxxxx外呼",
"StatusDesc": "未开始",
"ExecutionTime": "{\"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\"}]}",
"Type": 2,
"ConcurrentRate": 10,
"NumRepeated": 0,
"OutboundNums": [
"150****0000"
],
"RecallRule": {
"Count": 2,
"Interval": 2
},
"HandlerName": "热线技能组",
"ForecastCallRate": 1.2
},
"Code": "OK",
"Success": true
}
Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.