Home Support SMS API

Query Preview Task List

Description: Query preview task list.

Request Parameters Description:

Parameters Description Required Type

current

Current page number, 1-N

Yes

Integer

size

Number of displays per page,1-100

Yes

Integer

params

Paging parameters

Yes

JSONObject

startTime

Query start time

No

String

endTime

Query end time

No

String

taskId

task id

No

String

taskStatus

Task status, 1-enabled, 2 disabled, 16-submitting, 11-calling, 12-task completed, 13-submission failed, 14-task canceled, 15-task suspended

No

List<Integer>

taskType

Task type, 0-automatic call, 1-group call transfer to agent

No

Integer

finishFlag

Completion flag, 1-yes, 0-no

No

Integer

voiceGroupIds

Agent group voiceGroupId

No

List<Integer>

Request URL:

                    
                        https://api.onbuka.com/v3/cc/preview/query
                    
                  

Request Sample:

                                                
                                                    Request URL:
                                                        https://api.onbuka.com/v3/cc/preview/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":15,
                                                        "params":{
                                                            "startTime": "2025-01-10",
                                                            "endTime":"2025-02-10"
                                                        }
                                                    }
                                                
                  

Response Parameters Description:

Parameters Description Type

status

status code,0 is successful. For other failures, please refer to the interface response code

String

reason

Failure reason description

String

data

Data collection

JSONArray

total

Total number of records

Integer

size

Number of displays per page

Integer

current

Current page number

Integer

pages

Total page number

Integer

records

Data collection

JSONArray

taskId

task id

Integer

voiceGroupId

Agent group ID

List<Integer>

seatGroupName

Agent group name

String

remainCount

Remaining quantity

Long

totalCount

Total number

Long

remark

Remark

String

ccode

Country code

String

codeName

Country code (country code name)

String

taskStatus

Task status, 1-enabled, 2 disabled, 16-submitting, 11-calling, 12-task completed, 13-submission failed, 14-task canceled, 15-task suspended

Integer

taskType

Task type, 0 - automatic agent task, 1 - group call transfer to agent

Integer

finishFlag

Whether to complete the identification, 1-yes, 0 no

Integer

completedRate

Double

String

groupTaskId

Group call task id

Integer

transfersNum

Number of transfers

Integer

callFailuresNum

Call loss number

Integer

callingNumber

Display number/calling number

String

displayNum

Display number/calling number

String

numberTotalCount

Number of numbers

String

callFinishCount

Completed quantity

Integer

numberSameCount

Number of duplicate numbers

String

appId

Application ID

String

calloutRate

Outbound call ratio

Integer

fileName

File name

String

filePath

File path

String

createTime

Creation time

DateTime

Response Sample:

                                                
                                                    {
                                                        "status": 0,
                                                        "reason": "success",
                                                        "data": {
                                                            "total": 1,
                                                            "size": 50,
                                                            "current": 1,
                                                            "searchCount": true,
                                                            "pages": 1,
                                                            "records": [
                                                                {
                                                                    "taskId": 5000525,
                                                                    "voiceGroupId": [
                                                                        1000006
                                                                    ],
                                                                    "seatGroupName": "tele-basic-config",
                                                                    "createTime": "2025-01-10 13:59:18",
                                                                    "remainCount": 1,
                                                                    "totalCount": 1,
                                                                    "remark": null,
                                                                    "codeName": null,
                                                                    "ccode": null,
                                                                    "taskStatus": 15,
                                                                    "taskType": 1,
                                                                    "finishFlag": 0,
                                                                    "completedRate": 0,
                                                                    "groupTaskId": 5003544,
                                                                    "transfersNum": 0,
                                                                    "callFailuresNum": 0,
                                                                    "callingNumber": null,
                                                                    "displayNum": null,
                                                                    "numberTotalCount": "1",
                                                                    "callFinishCount": null,
                                                                    "numberSameCount": "0",
                                                                    "appId": "1000009",
                                                                    "calloutRate": 1,
                                                                    "fileName": "Template_voice_numFiles_cn.xls",
                                                                    "filePath": "/mnt/cc\upload\execl\202501101359147_A0987lj.xls"
                                                                }
                                                            ]
                                                        }
                                                    }
                                                
                  
 

Previous Topic: Recording File Deletion
Next Topic: BUKA SDK

Feedback

0/500

Need help?

Click here and start chatting with us!