get https://{domainname}/cloudAgentRestAPI/index.php/CloudAgent/CloudAgentAPI/getCallLogs
The Get Call logs API is used to retrieve the previous call details of the respective user. This API retrieves call details report for the past month, and data includes the DID, Location, Campaign, and Skill to which the call was assigned, the duration of the call, whether the call has been transferred to any skill, any remarks entered by the agent and more information including the details of the agent.
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| api_key* | Available in CloudAgent admin login |
| user_name* | CloudAgent account name |
| from_date* | Start date to retrieve the call log. Day format YYYY-MM-DD |
| to_date* | End date to retrieve the calls log. Day format YYYY-MM-DD |
| campaign_name | Name of the campaign. If needed to pull call logs per campaign then this field can be entered. |
| format | json/xml Response format |
Note
- Parameters with ‘*’ are mandatory parameters.
- The time format to follow while giving the input parameters is YYYY-MM-DD HH:MM:SS.
- Date and time should be encoded and passed in the parameter value field.
- Difference between from_date and to_date should not be more than 30 days.
- Rate Limit for this API is only 10 Requests will be allowed within an Hour.
Possible responses
| Success Response | { "status": "success", "message": [ { "monitorUCID": "1733400817231702", "UCID": "1733400817231702", "UUI": "Manual Dial", "Did": "918xxxxxxx4", "CampaignName": "Inbound_918xxxxxxx4", "Location": "", "CallerID": "85xxxxx44", "PhoneName": "506298", "SkillID": "", "Skill": "", "StartTime": "2024-12-05 17:43:37", "EndTime": "2024-12-05 17:43:37", "TimeToAnswer": "00:00:00", "CallDuration": "00:00:00", "Duration": "00:00:00", "FallBackRule": "Agent Dials", "DialedNumber": "506299", "Type": "Manual", "AgentID": "xxxx", "AgentPhoneNumber": "506299", "AgentUniqueID": "255123", "AgentName": "xxxxx", "Disposition": "", "HangupBy": "AgentHangup", "Status": "NotAnswered", "AudioFile": "", "TransferType": "No Transfers", "TransferredTo": "", "Comments": "", "DialStatus": "Telephony error", "Apikey": "", "AgentStatus": "Telephony error", "CustomerStatus": "NotDialed", "UserName": "", "CallerConfAudioFile": "", "ConfDuration": "00:00:00", "CampaignStatus": "ONLINE", "TotalWrapupTime": "00:00:00", "TotalHandlingTime": "00:00:00", "CustomerRingTime": "00:00:00" } ] } |
| Empty api_key | “status”: “failure” “message”: “Please provide API Key” |
| Empty userName | “status”: “failure” “message”: “Please provide UserName” |
| Invalid api_key | "status": "failure" "message": "no record found" |
| Invalid Campaign name | "status": "failure" "message": "no record found" |
| Invalid Username | "status": "failure" "message": "no record found" |
| The requested data is for more than 30 days | "status": "failure" "message": "The Requested date should not be more than 30 days" |
| If more than 10 requests are received within an hour | "status": "failure" "message": "Max Limit Exceeded" |
| If no data found | “status”: “failure” “message”: “no record found” |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.