CallBack API provides all the call information of call within the last 15 Days.
To access this API the following parameters are required.
| Parameter | Description |
|---|---|
| userName* | CloudAgent account name |
| apiKey* | CloudAgent admin login |
| ucid* | Unique Caller ID of that respective call in response |
| reportType* | Whether the provided UCID is for currentday/historical |
Note
- Maximum data available from this request is for 15 days.
- Rate limit for this API is 50 Requests per minute.
API Working Scenarios
Scenario 1
The call started before 12:00 AM IST and closed before 12:00 AM IST
If the API is triggered before 12:00 AM IST, the data will be available in Current Day records.
If the API is triggered post 12:00 AM IST, the data is available in historical. However important to note is the data will be available post 3:00 AM IST. This is because data is migrating from the Current day to the Historical database.
Scenario 2
The call started before 12:00 AM IST and was completed post 12:00 AM IST.
If the API is triggered post-12:00 AM IST, the report type will be historical, however, the data can be pulled only after 3:00 AM IST. This is because data is migrating from the Current day to the Historical database.
Scenario 3
The call started post 12:00 AM IST and was completed,
If the API is triggered post-12:00 AM IST, the report type will be the Current day, which will work as expected.
Possible responses
| Success response | "status": "success" "message":[{"monitorUCID": "xxxxxxxxxxxxxx" "UUI": "xxxxx" "Did": "xxxx" "CampaignName": "xxxxxx" "Location": "" "CallerID": "xxxxx" "PhoneName": "09xxxx46x9" "Skill": "None" "StartTime":"2021-02-09 10:33:53" "EndTime":"2021-02-09 10:38:50" "TimeToAnswer": "00:00:11" "CallDuration": "00:04:57" "Duration": "00:04:46" "FallBackRule": "AgentDial" "DialedNumber": "09xxxx679" "Type": "manual" "AgentID": "" "AgentPhoneNumber": "09xxxxxxx9" "AgentUniqueID": "None" "AgentName": "None" "Disposition": "" "HangupBy": "UserHangup" "Status": "Answered" "AudioFile": "https://s3.ap-xxxxxxxxxxxxxamazxxxxxxs.com/recxxxxxxxxgs.kxxxo.in/mahxxxx_txr/DIA03xxxxxxxxa208dd02xxxxxd2.mp3" "TransferType": "No Transfers" "TransferredTo": "" "Comments": "" "DialStatus": "answered" "Apikey": "KK7xxxxxxxxxx014c05b3efbaxxxxx1f70" "AgentStatus": "answered" "CustomerStatus": "answered" "UserName": "maxxxra_xxr" "CallerConfAudioFile": "" "ConfDuration": "00:00:00" "CampaignStatus": "OFFLINE" "DataUniqueId": "" "CallCompleted": "TRUE" "ConferenceData":}] |
| When userName is Empty or not passed | "status": "error" "message": "userName should not be empty" |
| When apiKey is Empty or not passed | "status": "error" "message": "apiKey should not be empty" |
| When ucid is Empty or not passed | "status": "error" "message": "ucid should not be empty" |
| When reportType is Empty or not passed | "status": "error" "message": "reportType should not be empty" |
| When reportType is Invalid | "status": "error" "message": "Invalid reportType" |
| When UCID is not numeric | "status": "error" "message": "ucid should be numeric only" |
| When Invalid userName or apiKey is passed | "status": "error" "message": "userName or apiKey is Invalid" |
| When rate Limit Exceeded | "status": "error" "message": "max limit exceeded" |
| When No Data Found | "status": "success" "message": "No Data Found with UCID xxxxx" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.