Onrelease

This help page is for Desktop Studio. This information is also available for Studio.

Icon of OnRelease: envelope with a voicemail symbol and a lightning bolt badge

Processes the end of an interactionClosed The full conversation with an agent through a channel. For example, an interaction can be a voice call, email, chat, or social media conversation., such as emailing a voicemail or sending data to a database or a website.

Dependencies

  • Onrelease is an event action.
  • When a caller, agent, or the Hangup action hangs up the phone or an END action executes, the system releases the contact and terminates the script unless the script includes an Onrelease event action. If Onrelease is present, the script executes the actions connected to Onrelease and then terminates.
  • ONRELEASE branches have the following restrictions: 
    • Do not add HANGUP or END to an ONRELEASE event branch. Both actions initiate an ONRELEASE event, so adding them to this branch may affect the termination of the script.
    • Media-specific actions (such as Play, Menu, or Record) are not allowed after the Onrelease event.
    • TheRunsub and Runscript actions should not be placed after the Onrelease action.
    • If the Onrelease branch includes a Stop action, the script terminates after executing STOP.
  • To process a phone call contact, NiCE CXone uses a Voice port. After a call has been completed, NiCE CXone uses an Other port (if one is available) to handle end of call processing. If there is not an Other port available, NiCE CXone continues to use the Voice port.
  • For troubleshooting purposes, when you run the script trace debugger in Studio, the SS7 cause codes auto-populate the _CALLRESULT, _CAUSECODE, and _CAUSECODECATEGORYID variables to indicate the reason a call was released.
  • There can be only one Onrelease event action in a script.

Supported Script Types

The icon for a Generic script type - a rectangle with < and > symbols inside it.

The icon for the Email script type - a large @ symbol in a diamond.

The icon for the Chat script type - a chat bubble with an ellipsis inside (...), in a diamond shape.

The icon for the Phone script type - an old-style phone handset with curved lines indicating sound coming out of it.

The icon for the Voicemail script type - a symbol that looks like a cassette tape - two circles sitting on a horizontal line.

The icon for the Work Item script type-a piece of paper with one corner folded down and a bullet list on it.

The icon for the SMS script type - a smart phone with a chat bubble coming out of it.

The icon for the Digital script type - a computer monitor with a smartphone next to it.

Generic

Email Chat Phone Voicemail Work Item SMS Digital

Input Properties

These properties define data that the action uses when executing.

Property

Description

Caption

Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon. The default is the action name.

CauseCode

The name of the variable that stores the cause code. Cause codes are numeric values that are sent by the phone carrier in case of an error. If nothing is entered, the variable will default to p1.

CallResult

Not used.

Result Branch Conditions

Result branch conditions allow you to create branches in your script to handle different outcomes when an action executes.

Condition

Description

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 action's other branches are not defined.