Calling Card Interactive Voice Recording (IVR) Application

Last updated by FlySIP SoftSwitch on June 02, 2016 15:01

Configuration options

Basic options

OptionMeaningDefault
Announce BalanceWhether to announce balance upon successful start of applicationYes
Normal Calls Are AllowedOnly service codes enabled if this option is FalseTrue
Disconnect On FailureWhether to drop the Calling Card session upon unsuccessful call attempt. Otherwise the application announces that the failure occurred and offers the user to enter another destination.No
Allow Empty PINWhether to permit to use the prepaid card accounts with empty PINTrue
Preserve Original CLICLI from the initial call leg will be used to call destination if this option set to true. The calling card username will be used as CLI otherwise.False
Maximum Call DurationMaximum call duration3600 seconds
Card Number LengthMaximum number of digits allowed in a card number10
Number_Of_Attempts_To_Enter_A_CardMaximum number of attempts to enter card number or PIN code3
Number Of Wrong DestinationsMaximum allowed number of unsuccessful call attempts in a row3
Number Of TimeoutsMaximum number of input timeouts3
Minimum Call DurationMinimum allowed call duration (in seconds). If calculated maximum duration of the call to the requested destination is less than this value then the user will hear the prompt "You have insufficient funds to make this call"10
Minimum Card Number LengthMinimum number of digits allowed in a card number
No Seconds In DurationDo not pronounce seconds while announcing call duration. If the duration is less than 1 minute then this option is ignored.False
No Hours In DurationDo not speak out hours while announcing call duration, only minutesFalse
Announce DurationShould the duration of the call be announcedTrue
Call Several DestinationsOnly one call attempt per session is allowed if this option is FalseTrue
Outbound SIP ProxySIP proxy host:port to send the outbound calls to (this option can also be set from the command line)<Environment_IP>:5061
Disconnect Warning TimeSay 'Your call will be disconnected in N seconds' before the call disconnect60
Play Service Plan Minutes OnlyPlay service plan minutes instead of a sum of plan minutes and duration calculated by tariff. This option does not affect actual maximum duration of a call which is a sum of plan minutes and duration calculated by tariff.False
Destination Number Completion RegexTreat the destination number to have been completed and immediately continue with the call when the input matches the given regular expression pattern
Allow Own Accounts OnlyUsage of Calling Card application in scope of one customer who owns this application. The option is not restricted to Calling Card application only, it is applicable to every IVR application.
(Available from 4.4 only).
False

Trusted CLI related options

OptionMeaningDefault
Enable CLI RegistrationIf the CLI Registration subapplication enabledTrue
Automatic CLI RegistrationAfter calling card has been entered successfully, add the current CLI to the list of trusted CLIs for this calling card.No
Silent Automatic CLI RegistrationWhen this option is set to False the user will be prompted if he wishes to register his phone number (new in 1.7.1).True
CLI Registration Menu Extension NumberExtension number for the CLI Registration Subapplication
Trusted CLI AuthenticationCLI mapping is trusted so the PIN is never askedFalse
Minimum Valid CLI LengthMinimum CLI length that is allowed to trigger the Automatic CLI Registration.6

Password change

OptionMeaningDefault
Enable Password ChangeIf password change enabledTrue
Change Password Menu Extension NumberExtension number for the Change Password Subapplication

Billing related options

OptionMeaningDefault
Balance ThresholdIf the balance of the card is below this threshold then the card number will be asked even if CLI authentication is successful. Please note that this option doesn't disable cards with the balance below threshold, it just forces the PIN to be entered despite the fact the CLI authentication was successful. If you want to disable cards with low balance, please use the Minimum Balance option. (new in 1.8)The value of the Minimum Balanceoption
Minimum BalanceIf the balance of the card becomes less than the specified value then the card becomes unavailable. The balance can be specified with or without currency. Currency may follow the balance value, ex: '2 USD'. When no currency specified then the balance checked as an absolute value regardless of card's currency (updated in 1.7.1)NULL
Ignore Connect FeeDo not use connect_fee in the duration calculationsFalse
Say_Negative_Balance_As_ZeroWhen option is and if balance is under zero then say "You have zero dollars". Say "You have minus <amount> dollars" if this option disabled.True

Authentication

OptionMeaningDefault
Use CLI Authentication OnlyOnly accounts with existing CLI mapping are allowed to enterFalse
CLI As Card NumberTry to use CLI as card number first before other methodsFalse
Use VoIP Login As Card NumberLook for a calling card in the accounts table by the authname field (normally the username field is used).False

Custom scripts

OptionMeaningDefault
Custom Script To Check DestinationSet the path to the destination check script
Custom Script To Change Announced DurationScript to calculate custom duration to be announced to the user.

Hot Dial & Smart Dial

OptionMeaningDefault
Enable Direct Hot DialSingle digit destinations dialed from main menu will be treated as hot dial keys if this option is trueFalse
Enable Hot DialIf the Hot Dial sub application enabledTrue
Hot Dial Edit Menu ExtensionExtension number to edit the Hot Dial keys
Hot Dial Menu ExtensionHot Dial extension number
Limit Hot KeysIf true then only keys 1, 2 and 3 can act as the hot dial keysFalse
Smart Dial Exclusive ModeShould the Smart Dial DID be shared amongst many accounts.False

Top-Up

OptionMeaningDefault
Enable Top-Up featureIf the Topup sub application enabledTrue
Top-Up Card LengthThe maximum allowed number of digits of top-up card10
Top Up Menu ExtensionExtension number for Top-Up Card Sub application

Black List

Please note that attempts to enter numbers less than 4 digits long are not treated as fraud activity. Only numbers more than 3 digits long trigger black list.
OptionMeaningDefault
Enable Black ListIf the blacklist feature turned on.False
Number Of Attempts To BlacklistHow many wrong calling card numbers should be entered in a row to blacklist the current CLI.3

Miscellaneous

OptionMeaningDefault
Use Word PINUse word PIN in all phrases regarding card number. So for example phrase "Enter card number" will sound "Enter PIN code"and so on... Please note that this option disables the password check.False
Suppress Pound PhraseDo not say "...followed by the pound key" when asking destination number and PINFalse
Enable Custom GreetingIf the custom language independent greeting enabled (it is played at the very beginning of the application before the language selection)No
Custom Greeting FilePath to the custom language independent greeting audio file (it is played at the very beginning of the application before the language selection)
Early Greeting Prompt IDThe Prompt ID to be played before the language selection menu. This prompt cannot be localized. See an example at the end of the page.
Late Greeting Prompt IDThe Prompt ID to be played after the language selection menu before balance announcement. This prompt can be localized. See an example at the end of the page.
VoodooVox Source KeyThe source key for VoodooVox AdsNone
Default Calling Card LanguageDefault fall back languageen
Fallback_To_Default_Calling_Card_LanguageWhether to fall back to default language after the maximum number of wrong attempts to select the language have been made.No
Say 'No Card' On Low BalanceSay Wrong card number (PIN code) instead of There is no available balance left in this calling card. (New in 3.0)True