Home > API Center > API interface guide
Query Task List
POST
https://api.laaffic.com/voice/group/call/query
Query AI Agent group call task list
Request Parameters
| Parameter | Description | Required | Type |
|---|---|---|---|
| current | Current page number, 1-N | Yes | Int |
| size | Number of items per page, 1-100 | Yes | Int |
| params | Pagination parameters | Yes | JSONObject |
| strTime | Start time | Yes | LocalDateTime |
| endTime | End time | Yes | LocalDateTime |
| taskType | Task type, fixed as 3 (AI Agent Group Call) | Yes | Integer |
| statusList | Send status: 0-Waiting to submit, 1-Calling, 2-Task finished, 3-Submission failed, 4-Task canceled, 5-Task suspended, 6-Submitting | No | List<Integer> |
| idxAppId | App ID | No | Integer |
| searchCondition | Comprehensive fuzzy query: task name / voice file name / text-to-speech | No | String |
Request Example
Request URL:
https://api.laaffic.com/voice/group/call/query
Request Method:
POST
Request Headers:
Content-Type: application/json;charset=UTF-8
Sign: 05d7a50893e22a5c4bb3216ae3396c7c
Timestamp: 1630468800
Api-Key: bDqJFiq9
Request Body:
{
"current": 1,
"size": 10,
"params": {
"strTime": "2024-01-01 00:00:00",
"endTime": "2024-06-03 15:13:01",
"taskType": 3,
"statusList": []
}
}
Response Parameters
| Parameter | Description | Type |
|---|---|---|
| code | Status code, 0 implies success, for failures see Response Status Code | String |
| msg | Reason for failure | String |
| data | Pagination data | JSONObject |
| total | Total number of records | Int |
| size | Number of items per page | Int |
| current | Current page number | Int |
| pages | Total pages | Int |
| records | Data collection | JSONArray |
| taskId | Task ID | Integer |
| taskName | Task name | String |
| status | Send status: 0-Waiting to submit, 1-Calling, 2-Task finished, 3-Submission failed, 4-Task canceled, 5-Task suspended, 6-Submitting | Integer |
| rate | Call progress | String |
| numCnt | Number of tasks | Integer |
| callNum | Called quantity | Integer |
| success | Success count | Integer |
| fail | Failure count | Integer |
| createdTime | Submission time | LocalDateTime |
| scriptId | AI Agent template ID | Integer |
| taskType | Task type, fixed as 3 (AI Agent Group Call) | Integer |
| answeredNum | Answered count | Integer |
| asr | Answer rate | String |
| agentTotalFeetime | AI Agent product total billed duration (seconds) | Integer |
| agentFee | AI Agent product total consumption amount (quoted currency) | String |
| chargeLen | Billed duration (seconds) | Integer |
| acd | Average call duration | String |
| groupCallPayFee | Group call consumption | String |
| smsPayFee | Hang-up SMS consumption | String |
| taskSumPayFee | Task total consumption | String |
| sendSmsNum | Number of hang-up SMS sent | Integer |
Response Example
{
"code": 0,
"msg": "success",
"data": {
"records": [
{
"taskId": 5000602,
"taskName": "2024-06-04 14:49:17-agent",
"status": 2,
"rate": "100",
"numCnt": 10,
"callNum": 10,
"success": 8,
"fail": 2,
"createdTime": "2024-06-04 14:49:36",
"scriptId": 56,
"taskType": 3,
"answeredNum": 8,
"asr": "80",
"agentTotalFeetime": 320,
"agentFee": "0.125000",
"chargeLen": 480,
"acd": "60s",
"groupCallPayFee": "0.034827(USD)",
"smsPayFee": "0(USD)",
"taskSumPayFee": "0.159827(USD)",
"sendSmsNum": 0
}
],
"total": 574,
"size": 10,
"current": 1,
"searchCount": true,
"pages": 58
}
}
Response Status Codes
| code | Status Description |
|---|---|
| 0 | Success |
| -1 | Authentication error |
| -2 | Restricted IP access |
| -16 | Timestamp expired |
| -18 | System exception |
| -22 | Parameter exception |
Was this page helpful?
Questions about integration? Contact our technical support
LAAFFIC API dedicated TG technical support channel, real-time response to your needs