|
Designed to terminate an active contact based on the unique contact ID. This can be used in any media type or channel and forces the active contact to conclude upon proper execution. Typical uses cases would be in emergency scenarios, clearing stuck contacts from queue, terminating a specific script (i.e. spawned), or when using API calls to run your agent application. |
Supported Script Types
Properties
| Property |
Details |
| SecurityUser
|
The output value of the SetSecurityUser action which authenticates a selected agent based on their permissions in the security profile. This field accepts {variables}. The default value is SecurityUser (same default output value of SetSecurityUser). |
| ContactID
|
The desired state to which the agent will be set after executing this action successfully. Options include Unavailable or Available and can be consumed as variables.
|
Branches
| Branch |
Details |
| Default
|
Path taken unless the script meets a condition that requires it to take one of the other branches. It is also taken if the other branches are not defined.
|
| OnSuccess
|
Path taken if the action completes without errors, and any API calls or data return were successful. |
| OnInvalidContactID
|
Path taken if the requested Contact ID is invalid. |
| OnUnauthorized
|
Path taken if the SecurityUser does not have the correct roles/permissions in order to execute the API action.
|
| OnInvalidSecurityUser
|
Path contact will take when an invalid security user is used. |
Output Variables
| Variable |
Details |
| __DISCONNECTREASON
|
TerminateScript |
Similar Solutions
If terminating a specific script, you can use the End action. To terminate an active voice contact within the same script, you can use the ContactEnd action.
