Playback applications
- Product Knowledge
On this page |
|
What’s about
This group contains blocks related to audio playback actions.
Playback
Using this block, you can play an audio file without any interaction between the customer and the application. Please note that the audio file cannot be stopped.
Label: here you can type a brief description
Audio: select the audio file you would like to play
Exit Arrows
This block provides just one arrow out to the next step
Menu
This is one of the most important application blocks available on Cally Square. Here, you can create a complex menu by configuring just a few simple steps: play a message, track retry attempts on errors (to prevent endless loops), and store the digit(s) pressed by the customer in a variable.
Please consider the Menu block gives the top priority to the invalid (i) or timeout (t) branches (if present) before routing the call in a loop. # key can be used as an escape digit or as a valid exit key.
If the user doesn't press any keys when the message plays, there is $timeout milliseconds of silence then the command ends.
The user has the opportunity to press a key at any time during the message or the post-message silence. If the user presses a key while the message is playing, the message stops playing. When the first key is pressed a timer starts counting for $timeout milliseconds. Every time the user presses another key the timer is restarted. The command ends when the counter goes to zero or the maximum number of digits is entered, whichever happens first.
Label: here you can type a brief description
Audio: select the audio file you would like to play
Response Timeout: the maximum number of seconds the system waits before considering the customer not interacting with the application
Max Digit: the maximum number of digits the system waits before moving on to the next step
Retries: here you can set the number of loops automatically performed in case of digits not valid or timeout
Variable: select the variable you would like to fill with the digits pressed by the customer.
Exit Arrows
The menu block lets you draw many exit arrows according to the following syntax:
N: where N is a digit between 0 and 9. The block waits for one digit if the MaxDigit parameter is set to one
N,N: where N is a digit between 0 and 9. The block uses this exit for every digit specified in the exit arrow (eg. 1,2 )
NN: where N is a digit between 0 and 9. If MaxDigit is set to 2, the block waits for a number between 00 and 99
i: the system takes this path if the entry selected is invalid
t: the system takes this path if the box goes in case of timeout
-: the system considers this branch when the retry value is reached. Timeout and Invalid branches have higher priority than this branch.
It is possible to add multiple choices for each output branch: use just the comma separated characters.
Say Digits
Using this block you can play the digits, one by one, in the chosen language (default: English)
You can change the language as described below:
add the Set block for channel Language variable before the Say Digits block. In this way you set the language for the specified channel, so that when Asterisk encounters a file playback, it searches for the corresponding folder in the selected language.
be sure to have the language files on folder
/var/lib/asterisk/sounds
Label: here you can type a brief description
Digits: the digits you would like to be played: they can be both a digit string (i.e. 1234) or a VARIABLE (i.e. {CALLERID(num)})
Escape digits: special character to exit from the audio playing (i.e. #)
Exit Arrows
This block provides just one arrow out to the next step
Say Number
Using this block, you can play a number (for example, 2583 will be played as "two thousand, five hundred and eighty-three").
Label: here you can type a brief description
Number: the number you would like to be played, that can be a digit string (i.e. 1234) or a VARIABLE (i.e. {CALLERID(num)})
Escape digits: special character to exit from the audio playing (i.e. #)
Exit Arrows
This block provides just one arrow out to the next step
Say Phonetics
This block allows you play each Asterisk sound file located in /var/lib/asterisk/sounds/phonetic/character_p.gsm for each character in input using the NATO Phonetic Alphabet.
Label: here you can type a brief description
Text: the text you would like to be played: it can be both a digit string (i.e. Joe) or a VARIABLE (i.e. {CALLERID(name)})
Escape digits: special character to exit from the playing (i.e. #)
Exit Arrows
This block provides just one arrow out to the next step
Get Digits
Using this block, you can prompt the user to enter a series of digits. You can play a message, track retry attempts on errors (to prevent infinite loops), and store the entered digits in a variable.
Please consider that the Get Digits block gives the top priority to the invalid (i) branch (if present) before routing the call in a loop.
Pressing the # key has the same effect as the timer running out: the command ends and any previously keyed digits are returned. A side effect of this is that there is no way to read a # key using this command.
If you don't specify $max_digits then the user can enter as many digits as they want.
If the user doesn't press any keys when the message plays, there is $timeout milliseconds of silence then the command ends.
The user has the opportunity to press a key at any time during the message or the post-message silence. If the user presses a key while the message is playing, the message stops playing. When the first key is pressed a timer starts counting for $timeout milliseconds. Every time the user presses another key the timer is reset. The command ends when the counter goes to zero or the maximum number of digits is entered, whichever happens first.
Label: here you can type a brief description
Audio: select the audio file you would to play
Response Timeout: the maximum number of seconds the system waits before considering the customer not interacting with the application
Min Digit: the minimum number of digits the system can accept without considering it an invalid entry
Max Digit: the maximum number of digits the system waits before moving on to the next step
Retry: here you can set the number of loops automatically performed in case of invalid digits
Variable: the variable you want to fill with the digits pressed by the customer.
Exit Arrows
The Get Digits block lets you draw many exit arrows according to the following syntax:
x: is the exit arrow, the path taken when a valid digit is inserted. If not present, on valid entry the call will be dropped.
i: the system takes this path if the entry is invalid. If not present it will simply loop the getdigits box until it runs out of retries.
-: the system takes this path if it runs out of retries. If not present, when the system runs out of retries will simply drop the call.
Get Secret Digits
The Get Secret Digits block allows the user to enter a series of digits, with some of them hidden for security purposes. You can play a message, specify how many digits to hide, track retry attempts on errors (to prevent infinite loops), and store the entered digits in a variable.
Please consider that the Get Secret Digits block gives the top priority to the invalid (i) branch (if present) before routing the call in a loop.
Pressing the # key has the same effect as the timer running out: the command ends and any previously keyed digits are returned. A side effect of this is that there is no way to read a # key using this command.
If you don't specify $max_digits then the user can enter as many digits as they want.
If the user doesn't press any keys when the message plays, there is $timeout milliseconds of silence then the command ends.
The user has the opportunity to press a key at any time during the message or the post-message silence. If the user presses a key while the message is playing, the message stops playing. When the first key is pressed a timer starts counting for $timeout milliseconds. Every time the user presses another key the timer is reset. The command ends when the counter goes to zero or the maximum number of digits is entered, whichever happens first.
Label: here you can type a brief description
Audio: select the audio file you would like to play
Response Timeout: the maximum number of seconds the system waits before considering the customer not interacting with the application
Min Digit: the minimum number of digits the system can accept without considering it an invalid entry
Max Digit: the maximum number of digits the system waits before moving on to the next step
Retry: here you can set the number of loops automatically performed in case of invalid digits
Hidden Digits Number: the number of digits that the system will hide, for security reasons
Hidden Digits Position: you can set if the First or Last #N digits will be hidden
Variable: the variable you would like to fill with the digits pressed by the customer.
Exit Arrows
The Get Secret Digits block lets you draw many exit arrows according to the following syntax:
x: is the exit arrow, the path taken when a valid digit is inserted. If not present, on valid entry the call will be dropped.
i: the system takes this path if the entry is invalid. If not present it will simply loop the getsecretdigits box until it runs out of retries.
-: the system takes this path if it runs out of retries. If not present, when the system runs out of retries will simply drop the call
Send DTMF
This block allows interaction with the system by sending DTMF (Dual-Tone Multi-Frequency) tones enabling users to provide input using the telephone keypad during a phone call.
So caller can select for example menu option, enter numbers or provide answers through the use of DTMF tones transmitted during the call.
DTMF Tones to play: list of digits accepted 0-9, *#, a-d, A-D, w (for a half-second pause), W (for a second pause) , f (for a flash-hook, if the channel supports it). Max 30 digits.
Timeout between tones: amount of time to wait between tones. Expressed in milliseconds (max 60000)
Tone duration: duration of each digit, expressed in millseconds (max 60000)
Exit arrows
This box presents one exit arrow