Purpose
The delete API is used to delete an Interaction.
UI Reference: The API is called when the delete interaction button is selected from the Interaction>More button.
URI: webapp-api-history?api=delete
Access Rights Required: Administrator
Request
This API is used within the UI so agents can delete interactions from the MORE menu. This is also a stored procedure in the iService database that can be used to delete interaction.
Request Parameters
Name |
Type |
Description |
|---|---|---|
interactionID |
String |
This parameter represents the id of interaction. |
pageAction |
String |
This parameter represents the action name which was performed. |
pageName |
String |
This parameter represents the page name. |
Request Payload Example
{ |
Response
If the delete fails, errors will be included in the JSON response.
Response Parameters
Name |
Type |
Description |
|---|---|---|
errors |
Array |
An array of strings. Returns the error message if an error is encountered, otherwise a blank array if there is no error. |
errordetails |
Array |
An array of strings. Provides detailed information about the error encountered, otherwise returns a blank array if no error is encountered. |
Response Example
{ |
