Use this API to retrieve Call Detail Records (Detailed View) for any specific day within the past 15 days from the time of the request.
Note:
Make sure the admin setting 'API Authentication' is set to 'BASIC_AUTH', If you are using this API.
Header parameters
| Parameter | Description |
|---|---|
| apiKey* | Your CloudAgent account API Key |
| Content-Type | application/json |
Body Params
Pass the body params in the format:
{
"fromDate": "YYYY-MM-DD HH:MM:SS",
"toDate": "YYYY-MM-DD HH:MM:SS",
"userName": "xxxx",
"ucid": "123",
"campaignName": "xxxxxxxxx",
"monitorUCID": "17xxxxxxx9372",
"callType": "Progressive",
"status": "NotAnswered"
}
Note:
- Mandatory Parameters are:
- fromDate
- toDate
- username
- Rate limit: Maximum of 2 requests per minute.
- The API provides data for a single day within the last 15 days from the time of the request.
Possible responses
Success Response | { |
Passing Invalid apiKey Key / Missing apiKey key | {"status": "false","message": "Missing userName or apiKey"} |
Invalid apiKey Value / Missing apiKey Value | {"status": "false","message": "userName or apiKey is Invalid"} |
Invalid userName Key/ Missing userName key / Missing userName Value | {"status": "false","message": "Missing userName or apiKey"} |
Invalid userName Value | {"status": "false","message": "userName or apiKey is Invalid"} |
Invalid fromDate Key / Missing fromDate key / Missing fromDate Value / Invalid toDate Key / Missing toDate key / Missing toDate Value | {"message": "Missing fromDate and toDate","status": "fail"} |
Invalid fromDate Value / Invalid toDate Value | {"message": "Invalid fromDate format. Please pass the date in the format yyyy-MM-dd HH:mm:ss","status": "fail"} |
Invalid campaignName | "{""message"": ""Invalid campaignName"", |
If future dates passed | {"message": "fromDate and toDate should not be future dates","status": "fail"} |
When passed a range of dates Like FromDate: 2024-09-01 | {"message": "fromDate and toDate should be same date","status": "fail"} |
When more than 2 hits per minute are made | {"message": "API rate limit has been exceeded","status": "error"} |
When passed invalid or wrong JSON. | {"status": "false","message": "Invalid Json Pass Valid Json"} |