get https://{domainname}/CAServices/CDR/fetchCdrByUCID.php
Deprecation Update
This API will be deprecated by 31st Dec 2024.
We recommend to start using the new version of the API's to generate Call Detail Reports:
This API provides call details for a specific UCID. The following parameters are required to access this API:
| Parameter | Description |
|---|---|
| apiKey* | Available in CloudAgent admin login |
| userName* | CloudAgent account name |
| ucid* | Unique identification number of the call. |
| reportType* | Whether the provided UCID is for 'currentday' / 'historical'. If it is a current-day report, pass the value as - currentday If it is a historical report, pass the value as - historical |
Possible responses
| Success response | { "status": "success", "message": [ { "CallID": "9112xxxxxxxx2352", "UCID": "9112xxxxxxxx2352", "UUI": "", "Campaign Name": "Hosted_91xxxxxx4119", "Location": "", "Caller Id": "09xxxxx985", "Skill": "", "Call Date": "2024-08-03", "Start Time": "2024-08-03 22:28:43", "Time to Answer": "00:00:31", "End Time": "2024-08-03 22:29:29", "TalkTime": "00:00:15", "Duration": "00:00:46", "Customer Ring Time": "00:00:30", "FallBack Rule": "AgentDial", "Dialed Number": "1xx10", "Type": "Manual", "Agent": "test", "Disposition": "Call_autoDrop", "Status": "Answered", "Hangup By": "AgentHangup", "Transfer": "", "Transferred To": "", "comments": "d", "DialStatus": "answered", "CustomerStatus": "answered", "AgentStatus": "answered", "Wrapup Time": "00:00:05", "Rating": "0", "RatingComments": "", "Audio Download": "https://xxxxxxxxxx.mp3" } ] } |
| Missing userName value | { "status": "error", "message": "userName should not be empty" } |
| Missing apiKey value | { "status": "error", "message": "apiKey should not be empty" } |
| Invalid userName or apiKey is passed | {"status": "error","message": "userName or apiKey is Invalid"} |
| Missing ucid value | { "status": "error", "message": "ucid should not be empty" } |
| Missing reportType value | { "status": "error", "message": "reportType should not be empty" } |
| reportType value is invalid | { "status":"error", "message":"Invalid reportType" } |
| When No Data Found | { "status": "success", "message": "No Data Found with UCID 12345" } |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.