Navigation :

Speed Dial

The SpeedDial operation requests the network infrastructure to prompt the caller to enter a “Speed Dial Code”. The Speed Dial Code must match one of the Speed Dial Codes configured for this customer at the time of calling. If a known Speed Dial Code is provided, then the processing will attempt to terminate to the “Speed Dial Destination” associated with that Speed Dial Code.

The SpeedDial operation has three 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:

Speed Dial found but destination gives Busy/NoAnswer.
Insufficient Digits (caller did not supply sufficient valid digits).
No Match (caller entered digits, but they did not match a known speed dial).

Config Parameters

The SpeedDial 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 Speed Dial Code. (Default = 3)
`min_digits`	Integer	[Required] The minimum number of digits which may constitute a valid Speed Dial. This value must be in the range of `1`-`5` inclusive and must be <= `max_digits`.
`max_digits`	Integer	[Required] The maximum number of digits which may constitute a valid Speed Dial. This value must be in the range of `1`-`5` inclusive and must be >= `min_digits`.
`timeout_seconds`	Integer	The number of seconds for which the Speed Dial Destination should be rung before deciding that the call is unanswered and proceeding to the Busy/NoAnswer exit. If there is no processing attached to the Busy/NoAnswer exit, then this timeout value will not be used. If present, this value must be greater than or equal to zero. If absent or if zero, then a system-configured default timeout will be used.
`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`)

Example Operation

Here is an example SpeedDial operation in JSON representation.

    {
        "id": 5,
        "type": "SpeedDial",
        "base_node": 1,
        "config": {
            "main_announcement": { "set": "General Purpose Anns",
                                   "entry": "Please Enter Speed Dial Code", "repetition": 1 },
            "reprompt_announcement": { "set": "General Purpose Anns",
                                       "entry": "Invalid Input Please Try Again", "repetition": 1 },
            "min_digits": 3,
            "max_digits": 3,
            "end_character": "none",
            "cancel_character": "none"
        },
        "exits": [ 4, 17, 22 ]
    }

If the caller enters a valid Speed Dial, but the associated destination gives Busy/NoAnswer then processing will continue down exit index 0 to operation ID 4.

If the caller cannot provide sufficient digits to form a Speed Dial after three attempts, processing will continue down exit index 1 to operation ID 17.

If the caller provides sufficient digits to form a Speed Dial, but the Speed Dial represented by those digits is not present in the Customer’s Speed Dial list, processing will continue down exit index 2 to operation ID 22.

Exits

There are always exactly three exits for an SpeedDial operation.

Exit Index	Name	Description
`0`	Busy/NoAnswer	[Required] This exit is followed if the caller successfully entered a recognised Speed Dial Code, but the associated destination number gives a Busy/NoAnswer result.
`1`	Insufficient Digits	[Required] This exit is followed if the caller failed to enter an acceptable number of digits for a Speed Dial Code after the maximum number of iterations, and is still connected at the end of the interaction.
`1`	No Match	[Required] This exit is followed if the caller entered an acceptable number of digits for a Speed Dial Code, but the Speed Dial Code is not provisioned in the Customer's profile at the time of call processing.