Deprecated
This Get Disposition list of a campaign API will be deprecated by 31st Aug 2024.
We recommend to start using the new version of the Disposition APIs.
Agent logs into CloudAgent toolbar and after successful call completion, the agent uses the “disposition” tab with necessary comments and pre-defined disposition reason to wrap up the call. This API helps you to get disposition reasons assigned to any campaign for a valid CloudAgent user. Users can use this API to list all the disposition types assigned to a specific campaign.
To access this API the following parameters MUST be passed.
| Parameters | Description |
|---|---|
| action* | 'get’ is the default parameter value |
| apiKey* | Available in CloudAgent admin login |
| campaignID* | Unique id mapped to the respective campaign |
| customer* | CloudAgent user name |
Note
Parameters with ‘*’ are mandatory parameters.
Possible Responses
| Success response | { "status": "Success", "details": [ ""Dispose1XXXX", "Dispose2XXXXX" ] } |
| Invalid apiKey | { "status": "Fail", "details": "Authentication fails" } |
| Invalid action | { "status": "Fail", "details": "Invalid action->XXXX" } |
| Invalid customer | { "status": "Fail" "details": "Authentication fails" } |
| Invalid campaignID | { "status": "Fail" "message": "No disposition found for campaign ID: XXX and user: XXXXXX" } |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.