Collect Information

Collect Information

Description Allows to store DTMF inputs in Parameters, exiting based on whether or not an input was received. The parameter can also be used in other areas and verified via the "Check Parameter" activity.
Required Predecessor Accept
License
Advanced Routing Enterprise Routing  Contact Center
Modalities Audio / Video Instant Messaging Email External Task

Common Properties

Configurable Properties

Description

Prompt Type
  • Text-to-Speech (with Language Select & Text Field)
  • Audio Resources.

🔍 Audio resources can be added via Configuration > Resources . 

Prompt Language Allows to select the locale / voice to use when using the Text-to-Speech engine.
Prompt Text

✅ Only shown when "Prompt Type" = Text to Speech is selected. 

Allows you to add text that will be read in the prompt language / locale.

Input during announcement             
( barge in )

Defines when the caller is allowed to enter input:

  • if true - from the moment when the main prompt was started
  • if false - after the main prompt was fully played 

💡 When enabled, the "Time to complete started input" timer starts immediately upon first input. Any prompts at this point are stopped.

Parameter To Save

✅ Required: To be visible in this selection menu at least one Custom Parameter must be defined and made available to your service or tenant-wide via Organization Unit configuration.

 

Parameters can be used in the following areas:

Area
Usage within
Workflows

Workflow Activities

  • "Voicemail" 
  • "Input customer" 
  • "Collect Information" 
  • "Check Parameter"
Microsoft Power Automate Connector

Action "UpdateTask"

  • CustomContextParameter.<ID>

🔎 This activity also causes a “Parameter Updated” Trigger Event.

Conversation Context

As part of a context URL:

  • $(CustomContextParameters.<ID>)
Extension Service Settings

My Sessions UI customization:

  • "Session Details" widget
Input Timeout             
hh:mm:ss             

 

Defines the maximum time in which a caller can enter and complete the input:

  • default: 00:01:00,
  • min 00:00:03
  • max 00:30:00
  • If the time is reached and the caller didn't enter anything, the "No Input" exit is taken and nothing will be saved in the parameter as value.
  • The default parameter value - or in case of a loop - previous value entries will be kept unchanged when no entry is made.
Max DTMF Digits             
(default: 1,             
min:1,             
max 999)             

 

Defines the maximum of DTMF tone digits. The collection will be stopped automatically if the defined maximum is reached and the input is stored.

🔍 Further exit conditions may apply, see "Node Exits" description below.

Node Exits

The "input received" activity exit is taken under the following conditions:

  • When the caller entered the max number of digits.
  • When the the caller completes the input with the #. The # character will not be saved as input
  • When the timeout is reached and the caller has entered at least one digit (but less than < MAX DTMF Digits)

In all cases the parameter is stored and the default / previous parameter is overridden.

ACCOUNT FOR PARAMETER PROCESSING DELAYS

A common use case is to add a "Check Parameter" activity right after your "Collect Information":

  • In a "same parameter / Nimbus internal" scenario this should work without problems, as there are no expected delays in parameter storage and processing.
  • in a "different parameter / external system" scenario a custom parameter input "lookup_param_1" could be used to store look-up info for handling in an external system. The results would be stored in "return_param_2".              
    ☝ This data-handling process may take time that a Nimbus workflow does not account for.

Recommendation: When involving an external system (e.g. using the Microsoft Power Automate Connector ), add an "Announcement" or other delaying workflow activity that allows "Check Parameter" to catch the updated return value.

 
 
 

Audio / Video

 
 

Instant Messaging

💡Customer data visibility: During an ongoing Instant Messaging session, any messages that customer enters into the chat will be visible to the Nimbus user, including information entered during the “Collect Information” activity input duration.

 
Configurable Properties

Description

Prompt Type Not applicable.
Prompt Language Not applicable.
Prompt Text Multi Line Text Box with Custom Parameters and System Fields and Parameters support.
Input during announcement             
( barge in )
Not applicable.
Parameter To Save
Input Timeout             
hh:mm:ss             

 
Max DTMF Digits             
(default: 1,             
min:1,             
max 999)             

 
Not applicable.
Node Exits

💡 There is no input validation.

  • If any input is provided by the customer the "Input Received" exit is taken. 
  • With a "Input timeout" specified and no input given, the "No Input" exit is taken.
 
 

Table of Contents