ListTaskDetail

Updated at:

Retrieves the details of a call task for an intelligent contact robot.

Operation description

  • You can call this operation to retrieve the details of a call task for an intelligent contact robot. You can also view the details on the Task Management > Details page.

  • Before calling this operation, make sure that your intelligent contact robot has been created and the task has been started.

  • If you do not have a created call task, create and start a task on the Task Management page, or by calling the CreateTask and StartTask operations.

  • The optional parameters in this operation are filter conditions for the call task details. If you do not specify them, all task details are returned.

QPS limit

  • Per-user call frequency: not throttled.

  • API frequency: 500 calls per second.

Note

If the total calls from multiple users exceed the API frequency, throttling is triggered.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

aiccs:ListTaskDetail

get

*All Resource

*

None None

Request parameters

Parameter

Type

Required

Description

Example

StatusCode

string

No

The call status code. For more information, see Call status codes in Voice Messaging.

200100

Status

string

No

The detail status. Valid values:

  • SUCCESS: The outbound call succeeded.

  • FAIL: The outbound call failed.

  • INIT: The outbound call has not been made.

SUCCESS

PageNo

integer

No

The current page number. The value must be greater than 0. Default value: 1.

1

PageSize

integer

No

The number of entries per page. The value must be greater than 0. Default value: 20.

20

Called

string

No

The called number. You can view the called number on the Task Management > Details page.

186****0000

TaskId

integer

Yes

The task ID. You can view the task ID on the Task Management page or obtain it by calling the ListTask operation.

12****

Id

integer

No

The detail ID. You can view the detail ID on the Task Management > Details page.

12****

Response elements

Element

Type

Description

Example

object

The response parameters.

Code

string

The request status code. OK indicates that the request was successful.

OK

Data

object

The task details.

PageNo

integer

The number of entries per page.

20

PageSize

integer

The current page number.

1

Record

array<object>

The list of task records.

object

The task information.

Called

string

The called number.

186****0000

Caller

string

The caller number.

136****0000

Direction

string

The hangup direction. Valid values:

  • User.

  • Robot.

User

Duration

integer

The call duration. Unit: seconds.

30

EndTime

string

The end time in the YYYY-MM-DD HH:mm:ss format.

2021-05-20 00:03:00

Id

integer

The detail ID.

12****

RetryCurTimes

integer

The current retry count.

1

RetryTimes

integer

The total number of retries.

1

StartTime

string

The start time in the YYYY-MM-DD HH:mm:ss format.

2021-05-20 00:00:00

Status

string

The detail status.

SUCCESS

StatusCode

string

The call status code.

200100

StatusCodeDesc

string

The description of the call status code.

Call succeeded

Tags

string

The intent label.

Affirmative

Total

integer

The total number of tasks.

50

Message

string

The description of the status code.

OK

RequestId

string

The request ID.

D9CB3933-9FE3-4870-BA8E-2BEE91B69D23

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.

  • false: The call failed.

true

Examples

Success response

JSON format

{
  "Code": "OK",
  "Data": {
    "PageNo": 20,
    "PageSize": 1,
    "Record": [
      {
        "Called": "186****0000",
        "Caller": "136****0000",
        "Direction": "User",
        "Duration": 30,
        "EndTime": "2021-05-20 00:03:00",
        "Id": 0,
        "RetryCurTimes": 1,
        "RetryTimes": 1,
        "StartTime": "2021-05-20 00:00:00",
        "Status": "SUCCESS",
        "StatusCode": "200100",
        "StatusCodeDesc": "Call succeeded",
        "Tags": "Affirmative"
      }
    ],
    "Total": 50
  },
  "Message": "OK",
  "RequestId": "D9CB3933-9FE3-4870-BA8E-2BEE91B69D23",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 PermissionInsufficient Insufficient permissions. Please contact the Alibaba Cloud account administrator.
400 ParameterError The parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.