Home Support SMS API

Querying the Group Call Task List

Description: Query the group call 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

strTime

Start time

Yes

LocalDateTime

endTime

Endtime

Yes

LocalDateTime

statusList

Send status 0- Waiting for submission, 1 calling, 2- Task completed, 3- Submission failed, 4, Task cancelled, 5, Task suspended 6, Submission

No

List<Integer>

idxAppId

Application id

No

Integer

searchCondition

Comprehensive fuzzy query: Task name/voice file name/text-to-voice

No

String

Request URL:

                    
                      https://api.onbuka.com/v3/voice/group/call/query

Request Sample:

                    
                        Request URL:
                            https://api.onbuka.com/v3/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",
                                "statusList": []
                            }
                        }

Response Parameters Description:

Parameters Description Type

code

"0"means successful, others than 0 means failure, seeing Status code description.

String

msg

Failure reason description

String

data

Paging data

JSONObject

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

jobId

Group call task id

Integer

taskName

Task name

String

status

Sending status 0- Waiting for submission, 1 Calling, 2- Task completed, 3- Submission failed, 4, Task cancelled, 5, Task suspended, 6 Submitting

Integer

rate

Call progress

String

numCnt

Numcnt number of task bars

Integer

callNum

Number of calls made

Integer

success

Number of successes

Integer

fail

Number of Failures

Integer

createdTime

Submission time

LocalDateTime

Response Sample:

                    
{
    "code": 0,
    "msg": "success",
    "data": {
        "records": [
            {
                "jobId": 5000602,
                "taskName": "2024-06-04 14:49:17111",
                "status": 0,
                "rate": "0",
                "numCnt": 1,
                "callNum": 0,
                "success": 0,
                "fail": 0,
                "createdTime": "2024-06-04 14:49:36"
            }
        ],
        "total": 574,
        "size": 1,
        "current": 1,
        "searchCount": true,
        "pages": 574
    }
}
 
Previous Topic: Recording File Deletion
Next Topic: BUKA SDK

Feedback

0/500
✖
Service Support
1. Requirements Type
2. Requirements Description
3. Email

Need help?

Click here and start chatting with us!