get https://{domainname}/CAServices/CDR/CDRDump_pagination.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:
CDR Dump API provides detailed call reports from the reporting portal and dashboard portal with pagination. Instead of all records, only limited records will be returned in the response, based on page number and page count. For example, if pageNumber is 3 and pageSize is 50, the API will show CDR dump records from 101 to 150.
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| userName* | CloudAgent user name |
| apiKey* | Available in CloudAgent admin login |
| campaignName | Name of the campaign which details are to be retrieved. If '0' then it is for all available campaigns |
| fromDate* | Start date to retrieve the information. Pass the value in the format YYYY-MM-DD HH:MM:SS |
| toDate* | End date to retrieve the information. Pass the value in the format YYYY-MM-DD HH:MM:SS |
| reportType* | It can be 'currentday' or 'historical' |
| pageNumber | Default value will be 1 if not passed |
| pageSize | Default value will be 100 if not passed |
Note
- The parameters with '*' are mandatory parameters.
- Data for the last 30 days can be pulled with this request.
- The rate Limit is 50 Requests Per Minute Per User.
Possible responses
| Success response | { "status": "success", "message": [ { "rn": "1", "CallID": "9062173329753891", "UCID": "9062173329753891", "UUI": "", "Campaign Name": "ContactManger_918xxxxxx5", "Location": "", "Caller Id": "88xxxxxx8", "Skill": "", "Call Date": "2024-12-04", "Start Time": "13:02:18", "Time To Answer": "00:00:00", "End Time": "13:02:19", "TalkTime": "00:00:00", "Duration": "00:00:01", "CustomerRingTime": "00:00:00", "FallBack Rule": "Agent Dials", "Dialed Number": "500964", "Type": "Manual", "Agent": "Atul", "Disposition": "", "Status": "Unanswered", "Hangup By": "Agent Disconnect", "Transfer": "", "Transferred To": "", "comments": "", "DialStatus": "InvalidNumber", "CustomerStatus": "NotDialed", "AgentStatus": "InvalidNumber", "Wrapup Time": "00:00:00", "Rating": "", "RatingComments": "", "Audio Download": "" }, { "rn": "3", "CallID": "35433297473303532", "UCID": "35433297494375541", "UUI": "Bangalore_Sales", "Campaign Name": "Inbound_919xxxxxx1", "Location": "Hyd", "Caller Id": "+9188xxxxxx8", "Skill": "Surya_doc", "Call Date": "2024-12-04", "Start Time": "13:01:34", "Time To Answer": "00:00:00", "End Time": "13:01:39", "TalkTime": "00:00:00", "Duration": "00:00:05", "CustomerRingTime": "00:00:00", "FallBack Rule": "Agent Dials", "Dialed Number": "500964", "Type": "Inbound", "Agent": "Atul", "Disposition": "", "Status": "Unanswered", "Hangup By": "Caller Disconnect", "Transfer": "", "Transferred To": "", "comments": "", "DialStatus": "user_disconnected", "CustomerStatus": "", "AgentStatus": "user_disconnected", "Wrapup Time": "00:00:00", "Rating": "", "RatingComments": "", "Audio Download": "" }, { "rn": "2", "CallID": "10272173329746642", "UCID": "10272173329746642", "UUI": "", "Campaign Name": "Inbound_9192xxxxxx1", "Location": "", "Caller Id": "+9199xxxxxx2", "Skill": "", "Call Date": "2024-12-04", "Start Time": "13:01:06", "Time To Answer": "00:00:17", "End Time": "13:02:19", "TalkTime": "00:00:56", "Duration": "00:01:13", "CustomerRingTime": "00:00:16", "FallBack Rule": "Agent Dials", "Dialed Number": "500966", "Type": "Manual", "Agent": "Agent1", "Disposition": "General Enquiry", "Status": "Answered", "Hangup By": "Agent Disconnect", "Transfer": "", "Transferred To": "", "comments": "test call~~", "DialStatus": "answered", "CustomerStatus": "answered", "AgentStatus": "answered", "Wrapup Time": "00:00:10", "Rating": "", "RatingComments": "", "Audio Download": "https://s3.ap-southeast-1.amazonaws.com/recordings.kookoo.in/demo_user/DIA835522ef5b2679422919af3ce1c2670a.mp3" } ], "pageNumber": 1, "pageSize": 100, "totalCount": "3", "fromDate": "2024-12-04 13:01:05", "toDate": "2024-12-04 13:02:20" } |
| Empty userName | "status": "error" "message": "userName should not be empty" |
| Empty apiKey | "status": "error" "message": "apiKey should not be empty" |
| Empty fromDate | "status": "error" "message": "fromDate should not be empty" |
| Empty toDate | "status": "error" "message":"toDate should not be empty" |
| Empty reportType | "status": "error" "message": "reportType should not be empty" |
| Empty pageNumber | "status": "error" "message": "pageNumber should not be empty or zero" |
| Empty pageSize | "status": "error" "message": "pageSize should not be empty or zero" |
| Invalid pageNumber format | "status": "error" "message": "pageNumber should be Numeric only" |
| Invalid pageSize format or size | "status": "error" "message": "pageSize should be Numeric and Between 10 to 500 only" |
| Invalid reportType | "status": "error" "message": "Invalid reportType" |
| Invalid Date format | "status": "error" "message": "From and To Date should be in yyyy-mm-dd HH:mm:ss Format" |
| If report type is current day && from or to date is not current date | "status": "error" "message": "From Date and To Date should be Current Day only" "status": "error" "message": "From Date should not be Greater than To Date" |
| If report Type is historical && from or to date is less than or equal to current date | "status": "error" "message": "From Date and To Date should not be Greater than or Equal to Current Date" |
| If report Type is historical && diff between from and to date is greater than 30 days | "status": "error" "message": "Difference Between From and To Date should not be Greater than 30 Days" |
| Invalid apiKey | "status": "error" "message": "userName or apiKey is Invalid" |
| Invalid userName | "status": "error" "message": "userName or apiKey is Invalid" |
| Invalid campaignName | "status": "error" "message": "campaignName is Invalid" |
| If more than 50 Request received in a minute | "status": "error" "message": "max limit exceeded"} |
| No data is found | "status": "error" "message": "No Data Found" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.