User Input

N2FE Flow Operation - User Input

The UserInput requests the network infrastructure to prompt the caller to enter a digit string via their DTMF keypad or equivalent.

The UserInput operation has two exits. If the caller abandons (i.e. hangs up) during the announcement, no further processing is performed and no exit is followed.

Otherwise, the exits followed are:

Config Parameters

The UserInput operation config attributes are as follows.

Parameter Type Description
main_announcement Announcement
Object
[Required] The main_announcement parameter is an Object using the shared announcement configuration structure as defined in the Flow Introduction documentation. This announcement is played as the prompt on the caller's first attempt to enter input.
reprompt_announcement Announcement
Object
[Required] The reprompt_announcement parameter is an Object using the shared announcement configuration structure as defined in the Flow Introduction documentation. This announcement is played as the prompt on the caller's second and subsequent attempts to enter input.
max_iterations Integer The maximum number of attempts that the caller may have to enter a valid User Input.
(Default = 3)
min_digits Integer [Required] The minimum number of digits which may constitute a valid User Input. This value must be in the range of 1-20 inclusive and must be <= max_digits.
max_digits Integer [Required] The maximum number of digits which may constitute a valid User Input. This value must be in the range of 1-20 inclusive and must be >= min_digits.
end_character String Controls how the "End of Input" digit is handled when the caller is entering input digits. This must be either default (use system default behavior), or none (no end of input digit will apply to this interaction).
(Default = default)
cancel_character String Controls how the "Cancel Input" digit is handled when the caller is entering input digits. This must be either default (use system default behavior), or none (no cancel of input digit will apply to this interaction).
(Default = default)
repeat_main Integer If present and non-zero, indicates if the main_announcement should be repeated before the reprompt_announcement on the second and subsequent attempts to collect user input.
_(Default may vary per site)_
target_buffer User Buffer [Required] This must be the Name of a User Buffer (e.g. user.postcode or user.input) into which the entered value will be written (after passing validation checking). See the notes on Buffer Names in the Flow Introduction documentation. The GUI may allow free-form entry for the user buffer name, or may restrict it to pre-determined values.

Example Operation

Here is an example UserInput operation in JSON representation.

    {
        "id": 5,
        "type": "UserInput",
        "base_node": 1,
        "config": {
            "main_announcement": { "set": "General Purpose Anns",
                                   "entry": "Please Enter User Input", "repetition": 1 },
            "reprompt_announcement": { "set": "General Purpose Anns",
                                       "entry": "Invalid Input Please Try Again", "repetition": 1 },
            "min_digits": 9,
            "max_digits": 12,
            "end_character": "none",
            "cancel_character": "none",
            "target_buffer": "user.follow_me"
        },
        "exits": [ 4, 17 ]
    }

The entered User Input must be either 044327xyz, 044329xyz, or 044329xyz, or 063581140.

If the caller enters a valid User Input, and does not Abandon the call, then processing will continue down exit index 0 to operation ID 4.

If after three attempts the User has failed to enter a valid input, processing will continue down exit index 1 to operation ID 17.

Exits

There are always exactly two exits for an UserInput operation.

Exit Index Name Description
1 Success [Required] This exit is followed if the caller successfully entered a valid User Input, and did not Abandon the interaction.
1 Invalid Input [Required] This exit is followed if the caller failed to enter a valid input after the maximum number of iterations, and is still connected at the end of the interaction.