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.

ParameterDescription
action'Set' is the default parameter value
apiKeyAvailable in CloudAgent admin login
agentIdUnique id mapped to an agent
customerCloudAgent user name
didNumber from which calls are dialed out
commentsAny comments regarding the call
ucidUnique caller ID used for monitoring call details
dispositionDisposition that needs to be updated for a call
pauseReasonReason 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.

Language
URL
Click Try It! to start a request and see the response here!