get https://{domainname}/CAServices/CDR/fetchCdrByUCID.php
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 are required.
| 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 |
Note
- Following is the format to pass bulkData
3 sample data:
[["PhoneNumber": "040XX XXXX"
"Name": "xxxx1"
"ScheduledTime": "YYYY-MM-DD HH:MM:SS"
"skill": "skill_Namexxxx1”
"AgentID": "AgentIDxxxx1"
"Priority": "2"]
["PhoneNumber": "949XXXXX"
"Name": "Namexxxx2"
"ScheduledTime": "YYYY-MM-DD HH:MM:SS"
"skill": "skill_Namexxxx"
"AgentID": "AgentIDxxxx"
"Priority": "2"],
["PhoneNumber": "87XXXXXX"
"Name": "NameXXX3"
"ScheduledTime": "YYYY-MM-DD HH:MM:SS"
"skill": "Skill_NameXX3"
"AgentID": "AgentIDxxxx3"
"Priority": "10"]]}- In addition to ScheduledTime and PhoneNumbers(valid), users can pass additional parameters like Name, Priority, and ExpiryDate to respective phone numbers. These headers are to be predefined from the Mapping file while creating the campaign.
- AgentID header and parameter value are mandatory for Agentwise campaigns.
- Parameters with ‘*’ are considered to be mandatory parameters.
Possible responses
| Success response | "status": "success", "message": [{"Response": "success", "ScheduleTime": "YYYY-MM-DD HH:MM:SS", "campaign_name": "Schedxxxx", "PhoneNumber": "040XXXXX", "Name": "NameXXX2", "AgentID": "AgentID2XXX", "skill": "Skill_2", "msg": "Data updated successfully", "index": "0" |
| Invalid api_key | "status": "error" "message": "api_key or campaign_name is invalid or not found" |
| Invalid Campaign name | "status: "error" "message": "api_key or campaign_name is invalid or not found" |
| Missing ScheduledTime | "status": "error" "message": "Mandatory parameter ScheduledTime is in bulkData map" |
| Missing bulkData | "status": "error" "message": ["Mandatory parameter bulkData is missing", "Invalid Data or Data limit should be in between 1 and 100"]} |
| Missing PhoneNumber | "status": "success", "message": [{ "Response": "success", "ScheduleTime": "YYYY-MM-DD HH:MM:SS", "campaign_name": "Schedxxxx", "PhoneNumber": "", "Name": "NameXXX2", "AgentID": "AgentID2XXX", "skill": "Skillxxxxx2", "msg": "Data updated successfully", "index": 0}], |
| Invalid Date format | "status": "error" message": "Wrong Date format" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.