START VOICE BIO AUDIO

Streams audio to the voice biometrics service. The other voice biometrics actions in the script use the streaming audio to check enrollment status or to authenticate the contact The person interacting with an agent, IVR, or bot in your contact center..

Dependencies

• Use this action only for adding voice biometric authentication to IVR or virtual agent integrations. If you're setting up voice biometric authentication for use in interactions with live agents, you do not need these actions.

• This action must be placed after GET VOICEBIO PRINT STATUS and before the other voice biometrics actions. It starts the audio stream that the other voice biometric actions use.

• This action cannot be used alone. It must be used with the other voice biometrics Studio actions:

  • VOICEBIO AUTHENTICATION
  • VOICEBIO ENROLLMENT
  • GET VOICEBIO STATUS
  • GET VOICEBIO RESULT

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
Add Caption	Enter a short phrase that uniquely identifies this action in the script. The caption appears on the script canvas under the action icon.
VoiceBioProfileId	The ID of the voice biometric profile associated with the contact.
scriptParams	The name of the variable that holds data to pass to the voice biometric provider. The data must be defined in a Snippet action using the Script Parameters code snippet. The variable you use in this field must hold the data in JSON format. If you don't include the snippet, you don't need to complete this field.  The default is {voiceBioResultInfo.voiceBioSessionId}.
stopaudiostream	Defines whether audio is sent to the voice biometric provider for authentication. Set to True to start sending audio. Set to False to stop sending audio.

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
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.
Error	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.
Success	Path taken if the action completes without errors and any API calls or data returns were successful (2xx response codes).