VOICEBOT STREAM

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

Icon of vertical lines like a sound wave with a robot head above it.

Integrates a self-service virtual agent with voice scripts using a continuous stream of audio from the platform. This action allows NiCE CXone use streaming audio with SIP Protocol used for signaling and controlling multimedia communication sessions such as voice and video calls.connections.

This action does not allow you to change the virtual agent's behavior between turns. You only need one instance of this action in your script.

When you click Open Editor in this action's properties, Virtual Agent Hub options. The only provider options you see are those that support custom telephony. Currently, the only supported provider is Google Dialogflow CX VoiceStream. You can open Virtual Agent Hub from the NiCE CXone platform to see other providers available in your system.

Supported Script Types

Phone

Input Properties

These properties define data that the action uses when executing. You can use variable substitution in all of the properties of this action.

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.
virtualAgentId	The name of the virtual agent selected in the Virtual Agent Hub. When you assign a virtual agent app to a Studio action in Virtual Agent Hub, it automatically populates this property. The name is the value used in the Virtual Agent (Bot) Name field in the Virtual Agent Hub app. You can use variable substitution in this property.
CustomPayloadToBot	The variable that holds the custom payload to send to the virtual agent A software application that handles customer interactions in place of a live human agent.. Enter the name of the JSON object that passes data from the script to the virtual agent. You must define the custom payload object in a Snippet action. The object must be converted to JSON, either in the snippet or in the customPayload property. Don't use this property if you need to process data that the virtual agent returns to the script. Instead, use the customPayloadVarName (out) variable.
InitialIntent	The first intent The meaning or purpose behind what a contact says/types; what the contact wants to communicate or accomplish. that the action sends to the virtual agent A software application that handles customer interactions in place of a live human agent..

Output Properties

These properties contain variables that hold data returned from executing the action. They're available for reference and use when the action completes.

Property	Description
CustomPayloadFromBotVarName (out)	This variable contains the custom payload returned from the virtual agent A software application that handles customer interactions in place of a live human agent..
ErrorDetailsVarName (out)	When the Error branch is taken, this variable contains any details associated with the error.

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.
OnContained	The branch taken when the interaction with the virtual agent ends successfully.
OnErrorDuringSession	Path taken when the action fails to execute properly. For example, when there is an unexpected problem such as poor connectivity, syntax errors, and so on. The _ERR variable, with a single underscore character, should be populated with a condensed explanation of the problem.
OnEscalate	The branch taken when the interaction is escalated to a human agent.
OnFailedToInitialize	The branch taken when the profile named in virtualAgentID has the wrong credentials or the wrong virtual agent profile is selected.