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.
Rate Limit:
A maximum of 5 requests per minute is allowed.
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
{
"fromDate": "2024-11-28",
"toDate": "2024-11-28",
"userName": "xxxxx"
}
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 |