OZozonetel
Disposition

Set Disposition for a Call

Allows setting disposition for a specific UCID and agent.

post/ca_apis/DispositionAPIV2

Request

  • Base URL
    https://{domainname}
  • URL
    https://{domainname}/ca_apis/DispositionAPIV2
  • Auth
    none declared. Required headers: apiKey, Content-Type

Headers

apiKeystring required
Content-Typestring required

Request body

pauseAfterDisposestring

Optional. Set to 'true' to pause the agent after setting the disposition.

commentsstring

Any comments regarding the call.

dispositionstring required

Disposition that needs to be updated.

agentIDstring required

ID of the agent who handled the call.

didstring required

DID used to dial the call.

autoReleasestring

Set to 'true' to auto release after disposition.

ucidstring required

Unique Call ID for which disposition is being set.

pauseReasonstring

Reason to pause the agent after call.

callBackTimestring

Callback time in 'YYYY-MM-DD HH:MM' format if disposition has callback enabled.

action'Set' required

Should always be 'Set' for this API.

userNamestring required

Your CloudAgent username.

Example request

{
  "pauseAfterDispose": "true",
  "comments": "Customer not interested",
  "disposition": "Not Interested",
  "agentID": "agent001",
  "did": "9180xxxxxx",
  "autoRelease": "true",
  "ucid": "1234567890123",
  "pauseReason": "Break",
  "callBackTime": "2025-06-01 15:30",
  "action": "Set",
  "userName": "demo_user"
}

Response

Disposition successfully set

Changes

No recorded changes to this operation across all 1 revision of this API.