WebCall CDR List Page By Page

Summary

Get CDR page by page

Limit

1. 0.5QPS(call 1 time within 2 seconds)
2. Only records within 15 days are allowed to be queried.

Request URI

https://api.nxcloud.com/api/voiceSms/getSipCdr

Request Params

field	required	type	desc
appkey	Yes	string	Get it from nxcloud console
secretkey	Yes	string	Get it from nxcloud console
username	No	string	webcall user name
start_time	Yes	string	start time of range，format: [yyyy-MM-dd HH:mm:ss] e.g. 2018-12-10 10:00:00
end_time	Yes	string	end time of range, format: [yyyy-MM-dd HH:mm:ss] e.g.2018-12-10 20:00:00
direction	No	string	0: inbound 1: outbound
page_size	Yes	string	[,1000]]
page	Yes	string	start from 1

note

1. this API will list all records if not specify username.
2. limit: 15 days are allowed and the time span of start and end is not allowed to exceed 24 hours.

Response Example

success

{
    "code": "1",
    "info": {
        "total": 5,
        "page": 1,
        "pageSize": 2,
        "rows": [
            {
                "phone": "81314382782",
                "direction": "0",
                "hangup_cause": "NORMAL_CLEARING",
                "answer_time": "2019-01-25 12:41:57",
                "country_code": "62",
                "id": 636597,
                "sipid": 1055014,
                "duration": 0,
                "username": "6282215699804",
                "mobile_name": "name",
                "end_time": "2019-01-25 12:42:26",
                "effective_called_number": "626281314382782",
                "start_time": "2019-01-25 12:42:26",
                "orderid": "FLNK-FLNK-maqKSi_IDW0hXGl-FO0xjE_FLNK-1548391358819-QgNuzM",
                "record_url": null,
                "show_phone": "6282215699804"
            },
            {
                "phone": "878828666",
                "direction": "0",
                "hangup_cause": "NORMAL_CLEARING",
                "answer_time": "2019-01-25 12:40:42",
                "country_code": "62",
                "id": 636600,
                "sipid": 1055015,
                "duration": 0,
                "username": "6282215699803",
                "mobile_name": "name",
                "end_time": "2019-01-25 12:42:29",
                "effective_called_number": "626287882866266",
                "start_time": "2019-01-25 12:42:29",
                "orderid": "FLNK-FLNK-vpHnoi_ID2l3NgE-YPsthe_FLNK-1548391367271-RPC1U0",
                "record_url": null,
                "show_phone": "6282215699803"
            }
        ]
    }
}

fail

  {
    "code": "0",
    "info": "appkey or secretkey invalid"
  }

Response Params

field	requird	type	desc
total	Yes	string	total record numbers under this condition
page	Yes	string	-
pageSize	Yes	string	-
sipid	Yes	string	webcall sipid, don't care
id	Yes	string	Record ID of NXCLOUD
username	Yes	string	webcall user name
mobile_name	Yes	string	webcall nick name
duration	Yes	string	-
phone	Yes	string	origin callee
start_time	Yes	string	-
end_time	Yes	string	-
orderid	Yes	string	Passed in when the call is initiated
show_phone	Yes	string	display number
record_url	Yes	number	The remote address of the recording file of the call
answer_time	Yes	string	call answered time
direction	Yes	string	0: inbound 1: outbound
effective_called_number	Yes	string	called after formatted
hangup_cause	Yes	string	reason of hangup

API failed reason

info	desc
appkey or secretkey invalid	-
mobile no exist	-
page_size or page_index invalid	please check page or page_size limit
time invalid	please check start_time < end_time and the span cannot exceed 24 hours

hangup_cause please refer: WebCall CDR Hangup Cause