get https://{domainname}/CAServices/Disposition/DispositionAPIV2.php
SetDisposition API helps to set the disposition from the CRM Page, instead of setting it from the agent toolbar manually. Users can also use this API to ‘Pause after this call’ feature simultaneously disposing of the call. Agents can update the disposition reason while they are still on call and save the disposition to get queued in the backend. The queued disposition will be updated as soon as the call gets disconnected.
To access this API the following parameters MUST be passed.
| Parameter | Description |
|---|---|
| action | 'Set' is the default parameter value |
| apiKey | Available in CloudAgent admin login |
| agentId | Unique id mapped to an agent |
| customer | CloudAgent user name |
| did | Number from which calls are dialed out |
| comments | Any comments regarding the call |
| ucid | Unique caller ID used for monitoring call details |
| disposition | Disposition that needs to be updated for a call |
| pauseReason | Reason to pause the work |
| pauseAfterDispose | 'true’ is the default parameter value |
Possible responses
| Success response | "details": "Disposition saved successfully" "status": "Success" |
| Invalid api_key | "details": "Authentication fails" "status": "Fail" |
| Invalid UCID | "details": "Invalid ucid [8189XXXXX] or did [9140XXXXXXX"] "status": "Fail" |
| Invalid action | "details": "Invalid action->XXXXX" "status": "Fail" |
| Invalid username | "details": "Authentication fails" "status": "Fail" |
| Invalid DID | "details": "Invalid ucid [8189XXXXX] or did [9140XXXXXXX"] "status": "Fail" |
| Empty disposition value | "details": "Empty disposition code" status": "Fail" |
| Empty Pause reason | "details": "Provide pause reason." "status": "Fail" |
| Success Pause response | "details": "Disposition saved successfully" "status": "Success" |
| Invalid agentID | “details”: ”Invalid agent” ”status”: ”Fail” |
| Queued disposition | "details": "queued successfully" "status": "Success" |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.