WebCall CDR List By OrderId

Summary

Get CDR by orderid

Limit

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

Request URI

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

Request Params

field	required	type	desc
orderid	是	string	orderid, passed in when initiating a call. Use commas to concatenate multiple items, e.g. "1000001,1000002", up to 20 orderids can be queried
appkey	Yes	string	Get it from nxcloud console
secretkey	Yes	string	Get it from nxcloud console

Request Example

    {
        "orderid":"1000001,1000002",
        "appkey":"yourappkey",
        "secretkey":"yoursecretkey"
    }

Response Example

success

{
    "code": "0",
     "row": [
     {
     "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",
     "end_time": "2019-01-25 12:42:26",
     "effective_called_number": "626281314382782",
     "start_time": "2019-01-25 12:42:26",
     "orderid": "1000001",
     "record_url": "http://wss.wanlaowo.com/record/c8b4cc48.mp3",
     "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",
     "end_time": "2019-01-25 12:42:29",
     "effective_called_number": "626287882866266",
     "start_time": "2019-01-25 12:42:29",
     "orderid": "10000002",
     "record_url": null,
     "show_phone": "6282215699803"
     }
        ]
    }

fail

  {
    "code": "1",
    "info": "params 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	-
orderid no exist	-

hangup_cause please refer: WebCall CDR Hangup Cause