Home Support SMS API

Inquire Phone Records By Batch

Description: Inquire phone records by batch on a page basis (for recent two months. The maximum interval between the starting time and the ending time is 31 days).

Request Parameters Description:

Parameters Description Required Type

current

Current page number: 1-N

Yes

Int

size

Number displayed on each page: 1-100

Yes

Int

params

Parameters on each page

Yes

JSONObject

strTime

Starting time of inquiry: ISO8601 standard time format 2022-01-01T00:00:00+08:00

Yes

String

endTime

Ending time of inquiry: ISO8601 standard time format 2022-01-31T00:00:00+08:00

Yes

String

sipGroupName

Name of phone group, exact match

No

String

phoneName

Phone name, exact match

No

String

Request URL:

https://api.onbuka.com/v3/voice/recordSipQuery

Request Sample:

RequestURL:
  https://api.onbuka.com/v3/voice/recordSipQuery
RequestMethod:
  POST
RequestHeaders:
  Content-Type: application/json;charset=UTF-8
  Sign: 05d7a50893e22a5c4bb3216ae3396c7c
  Timestamp: 1630468800
  Api-Key: bDqJFiq9
RequestBody:
  {
    "current": 1,
    "size": 10,
    "params": {
      "strTime": "2022-01-01T00:00:00+08:00",
      "endTime": "2022-01-31T00:00:00+08:00",
      "sipGroupName": "",
      "phoneName": ""
    }
  }

Response Parameters Description:

Parameters Description Type

status

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

String

reason

Failure reason description

String

data

Data on each page

JSONObject

total

Total record number

Int

size

Number displayed on each page

Int

current

Current page number

Int

pages

Total pages

Int

searchCount

Inquiry status

Boolean

records

Data set

JSONArray

voiceId

Exclusive recording ID

String

sipGroupName

Name of phone group

String

phoneName

Phone name

String

callee

Called number

String

displayNum

Display number

String

code

Operator's area

String

submitTime

Submitting time

String

callTime

Calling time

String

ringingTime

Ringing time

String

answerTime

Answering time

String

hangupTime

Hanging-up time

String

callDuration

Call duration (second)

Int

chargedDuration

Charged duration (second)

Int

terminationCode

Sip code, 200 means the call is successfully established

String

terminationReason

Status code description

String

costEur

Consumption amount (€)

String

billPeriod

Billing period: 20+20, 60+60

String

rate

Rate (€)

String

recordingFileId

Exclusive ID of recording file

String

Response Sample:

{
  "status": "0",
  "reason": "success",
  "data": {
    "total": 5,
    "size": 20,
    "current": 1,
    "pages": 1,
    "searchCount": true,
    "records": [
      {
        "voiceId": "2203031113381000002",
        "sipGroupName": "group1",
        "phoneName": "sipName8555",
        "callee": "8613500000000",
        "displayNum": "1008122211",
        "code": "Afghanistan(Kandahar)",
        "submitTime": "2022-02-18T14:42:40+08:00",
        "callTime": "2022-02-18T14:45:42+08:00",
        "ringingTime": "2022-02-18T14:42:47+08:00",
        "answerTime": "2022-02-18T14:42:50+08:00",
        "hangupTime": "2022-02-18T14:42:55+08:00",
        "callDuration": 5,
        "chargedDuration": 5,
        "terminationCode": "200",
        "terminationReason": "success",
        "costEur": "2",
        "billPeriod": "20+20",
        "rate": "1.2",
        "recordingFileId": "12022022570cc2484c59d4f8b9745d34226285b1e.mp3"
      }
    ]
  }
}
 

Feedback

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

Need help?

Click here and start chatting with us!