AI Agent Task List - nxtele/nxcloud-doc-en GitHub Wiki

Query Outbound Task List

  • URL: https://api-hk.nxlink.ai/openapi/aiagent/task/list
  • Method: POST
  • Content-Type: application/json
  • Authentication Required: Yes

🌐 Service Access Points

NXLink has deployed multiple service regions globally. Please select the corresponding service access point based on your business location. Different regions use different website domains and API gateway domains.

Code Region NXLink Website API Gateway
APAC Hong Kong https://app.nxlink.ai https://api-hk.nxlink.ai
AMER Americas https://chl-nxlink.nxcloud.com https://chl-api.nxlink.ai
APAC(IDN) Indonesia https://idn.nxlink.ai https://api-idn.nxlink.ai

Request Parameters

Header Parameters

Parameter Type Required Example Value Description
accessKey String Yes AK-6230339248928541113-2133 User identity identifier.
ts String Yes 1655710885431 Current request timestamp (in milliseconds). The server allows a maximum time difference of 60 seconds.
bizType String Yes 100 Business type. Fixed value: "100".
action String Yes nxai Business operation. Fixed value: "nxai".
sign String Yes 6e9506557d1f289501d333ee2c365826 API parameter signature. Please refer to the Common Conventions., Signature Algorithm

Body Parameters

Parameter Type Required Example Value Description
taskName string No "Marketing-Task-2023" The name of the task.
taskStatus integer No 1 Task Status: 1 - Ready2 - In Progress3 - Completed4 - Failed5 - Paused6 - Paused (Insufficient Balance)
createStartTs integer No 1746583929 Start time for filtering by creation date (Seconds timestamp).
createEndTs integer No 1746583929 End time for filtering by creation date (Seconds timestamp).
minCallsAnsweredRate double No 50.0 Minimum Answer Rate range (0.0 - 100.0).
maxCallsAnsweredRate double No 100.0 Maximum Answer Rate range (0.0 - 100.0).
minTaskTotalQuantity integer No 100 Minimum total customers in task.
maxTaskTotalQuantity integer No 1000 Maximum total customers in task.
pageNumber integer Yes 1 Page number. Default is 1.
pageSize integer Yes 10 Page size. Default is 10, maximum is 1000.

Request Example

Body:

{
  "createStartTs": 1746583929,
  "createEndTs": 1746583929,
  "minCallsAnsweredRate": "",
  "maxCallsAnsweredRate": "",
  "minTaskTotalQuantity": "",
  "maxTaskTotalQuantity": "",
  "pageNumber": 1,
  "pageSize": 10
}

Response Parameters

Parameter Type Description
code Integer Result code
message String Result message
traceId String Trace ID for request tracking
total Integer Total number of records
pageNumber Integer Current page number
pageSize Integer Page size
list Array Task list

Task Object (list Element)

Parameter Type Description
id Long Internal ID
taskId String Task ID
userTaskId String User-defined task ID
other String Task passthrough field provided when the task is created
autoFlowId Long Bot ID
autoFlowName String Bot name
taskStatus Integer Task status
pauseReason Integer Pause reason
taskName String Task name
taskDesc String Task description
taskKeep Integer Keep-alive flag: 0 = disabled, 1 = enabled
startupType Integer Startup type: 0 = none, 1 = manual, 2 = scheduled, 3 = immediate
startupAt Long Scheduled start timestamp (when startupType = 2)
shutdownAt Long Scheduled pause timestamp (when startupType = 2)
startupBy String Operator who started the task (when startupType = 1)
routeId String Selected route ID
maxCall Integer Maximum concurrent calls
importType Integer User import type
funcFlag Integer Function flag
maxRingTime Integer Ring duration in seconds
strategyId String Strategy ID
agentGroupId String Agent group ID
taskCallbackUrl String Callback URL
createTs Long Creation timestamp (seconds)
orderMaxCall Long Maximum dial attempts per order
replayInterval Long Replay interval
statInfo Object Statistics information

Statistics Object (statInfo)

Parameter Type Description
id Long Internal ID
taskId String Task ID
autoFlowId Long Bot ID
answerOrderCount Integer Answered order count (calculated at order completion)
finishOrderCount Integer Finished order count (calculated at order completion)
totalOrderCount Integer Total order count (calculated at import time)
dialedOrderCount Integer Dialed order count (calculated after first call attempt per order)
totalCallElapsed Integer Total call duration in seconds
answerCallCount Integer Answered call count (calculated at call completion)
totalCallCount Integer Total call count (calculated at call completion)
manualElapsed Integer Total manual-call duration in seconds
manualAnswerCount Integer Manually answered call count
manualFailCount Integer Manual transfer failed call count
createTs Long Creation timestamp (seconds)
answerRate String Answer rate (answered calls / total calls)
dialProgress String Dialing progress (dialed orders / total orders)
finishRate String Completion rate (finished orders / total orders)
manualAnswerRate String Manual transfer success rate (manual answered / (manual answered + manual failed))
avgCallDuration Integer Average call duration in seconds (total call duration / answered calls)
avgManualDuration Integer Average manual call duration in seconds (manual call duration / manual answered calls)

Response Example

Success Example

{
  "code": 0,
  "message": "success",
  "traceId": "3287f5aa-b8db-4dd7-97b0-03fabac2f4c7",
  "total": 20,
  "pageNumber": 1,
  "pageSize": 10,
  "list": [
    {
      "id": 74,
      "taskId": "52145b00-abc9-4a87-94c2-ed1e1e42ec1c",
      "saasUserId": 203,
      "userTaskId": "",
      "other": "task-batch-20260325",
      "autoFlowId": 158,
      "taskStatus": 5,
      "pauseReason": null,
      "taskName": "update_task_name_xxx1",
      "taskDesc": "update_task_desc_xxx2",
      "taskKeep": 0,
      "startupType": 2,
      "startupAt": 1731581880,
      "shutdownAt": null,
      "startupBy": "",
      "routeId": "CJq6rtX2lg",
      "maxCall": 0,
      "importType": 0,
      "funcFlag": 0,
      "maxRingTime": 0,
      "strategyId": "",
      "agentGroupId": "",
      "taskCallbackUrl": "",
      "createTs": 1731663717,
      "statInfo": {
        "id": 72,
        "taskId": "52145b00-abc9-4a87-94c2-ed1e1e42ec1c",
        "autoFlowId": 158,
        "answerOrderCount": 0,
        "finishOrderCount": 0,
        "totalOrderCount": 0,
        "dialedOrderCount": 0,
        "totalCallElapsed": 0,
        "answerCallCount": 0,
        "totalCallCount": 0,
        "manualElapsed": 0,
        "manualAnswerCount": 0,
        "manualFailCount": 0,
        "createTs": 1731663717,
        "answerRate": null,
        "dialProgress": null,
        "finishRate": null,
        "manualAnswerRate": null,
        "avgCallDuration": null,
        "avgManualDuration": null
      },
      "orderMaxCall": null,
      "replayInterval": null
    }
  ]
}

Error Codes

Code Description
1001 Authentication failed (missing public parameters)
1002 Authentication failed (parameter error)
1003 Authentication failed (invalid signature)
1004 Authentication failed (timestamp expired)
1005 Authentication failed (insufficient authority)
20000 Business Error