☰
Navigation :

Speed Dial

Speed Dial

The SpeedDial operation requests the network infrastructure to prompt the caller to enter a “Speed Dial Code”.

If the caller abandons (i.e. hangs up) at any point in the operation, no further processing is performed and no exit is followed.

If the caller does not enter a sufficient number of digits (according to the minimum and maximum configured for the operation instance), the “Insufficient Digits” exit will be selected.

If sufficient digits are entered and the digits do not match one of the Speed Dial Codes in the configured speed dial set, the “No Match” exit will be selected.

Otherwise termination to the Speed Dial Destination associated with the Speed Dial Code will be attempted. If the termination attempt is answered, no further processing is performed and no exit is followed. Otherwise the exit associated with the termination attempt result will be selected.

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.
speed_dial_set_name String [Required] The name of a speed dial set owned by the same customer that owns the service and flow.
max_iterations Integer The maximum number of attempts that the caller may have to enter a Speed Dial Code that is within the bounds of min_digits and max_digits, and matches one of the Speed Dial Codes configured within speed_dial_set.
(Default = 3)
min_digits Integer [Required] The minimum number of digits which may constitute a valid Speed Dial Code.
This value must be <= max_digits.
The Flow Editor requires this value to be in the range of 1-5 inclusive.
max_digits Integer [Required] The maximum number of digits which may constitute a valid Speed Dial Code.
This value must be >= min_digits.
The Flow Editor requires this value to be in the range of 1-5 inclusive.
timeout_seconds Integer The number of seconds that the termination attempt to the Speed Dial Destination should allow for ringing before selecting the no-answer exit if the destination does not answer. If present, this value must be greater than or equal to zero. If absent, a system-configured default timeout will be used.
end_character String Specifies the "End of Input" digit or handling.
If default, the system-default End-of-Input digit will be used.
If none, no End-of-Input digit will be used.
Otherwise the specified telephony digit will be used to indicate end of input.
(Default = default)
cancel_character String Specifies the "Cancel Input" digit or handling.
If default, the system-default Cancel digit will be used.
If none, no Cancel digit will be used.
Otherwise the specified telephony digit will be used to cancel input.
(Default = default)

Example Operation

Here is an example SpeedDial operation in JSON representation.

    {
        "id": 5,
        "type": "SpeedDial",
        "config": {
            "main_announcement": { "customer_name": "Main Customer", "entry": "Please Enter Speed Dial Code" },
            "reprompt_announcement": { "customer_name": "Main Customer", "entry": "Invalid Input Please Try Again" },
            "speed_dial_set_name": "Speed Dials",
            "min_digits": 3,
            "max_digits": 3,
            "end_character": "none",
            "cancel_character": "none"
        },
        "exits": [ 4, 17, 22 ]
    }

In this example:

Exits

This operation may be configured with either 3 or 5 exits.

In the three-exit configuration:

Exit Index Name Description
0 Busy / No Answer / No Such Number [Required] This exit is followed if:
  • A valid Speed Dial Code is entered, and
  • The termination attempt to the Speed Dial Destination results in a Busy or No Such Number response, or the termination attempt is not answered, and
  • The caller is still connected.
1 Insufficient Digits [Required] This exit is followed if:
  • The caller failed to enter a valid Speed Dial Code after the maximum number of iterations, and
  • In the last iteration, the caller entered insufficient digits for a Speed Dial Code, and
  • The caller is still connected.
2 No Match [Required] This exit is followed if:
  • The caller failed to enter a valid Speed Dial Code after the maximum number of iterations, and
  • In the last iteration, the caller entered sufficient digits for a Speed Dial Code but the entered digits did not match a Speed Dial Code in the configured speed dial set, and
  • The caller is still connected.

In the five-exit configuration:

Exit Index Name Description
0 Busy [Required] This exit is followed if:
  • A valid Speed Dial Code is entered, and
  • The termination attempt to the Speed Dial Destination results in a Busy response, and
  • The caller is still connected.
1 Insufficient Digits [Required] This exit is followed if:
  • The caller failed to enter a valid Speed Dial Code after the maximum number of iterations, and
  • In the last iteration, the caller entered insufficient digits for a Speed Dial Code, and
  • The caller is still connected.
2 No Match [Required] This exit is followed if:
  • The caller failed to enter a valid Speed Dial Code after the maximum number of iterations, and
  • In the last iteration, the caller entered sufficient digits for a Speed Dial Code but the entered digits did not match a Speed Dial Code in the configured speed dial set, and
  • The caller is still connected.
3 No Answer [Required] This exit is followed if:
  • A valid Speed Dial Code is entered, and
  • The termination attempt to the Speed Dial Destination is not answered, and
  • The caller is still connected.
4 No Such Number [Required] This exit is followed if:
  • A valid Speed Dial Code is entered, and
  • The termination attempt to the Speed Dial Destination results in a No Such Number response, and
  • The caller is still connected.