Home Support SMS API

Inquire Single Phone Record

Description: Inquire the record information of a designated phone (for recent two months).

Request Parameters Description:

Parameters Description Required Type

voiceId

Exclusive recording ID

Yes

String

Request URL:

                    
                      https://api.onbuka.com/v3/voice/recordSip/{voiceId}

Request Sample:

                    
                      RequestURL:
                        https://api.onbuka.com/v3/voice/recordSip/{voiceId}
                      RequestMethod:
                        GET
                      RequestHeaders:
                        Content-Type: application/json;charset=UTF-8
                        Sign: 05d7a50893e22a5c4bb3216ae3396c7c
                        Timestamp: 1630468800
                        Api-Key: bDqJFiq9

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

Record detail

JSONObject

voiceId

Exclusive recording ID

String

sipGroupName

Name of phone group

String

phoneName

Phone name

String

callee

Called number

String

displayNum

Display number

String

code

Regional operator

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":{
                          "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:42:45+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": "3e2f0781-9642-40ec-8bbe-df35abec72d4"
                        }
                      }
 

Feedback

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

Need help?

Click here and start chatting with us!