Deprecation Update
This API will be deprecated by 30th April 2025.
We recommend to start using the new version of the APIs:
Get Customer Hold Details API is used to retrieve hold time duration for historical call records. Data can be retrieved for any one of the previous days at a time, on the basis of certain parameters. Response data includes all details regarding a Hold time duration within a call.
To access this API we MUST pass the following parameters.
| Parameter | Description |
|---|---|
| apiKey* | CloudAgent authentication key |
| userName* | CloudAgent username |
| fromDate* | Respective date required in YYYY-MM-DD format |
Note
- Parameters with ‘*’ are considered to be mandatory parameters.
- This API allowes 1 request for 5 minutes.
Possible responses
Success response | "status": 1 |
Invalid apiKey | "status": 0 |
Invalid userName | "status": 0 |
Invalid Date format | "status": 0 |
Missing mandatory parameters | "status": 0 |
Get requests when another process is running | "status": 0 |
No records found | "status": 1 |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.