post https://{domainname}/ca_apis/DispositionAPIV2
This 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. Alternatively, if the agent did not assign a disposition during the call, they can still do so during the wrap-up time or even after the wrap-up time has exceeded.
To use this API with the help of a token, follow these steps:
- Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
- Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
- With the token entered, pass the below header and body parameters:
| Parameter | Description |
|---|---|
| Content-Type* | Should be - application/json |
| pauseAfterDispose | This is not a mandatory parameter, when passed "true' agent will be moved paused state after the call disconnects. |
| comments | Any comments regarding the call |
| disposition* | Disposition that needs to be updated for this call |
| agentID* | ID of the agent who is handling that respective call |
| did* | Number from which calls are dialed out |
| autoRelease | true |
| ucid* | Unique identification number of the call that is generated in Agent toolbar |
| pauseReason | Reason to pause the work |
| action* | 'get’ - To get the disposition list for the account 'Set’ - To set a disposition for the call |
| callBackTime | This parameter is required when the callback option is enabled for the disposition. Please provide the value in the following format: YYYY-MM-DD HH:MM |
| userName* | Your CloudAgent username |
Note:
Parameters with ‘*’ are mandatory parameters.
Possible Responses
| Hitting the request when the token is expired. | {"status": "false","message": "Token Expired","data": null} |
| Missing Token. | "{""status"": ""false"",""message"": ""Token Should Not be Null or Empty."", ""data"": null}" |
| Passing Invalid Token. | {"status": "false","message": "Invalid Token","data": null} |
| Hitting API with valid inputs when the setting "API Authentication" is set to - 'Basic Auth' | "{""status"": ""false"",""message"": ""Api Key Should Not be Null or Empty."", ""data"": null}" |
| Disposing before disconnecting the call. | {"status": "Success","message": "Disposition Queued Successfully"} |
| Disposing after disconnecting the call. | "{""details"": ""Disposition saved successfully"", ""status"": ""Success""}" |
| Disposing of already disposed call. | "{""details"": ""This call is already Disposed."", ""status"": ""Fail""}" |
| Passing Invalid userName Key | "{""status"": ""false"", ""message"": ""Username Should Not be Null or Empty."",""data"": null}" |
| Passing Invalid userName Value | {"status": "false","message": "Invalid User Details","data": null} |
| Missing userName key | "{""status"": ""false"", ""message"": ""Username Should Not be Null or Empty."",""data"": null}" |
| Missing userName Value | "{""status"": ""false"", ""message"": ""Username Should Not be Null or Empty."",""data"": null}" |
| Passing Invalid action Key | "{ ""status"": ""Fail"", ""message"": ""Invalid Action"" }" |
| Passing Invalid action Value | "{""status"": ""Fail"", ""message"": ""Invalid Action""}" |
| Missing action key | "{ ""status"": ""Fail"", ""message"": ""Invalid Action"" }" |
| Missing action Value | "{ ""status"": ""Fail"", ""message"": ""Invalid Action"" }" |
| Passing Invalid agentID Key | "{""details"": ""Invalid agent"", ""status"": ""Fail""}" |
| Passing Invalid agentID Value | "{""details"": ""Invalid agent"", ""status"": ""Fail""}" |
| Missing agentID key | "{""details"": ""Invalid agent"", ""status"": ""Fail""}" |
| Missing agentID Value | "{""details"": ""Invalid agent"", ""status"": ""Fail""}" |
| Passing Invalid UCID Key | "{ ""status"": ""Fail"", ""message"": ""Invalid ucid"" }" |
| Passing Invalid UCID Value | {"details": "Invalid ucid [9012171] or did [914071327663]","status": "Fail"} |
| Missing UCID key | "{ ""status"": ""Fail"", ""message"": ""Invalid ucid"" }" |
| Missing UCID Value | "{""details"": ""Invalid ucid()"", ""status"": ""Fail""}" |
| Passing Invalid disposition Key | "{ ""status"": ""Fail"", ""message"": ""Invalid Disposition"" }" |
| Passing Invalid disposition Value | "{""details"": ""Invalid Disposition"", ""status"": ""Fail""}" |
| Missing disposition key | "{ ""status"": ""Fail"", ""message"": ""Invalid Disposition"" }" |
| Missing disposition Value | "{""details"": ""Empty disposition code"", ""status"": ""Fail""}" |
| PauseAfterDispose is enabled without passing a pause reason | {"details":"Provide pause reason","status":"Fail"} |
| In ACW, disposing multiple times | {"details":"This call is already Disposed.","status":"Fail"} |
| In ACW, within wrap-up time | {"details":"Disposition saved successfully","status":"Success"} |
| In ACW, wrap-up time exceeded | {"details":"This call is already Disposed.","status":"Fail"} |
| valid ucid but the mentioned agent is not on the call | {"details":"Agent is not on this call.","status":"Fail"} |
Further Insights
By default, the domain name is https://in1-ccaas-api.ozonetel.com. Please refer here to change based on the need.