WebCall CDR Webbook

Summary

NXCLOUD callback push API

When and How

NXCLOUD will try to push the CDR to the customer's http(s) address after each call ends, and the customer can configure their own callback address in the NCLOUD console. NXCLOUD will retry the push every minute within 1 hour at most. If it fails 5 times, it will not re-push.

Content-Type

application/json

Request Body

Params

field	required	type	desc
sessionid	Yes	string	NXCLOUD sessionid,globally unique
sipid	Yes	string	webcall sipid, don't care
code	Yes	string	country code. e.g. 852 62 1
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

Example

{
  "show_phone": "6298881888",
  "direction": 0,
  "end_time": "1555484089",
  "record": 1,
  "answer_time": "1555484086",
  "sipid": "1049002",
  "code": "86",
  "start_time": "1555484075",
  "duration": 3,
  "phone": "4444",
  "username": "6298881888",
  "mobile_name": "first mobile",
  "orderid": "1001233",
  "record_url": "https://as01.nxcloud.com/record/bf1b9043-cb9f-048f-cc97-0f939dc94609",
  "hangup_cause": "NORMAL_CLEARING",
  "sessionid": "bf1b9043-cb9f-048f-cc97-0f939dc94609"
}

Response

HTTP 200 OK means customer success receive this push request. NXCLOUD would not re-push this record.