Set Disposition



This Set Disposition API will be deprecated by 31st Aug 2024.

We recommend to start using the new version of the Disposition APIs.

Set Disposition API helps to set the disposition from the CRM Page, instead of setting it from the agent toolbar manually. Using this API, the agent can set the disposition during the wrap-up time after the call has ended.

To access this API the following parameters MUST be passed.

action*'Set' is the default parameter value
apiKey*Available in CloudAgent admin login
agentIdUnique id mapped to an agent
customer*CloudAgent user name
did*Number from which calls are dialed out
commentsAny comments regarding the call
ucid*Unique caller ID used for monitoring call details
disposition*Disposition that needs to be updated for a call

Possible responses

Success response"details": "Disposition saved successfully"
"status": "Success"
Invalid api_key"details": "Authentication fails"
"status": "Fail"
Invalid UCID"details": "Invalid ucid ata": {
or did "Success respo
"status": "Fail"
If the passed UCID has 20 or more characters"status":"Error",
"details":"Unable to Dispose . Please retry after some time."
Invalid action"details": "Invalid action->XXXXX"
"status": "Fail"
Invalid username"details": "Authentication fails"
"status": "Fail"
Invalid DID"details": "Invalid ucid ata": {
or did "Success respo
"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 Please refer here to change based on the need.

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