NXLINK AI taskList - nxtele/http-api-document GitHub Wiki

查询外呼任务列表

URL：https://api-westus.nxlink.ai/openapi/aiagent/task/list
Method：POST
Content-Type：application/json
需要鉴权：是

请求参数

header参数：

参数名	类型	必选	示例值	说明
accessKey	String	是	AK-6230339248928541113-2133	用户身份标识
ts	String	是	1655710885431	当前请求的时间戳（单位是毫秒），牛信服务端允许用户端请求最大时间误差为60秒
bizType	String	是	100	业务类型，取固定值“100”
action	String	是	nxai	业务操作，取固定值“nxai”
sign	String	是	6e9506557d1f289501d333ee2c365826	API入参参数签名查看公共约定

请求参数：

参数名	类型	必选	示例值	说明
taskName	string	否	"营销任务-2023"	任务名称
taskStatus	integer	否	1	任务状态：1-准备就绪，2-进行中，3-已完成，4-失败，5-已暂停，6-余额不足暂停
createStartTs	integer	否	1746583929	开始时间时间戳（单位秒）
createEndTs	integer	否	1746583929	结束时间戳（单位秒）
minCallsAnsweredRate	double	否	50.0	最小接通率，范围0.0-100.0
maxCallsAnsweredRate	double	否	100.0	最大接通率，范围0.0-100.0
minTaskTotalQuantity	integer	否	100	最小客户数
maxTaskTotalQuantity	integer	否	1000	最大客户数
pageNumber	integer	是	1	页码，默认1
pageSize	integer	是	10	每页大小，默认10，最大1000

请求示例

请求body：

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

响应参数

参数名	类型	说明

响应参数

参数名	类型	说明
code	Integer	结果编码
message	String	请求结果说明
traceId	String	链路追踪ID
total	Integer	总记录数
pageNumber	Integer	当前页码
pageSize	Integer	每页大小
list	Array	任务列表

list元素

参数名	类型	说明
id	Long	id
taskId	String	任务id
userTaskId	String	用户定义的任务id
autoFlowId	Long	机器人id
autoFlowName	String	机器人名称
taskStatus	Integer	任务状态
pauseReason	Integer	暂停原因
taskName	String	任务名称
taskDesc	String	任务描述
taskKeep	Integer	任务是否保活，0:不保活，1:保活
startupType	Integer	启动方式，0:none,1:手动启动,2:定时启动,3:立即启动
startupAt	Long	谁启动，startup_type=2时候启动时间戳
shutdownAt	Long	startup_type=2 定时任务暂停时间戳
startupBy	String	谁启动，startup_type=1时候启动人
routeId	String	任务选择的路由
maxCall	Integer	最大并发
importType	Integer	导入用户的类型
funcFlag	Integer	功能标志
maxRingTime	Integer	响铃时长设置 / 秒
strategyId	String	策略id
agentGroupId	String	坐席组id
taskCallbackUrl	String	回调url
createTs	Long	创建秒级时间戳
orderMaxCall	Long	拨打次数
replayInterval	Long	重播时间
statInfo	Object	统计信息

statInfo对象

参数名	类型	说明
id	Long	id
taskId	String	任务id
autoFlowId	Long	机器人id
answerOrderCount	Integer	接通订单数，订单结束时统计
finishOrderCount	Integer	完成订单数，订单结束时统计
totalOrderCount	Integer	总订单数,导入时统计
dialedOrderCount	Integer	已拨打订单数一个订单打完第一次电话时统计
totalCallElapsed	Integer	通话总时长，秒
answerCallCount	Integer	接通通话数，通话结束时统计
totalCallCount	Integer	总通话数，通话结束时统计
manualElapsed	Integer	转人工通话总时长，秒
manualAnswerCount	Integer	转人工接听通话数量
manualFailCount	Integer	转人工失败通话数量
createTs	Long	创建秒级时间戳
answerRate	String	接通率 (已接通通话数/总通话数)
dialProgress	String	外呼进度 (已拨打订单数/总订单数)
finishRate	String	完成率 (完成订单数/总订单数)
manualAnswerRate	String	人工转接成功率 (转人工接听通话数/(转人工接听通话数+转人工失败通话数))
avgCallDuration	Integer	平均通话时长(秒) (通话总时长/接通通话数)
avgManualDuration	Integer	平均人工通话时长(秒) (转人工通话总时长/转人工接听通话数)

响应示例

成功示例

{
    "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": "",
            "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
        }  
    ]
}

错误码

值	说明
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