Tag : {Digits}
- Digit Tag Summary
- How is the Digits Tag Used?
- Conditions & Restrictions
- Examples of Using the Digits Tag in Cyara Test Cases
- Optional Parameters & Operators for the Digits Tag
Digits Tag Summary
The {Digits} Tag is used to recognise when an IVR is confirming digits such as PIN or telephone numbers. {Digits} Tags are able to recognise any combination of Single-Digit numbers (eg. 1 3 5 9).
Using the {Digits} Tag assists in a more accurate recognition score for that step, as the Cyara Platform will use a specialised set of grammar related to how digits are expressed when performing recognition.
How is the {Digits} Tag used?
The {Digits} Tag is inserted in the Test Case Expect to Hear field to recognise a set of single-digit numbers spoke individually.
In this example above, we expect to hear a phone number spoken as part of step 1. As long as this telephone number does not exceed 20 digits in length, this prompt will return a successful result, independent of the actual numbers spoken.
Conditions & Restrictions
There are a few key points with the {Digits} Tag to be aware of;
- The {Digits} Tag can recognise a maximum sequence of 20 digits.
- The {Digits} Tag can only be used for spoken digits (Digits entered by the customer as DTMF Tones should use the {DTMF} Tag).
- Punctuation characters such as hyphens, dots, and underscores are not recognized; if these are spoken, recognition accuracy will be reduced.
- If a (optional) variable is specified, the stored variable result cannot be used in a subsequent dynamic reply.
Recognition is dependent on the active language of your Cyara Account. You can specify alternative languages for recognition by using the {Language} Tag. Below are examples of digit sets that can be recognised in various languages.
Language | Example |
en-AU | zero one two three four five |
en-AU | one oh five |
en-US | zero one two three four five |
en-US | one oh five |
es-US | dos tres dos uno |
es-US | cinco |
ja-JP | 零一二三四五六七八九 |
nl-NL | drie vier vijf |
Examples of Using the {Digits} Tag in Cyara Test Cases.
The following examples offer different applications of the {Digits} Tag in Cyara Test Cases, and how the Tag can determine a Successful or Failed Test Case Step. Each of these examples contain the "Actual Audio Heard" by Cyara on the call , the Expect To Hear field on the Test Case and the outcome of that step as it is configured.
Scenario 1.
In this scenario we want to build a Test Case step that will listen for spoken digits, and that will return a successful result regardless of what these digits actually are. This is useful if your IVR contains a security verification prompt that is unique per caller (e.g Your call verification code is 1234). The Digits tag enables you to build a single test case step that listens for any set of digits and returns a Successful Outcome.
Actual Audio Heard | Expect to Hear | Step Outcome |
The service department number is 9 8 7 6 5 4 3 2 1 | The service department number is {Digits} | Successful: As long as the spoken telephone number does not exceed 20 digits, this step will return a successful outcome independent of the actual digits spoken. |
Scenario 2.
Now we can build a more complex Test Case Step that includes an Optional Parameter that is available for the {Digits} Tag, the "Length" Parameter. This Parameter changes the {Digits} Tag to listen for a set of digits that is an exact length, or within a set range.
This parameter allows us to build a Test Case that listens for an account PIN number for example, ensuring that it is exactly 4 digits in length without checking what these digits are, see the example below.
Actual Audio Heard | Expect to Hear | Step Outcome |
Your telephone account PIN is 9 8 9 8 | Your telephone account PIN is {Digits Length=4} | Successful: As long as the spoken telephone number does not exceed 20 digits, this step will return a successful outcome independent of the actual digits spoken. |
Scenario 3.
Building on the above example, we want to confirm that a set of spoken digits is within a correct range, and that it matches an expected set of Digits exactly. To achieve this we will use both of the available Length and Variable Parameters on the same {Digits} Tag.
Actual Audio Heard | Expect to Hear | Step Outcome |
Your telephone account PIN is 9 8 9 8 7 | Your telephone account PIN is {Digits Length=4-6 $PIN == 55121} | Failed: In this example, the number of spoken digits was within our range (5 digits were spoken and our set range was from 4-6 digits). This recognition would then set the $PIN Variable to "98987", then run the comparison to the provided "55121". As the supplied pin was not the expected value, this step will fail and return the following detailed result. "Expected PIN to be 55121 but was 98987" |
Optional Parameters & Operators for the Digits Tag.
The {Digits} Tag supports the following additional optional parameters and operators.
Parameter / Operation | Syntax | Range | Description |
Length | {Digits Length=X} | 1-20 | X is the number of digits to Recognize. Note: X can not be greater than 20 |
<$VariableName> | {Digits $VariableName} | n/a |
The {Digits} Tag supports the optional Variable parameter. This variable will be populated with the results of the {Digits} recognition. Using this Variable you can also make comparisons against the Variable, if this comparison fails the step will fail and post a detailed result as follows. |
<$VariableName> EqualTo | {Digits $Variablename == "2"} | n/a | {Digit} Tag variables can also be used to return a successful step outcome, when the recognised digits exactly match a provided value by using the == (EqualTo) Operation. |
<$VariableName> NotEqualTo | {Digits $Variablename != "2"} | n/a | {Digit} Tag variables can also be used to return a Successful Step result for a digit that does NOT match by using the =! (NotEqualTo) operation. |
Comments
0 comments
Please sign in to leave a comment.