QueryAiCallTaskPage

Updated at:

Queries the list of voice call tasks.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter

Type

Required

Description

Example

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 in paging. Settings for the number of rows per page.

20

Status

string

No

The task status. Valid values:

  • INIT: init (not started).

  • FAILED: startup failed.

  • RUNNING: running.

  • STOPPED: stopped.

INIT

TaskName

string

No

The task name. The system performs a fuzzy match based on the task name.

TestTask.

AgentName

string

No

The agent name. The system performs a fuzzy match based on the agent name.

TestAgent.

TaskId

string

No

The task ID.

1187**************

ApplicationCode

string

No

The application code.

025****C98

Source

integer

No

The creation source. Valid values:

0: created by agent.

1: created by engine.

0

Response elements

Element

Type

Description

Example

object

AccessDeniedDetail

string

The detailed reason for access denial.

None

Message

string

The error message. This parameter is not returned if the call is successful.

Invalid parameter.

RequestId

string

The request ID.

B99C5955-5664-573D-97BE-A7CC1AFD8401

Data

object

The task details.

PageSize

integer

The number of entries per page.

74

Total

integer

The total number of records.

72

PageNo

integer

The current page number.

37

List

array<object>

The task data.

object

The task data list.

Status

integer

The task status.

Valid values:

  • 0 :

    Init.

  • 1 :

    Running.

  • 2 :

    Stopped.

  • 3 :

    Startup failed.

1

TaskId

string

The task ID.

1187**************

CompleteRate

string

The task completion rate.

70%

ApplicationName

string

Sample value.

CreateTime

integer

The creation time. This value is a UNIX timestamp in milliseconds.

1748932499000

StartTime

integer

The scheduled start time of the task. This value is a UNIX timestamp in milliseconds.

1748932499000

RealStartTime

integer

The actual start time of the task. This value is a UNIX timestamp in milliseconds.

1748932499000

TotalCallCount

integer

The total number of calls made by the task.

58

DayCallCount

integer

The number of calls made on the current day.

22

ApplicationCode

string

Sample value.

TotalCount

integer

The total number of task items.

71

TaskName

string

The task name.

TestTask.

StartFailedReason

string

The reason for startup failure.

Agent is offline.

FailedCount

integer

The total number of failed task executions.

61

AgentName

string

The agent name.

TestAgent.

CallingCount

integer

The number of ongoing calls.

72

AgentId

string

The agent ID.

1180**************

SucceedCount

integer

The total number of successful task executions.

36

DayImportCount

integer

The amount of data imported on the current day.

400

ConcurrentCount

integer

The task concurrency.

10

HistoryConnectRate

string

The historical connection rate. Historical connection rate = historical number of connections ÷ total number of calls (TotalCallCount).

95.89%

DayConnectRate

string

The daily connection rate. Daily connection rate = number of connections on the current day ÷ number of calls on the current day (DayCallCount).

74.14%

CallExpireMinutes

integer

39

CallExpireDate

string

Sample value.

CallExpireType

integer

72

Code

string

The status code.

OK

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: successful.

  • false: failed.

true

Examples

Success response

JSON format

{
  "AccessDeniedDetail": "None",
  "Message": "Invalid parameter.",
  "RequestId": "B99C5955-5664-573D-97BE-A7CC1AFD8401",
  "Data": {
    "PageSize": 74,
    "Total": 72,
    "PageNo": 37,
    "List": [
      {
        "Status": 1,
        "TaskId": "1187**************",
        "CompleteRate": "70%",
        "ApplicationName": "Sample value.",
        "CreateTime": 1748932499000,
        "StartTime": 1748932499000,
        "RealStartTime": 1748932499000,
        "TotalCallCount": 58,
        "DayCallCount": 22,
        "ApplicationCode": "Sample value.",
        "TotalCount": 71,
        "TaskName": "TestTask.",
        "StartFailedReason": "Agent is offline.",
        "FailedCount": 61,
        "AgentName": "TestAgent.",
        "CallingCount": 72,
        "AgentId": "1180**************\n",
        "SucceedCount": 36,
        "DayImportCount": 400,
        "ConcurrentCount": 10,
        "HistoryConnectRate": "95.89%",
        "DayConnectRate": "74.14%",
        "CallExpireMinutes": 39,
        "CallExpireDate": "Sample value.",
        "CallExpireType": 72
      }
    ]
  },
  "Code": "OK",
  "Success": true
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.