Table Of Contents
Prepaid Distributed Calling Card via Packet Telephony
Related Features and Technologies
Configuring the Inbound POTS Dial Peer
Verifying the Debit Card Configuration
Debit Card Feature Configuration Example
call application voice application_name location
call application voice app_name param-name param-value
call application voice app-name set-location
Related Commands
ivr autoload
Loads the files from TFTP to memory.
show call prompt-mem-usage
Displays the memory size use by prompts.
Prepaid Distributed Calling Card via Packet Telephony
This feature is also known as "Debit Card for Packet Telephony on Cisco Access Platforms."
Feature History
The Debit Card feature gives service providers the ability to offer calling service with the use of debit accounting. This feature was first introduced in Cisco IOS Release 12.0(4)XH. The following enhancements have been added to Cisco IOS Release 12.0(7)T:
•
Support for the Spanish language
•
•
This document includes the following sections:
•
Feature Overview
The Debit Card for Packet Telephony on Cisco Access Platforms is an application supported by the Cisco Interactive Voice Response (IVR) feature. The IVR voice scripts have been modified to use Tool Command Language (TCL) scripts.
Note
http://www.cisco.com/univercd/cc/td/doc/product/access/acs_serv/5300/cfios/cfselfea/0061ivr.htmThe feature components consist of IVR functionality in Cisco IOS software that work in conjunction with an integrated third-party billing system. The Debit Card feature includes the ability to maintain per-user credit balance information through the use of a billing system. When these features are implemented, the billing system and IOS software functions enable a carrier to authorize voice calls and debit individual user accounts in real time at the edges of a voice-over-IP network, without requiring external service nodes. This feature uses vendor specific attributes (VSAs) to communicate with the billing system.
A general, the Interactive Voice Response software infrastructure allows pre-recorded audio files to be combined dynamically to play the dollar amount of credit remaining, the time and date, and other information. The dynamic creation of the audio files (by combining prerecorded audio pieces) is limited to audio files playing out dollar, time, and day information.
We recommend that you contact your Cisco marketing or sales representative to help determine which RADIUS server vendor best meets your needs. Also, refer to the marketing data sheet titled "Debit Card Application for Cisco Packet Telephony" that describes the Debit Card feature and provides a list of the specific features supported by RADIUS server vendors.
TCL Scripts
The Cisco Debit Card for Packet Telephony feature works in tandem with the Cisco Interactive Voice Response (IVR) feature modified with TCL scripts to provide voice prompts. These voice prompts are required to collect the necessary digits for accounting and settlement processes.
Before Cisco IOS Release 12.0(7)T and the introduction of IVR TCL scripts, IVR scripts were written in C programming language and compiled with the Cisco IOS software. This approach tied the IVR application to the Cisco IOS software and also constrained releases of updated IVR scripts due to the Cisco IOS Release cycle.
Objects or commands written in C language that can be grouped together by the TCL script. When the script is activated by the incoming call, it activates the C codes in run-time mode and performs the work of these commands.
Note
http://www.cisco.com/univercd/cc/td/doc/product/access/acs_serv/5300/cfios/cfselfea/0061ivr.htmThe TCL scripts required for the Debit Card feature need to be downloaded from the Cisco CCO Software Center, located at the following URL:
http://www.cisco.com/cgi-bin/tablebuild.pl/tclware
•
•
TCL Script Summaries
The TCL IVR scripts that are supported by the Debit Card feature in Cisco IOS Release 12.0(7)T are described in summary as follows:
Two new TCL scripts have been developed for Cisco IOS Release 12.0(7)T:
•
•
Debit Card Features
Note
New feature functionality includes:
•
The call is authenticated using caller ID and PIN. The RADIUS server provides user credit (dollar) amount. The caller is then prompted to enter the destination number. The TCL script authorizes the call with the RADIUS server. The RADIUS server is expected to keep track of the caller's credit information, and it communicates with other billing servers, if necessary, to maintain or furnish user credit information.
An enhancement was added to Cisco IOS Release 12.0(7)T to allow two separate prompts for requesting the caller account number and password.
•
The RADIUS server is expected to maintain the credit information and furnish it to the script at the time of authentication. The TCL script plays a prompt that announces the remaining credit to the caller as dollars and cents. This is achieved by prerecording the words `one', `two', and so on, and then combining these recordings to form the final prompt. The format and resolution is $$$$$$.$$. The design is flexible enough to play any amount up to a maximum of 999999.99. For example, "You have one-thousand, three-hundred forty-five dollars and seventeen cents" is played.
•
The RADIUS server provides the credit (time) remaining to the script during authorization. The TCL script combines prerecorded audio files to form the final prompt and play the `time-remaining' to the caller. The time credit amount returned by the RADIUS server is expected to have taken into consideration the `rating' and time boundary overlaps. The prompt played to the caller is, for example, "You have five hours and thirty-five minutes." The design is flexible enough to play any amount of time up to a maximum time specified in the script.
If the time credit remaining is less than the configurable "time-out" value, the prompt played for example, "You only have two minutes remaining on your credit."
•
The RADIUS server maintains and furnishes time credit information during the authorization. The TCL script monitors the time remaining and, based on the configured value, plays a `time-has-run-out' message to the caller. The called party hears silence during this time. For example, if the timeout value is configured for three minutes, the prompt, "You only have three minutes remaining on your credit" is played.
•
This message is played to the calling party by the TCL script when the time credit has run out. The called party hears silence. The message is, for example, `Sorry, you have run out of credit.'
•
This feature makes it possible for the caller to make subsequent calls to different destinations without disconnecting from the call leg. Thus, the caller is required to enter the account ID number and PIN only once during initial authorization. To make subsequent calls, the caller needs to enter only the destination number. After talking with one destination, the caller is allowed to disconnect the call by pressing the pound (#) key on the keypad and holding it down for one to two seconds. If the # key is pressed down for more than one second it is treated as long pound (#). The called party is disconnected and an announcement is played to the caller, giving the new time, and prompting for a new destination number.
This feature also allows the caller to make additional calls if the called party hangs up.
•
Every time a caller enters a new destination number, the TCL script reauthorizes the call with the RADIUS server and obtains the remaining time and credit balance information. The TCL script then announces the amount of time remaining to the calling party.
•
The normal terminating character for the caller ID, PIN, and destination number is the # key. The caller may want to continue without waiting to hear the prompts. This TCL script will stop playing or will not start a prompt when it discovers that the caller wants to type ahead.
•
This TCL script stops playing announcements when the system determines that the caller has pressed any touch tone key.
•
The caller is allowed to interrupt partially entered numbers and restart from the beginning by pressing asterisk (*) key on the keypad. The asterisk key is configured in the TCL script. The caller can use the asterisk key to cancel an entry and reenter the user-ID/PIN/destination number. The caller is allowed to reenter data only a certain number of times. The number of retries is configurable; the default is three.
•
The TCL script can be used to specify a number of digits in the user ID and PIN fields. This means that the caller can type all of the digits (without the terminating character) and the script determines how to extract different fields from the number strings. If the caller uses the terminating character (the pound key), the terminating character takes precedence and the fields are extracted accordingly.
•
The language is selected when the caller presses a predefined key. For example, `For English press one. For Mandarin press two.' The TCL script uses the selected language until the caller disconnects, the caller is asked only once, at the beginning of the session, for the language of choice.
Support for the Spanish language is introduced with Cisco IOS Release 12.0(7)T.
The ivr autoload Cisco IOS command is used during configuration to determine which set of audio files to load when the gateway server boots up.
•
The RADIUS server is expected to maintain information regarding off-net calls. During authorization, it provides this information to the TCL script. Based on the collected information, the TCL script has the ability to generate a prerecorded message or tone to the calling party.
•
Cisco vendor specific attributes (VSAs), which before this release were overloaded into the Session ID field of the AAA application.
•
A new field has been added to the Stop Record field. The data for this field is obtained from fields that maintain and tune voice quality. It is up to the user application on the RADIUS server to use this information and give credit to the caller if the call has unsatisfactory voice quality.
•
When voice prompts are not used for a period of time, they are swapped out of RAM. The swapping does not introduce undue delays in playing prompts. The most frequently used prompts remain in memory and are not swapped.
•
A general infrastructure is provided that allows combining prerecorded audio files to play the dollar amount, time, and day. An interface for the scripts to use this infrastructure is also part of this feature. Dynamic creation of the final audio (by combining prerecorded audio files) is limited to playing out dollar amount, time, and day information. For example, when the system receives a credit balance of $15.50, it combines the prerecorded audio files, "You have" "fifteen" "dollars" "and" "fifty" "cents" to make up this message.
•
If errors that are returned by the RADIUS server during authentication or authorization (use of the AAA application), the caller is allowed to retry the entry. The RADIUS server determines how many retries to allow. The caller is disconnected when the number of retries has exceeded the limit.
•
VSA Fields
VSAs are collected by the RADIUS server during the accounting process when AAA is configured with the Debit Card feature. (See "Configuring AAA" on page 22.) Data items are collected for each call leg created on the gateway. A call leg is the internal representation of a connection on the gateway. Each call made through the gateway consists of two call legs: incoming and outgoing. The call leg information emitted by the gateways can be correlated by the connection ID, which is the same for all call legs of a connection.
Use the H.323 VSA method of accounting when configuring the AAA application. (See the command "gw-accounting" on page 37.)
There are two modes:
•
Use the gw-accounting h323 syslog command to configure this mode.•
Use the gw-accounting h323 vsa command to configure this mode.Overloaded Session-ID Fields
The voice specific accounting information is coded into the 'session-id' field of the RADIUS record. Each field is encoded as an ASCII string. The fields are separated by a /. For additional information about the overloaded session ID refer Service Provider Features for Voice over IP. (See "Related Documents" on page 19.) shows the VSA fields and a brief description of each.
Table 1 VSA Attributes in Overloaded Session ID
session id
The standard RADIUS account session ID.
setup time
The Q.931 setup time for this connection in NTP format.
gateway id
The name of the underlying gateway in the form of
"gateway.domain_name".call origin
Origin of the call relative to the gateway. Possible values are originate and answer.
call type
Indicates call leg type. Possible values are telephony and VoIP.
connection id
A unique global identifier used to correlate call legs that belong to the same end-to end call. The field consists of 4 long words (128 bits). Each long word is displayed as a hexadecimal value and separated by a space character.
connect time
The Q.931 connect time for this call leg, in NTP format.
disconnect time
The Q.931 disconnect time for this call leg, in NTP format.
disconnect cause
Documented in the Q.931 specification. Can be in the range of 1 to 160.
remote IP address1
Address of the remote gateway port where the call is connected.
1 Support for the remote IP address field was introduced with Cisco IOS Release 11.3(7)NA.
VSA Fields
The voice specific accounting information is coded as separate VSAs. Each attribute is encoded as 'Cisco-AV-pair' which has the format attribute = value. The value is encoded as an ASCII string.
The VSA fields and their ASCII values listed in .
Table 2 VSA Fields and Their ASCII Values
Debit Card Call Flow
A high-level call flow sequence is displayed in through "". The actual call flow varies, depending on the parameters passed to the application and also on the features that are available on the RADIUS server billing system that is being used.
The call sequence flow charts below graphically depict the different states in the Debit Card application. The different states are represented by the double bars in the boxes and show the flow from one state to the next.
Figure 1
Debit Card Call Sequence
Figure 2
Figure 3
Figure 4
Figure 5
Audio File Prompts
Cisco provides a set of professionally recorded English (U.S.) and Mandarin audio prompts to allow easier immediate integration and use of the Debit Card feature. The prompts are stored on the FTP server in the audio file format (.au.) To announce the credit available to the caller, the system concatenates a series of prompts to create the appropriate message.
The Cisco provided audio files are zipped and stored on CCO in the URL for the Software Support Center. The audio files need to be downloaded to either a TFTP server or into Flash memory. When the system runs, these files are copied into memory.
Note
http://www.cisco.com/cgi-bin/tablebuild.pl/tclwareBecause there are a large number of prompts, and to ensure efficient use of system memory resources, all prompts are downloaded to a TFTP server. A basic set of audio files is downloaded to the system when it is initialized. The system removes less-frequently-used prompts from memory to conserve memory: when the prompt is needed, the system fetches the prompt from the TFTP server.
For languages that are syntactically similar to English, the audio file can be recorded and saved as the same filename to allow the system to construct the message properly. (See Audio File Naming Convention.) It is not mandatory to use the prompt set that Cisco provides. If the customer has access to a recording studio, prompts can be created or customized, as long as they are saved in the proper format.
Cisco Provided Audio Files
The following audio file prompts are provided by Cisco. A similar set is available in Mandarin. Not all of the audio file sets are used by Cisco IOS Release 12.0(7)T. Some are reserved for future use.
Support for the Spanish language is added to Cisco IOS Release 12.0(7)T. A similar set of professionally recorded audio files is available on CCO. The audio files provided are listed in and .
Additional Miscellaneous Prompts:
•
"Welcome to Cisco Debit Card Demo".
•
"Please press 1 for English, 2 for Mandarin."
•
"You have made an invalid selection. Please press 1 for English or press 2 for Mandarin."
•
"You did not select any language. Press 1 for English or press 2 for Mandarin."
•
"We are having difficulties connecting your call. Please try again later."
•
"Please hang up and try again."
•
"Please enter card number followed by pound."
•
"You have entered an invalid number of digits. Please re-enter your card number followed by pound."
•
"You have entered an invalid card number. Please re-enter your card number followed by pound."
•
"You did not enter any digits. Please enter card number followed by pound."
•
"We are having technical difficulties. Please call back later."
•
"You have zero balance. Please call the operator or hang up."
•
"Please enter destination number."
•
"Your call will be disconnected."
•
"You have been disconnected."
•
"Sorry, the number you have dialed is blocked. If you feel you have reached a number in error, please call the customer service number."
•
"You have more than one million."
•
"The party you called is busy, please enter a new number or hang up and try again later."
•
"Please enter your account number followed by the pound key."
•
"We did not get any input, please enter your account number followed by the pound key."
•
"You have entered an invalid number of digits. Please enter your account number followed by the pound key."
•
"You have entered an invalid account number. Please enter your account number followed by the pound key."
•
"Please enter your PIN number followed by the pound key."
•
"We did not get any input, please enter your pin number followed by the pound key."
•
"You have entered an invalid number of digits. Please enter your PIN number followed by the pound key."
•
"You have entered an invalid PIN. Please enter your pin number followed by the pound key."
•
"We are sorry, your card has expired."
•
"This account is currently in use."
•
"We did not get any input. Please enter the destination number you are calling."
•
"You have entered an invalid number of digits. Please enter your PIN number followed by the pound key."
•
"You have entered an invalid PIN. Please enter your PIN number followedby the pound key."
•
"We are sorry, your card has expired."
•
"This account is currently in use."
•
"We did not get any input. Please enter the destination number you are calling."
•
"You have entered an invalid destination. Please re-enter the destination number you are calling."
•
"You will be connected to Customer Service."
•
"Please hang up and dial the calling card customer service number."
•
"We are sorry, this service is not available."
•
"We are sorry, the destination you have called is unreachable."
•
"You can only make toll-free calls."
Audio File Naming Convention
If you record your own audio files, you must name them using the convention described in for the TCL scripts to identify which audio file to use. The TCL scripts are designed to work with designated audio file names.
For example, when the Debit Card audio file for the caller to choose a language (en_lang_select.au) is played, ("Please press # 1 for English and # 2 for Mandarin"), if Mandarin is selected by the caller, then the TCL script calls the <ch> audio files to interact with the system.
Continuing with this example, when configuring the voice platform to process Mandarin audio files, use the call application voice command, with the language and set-location key words. When specifying the set-location parameter, the correct <language> <ch> specifier needs to be configured to interact with the TCL script. Therefore, when naming your audio files, make sure you include the language identifier for each file.
Table 5
Example Audio File Naming Convention
Note
Creating Audio Index Files
If you record your own audio files, you must also create an index file that contains a list of the audio files in URL format. An index file needs to be created for each audio file that needs to be downloaded from TFTP to memory. Use the ivr autoload command to download the audio files into Flash memory. See"Command Reference" on page 29 for additional command description and instructions for downloading using the index parameter.
When creating your audio file index, keep in mind that the filename and extension (au) are is actually the file's URL. Follow these recommendations:
•
•
•
•
•
Sample Index File
The following is a sample index file:
# tftp://jurai/tclware/au/en/auth_fail_final.au# tftp://jurai/tclware/au/en/auth_fail_retry.au# tftp://jurai/tclware/au/en/auth_fail_retry_number.au# tftp://jurai/tclware/au/en/auth_failed.au# tftp://jurai/tclware/au/en/ch_generic_final.au# tftp://jurai/tclware/au/en/ch_lang_sel1.auBenefits
•
•
Restrictions
The maximum call length is 18 hours. When a caller uses the Debit Card application, a call is disconnected after 18 hours, even if the caller has a dollar amount balance remaining. This limitation is due to the timing implementation in the software.
Related Features and Technologies
•
•
•
Related Documents
For related information on this feature, see the following documents:
•
•
•
•
Supported Platforms
This feature is supported on the following platforms:
•
•
•
•
Determining Platform Support Through Cisco Feature Navigator
Cisco IOS software is packaged in feature sets that support specific platforms. To get updated information regarding platform support for this feature, access Cisco Feature Navigator. Cisco Feature Navigator dynamically updates the list of supported platforms as new platform support is added for the feature.
Cisco Feature Navigator is a web-based tool that enables you to determine which Cisco IOS software images support a specific set of features and which features are supported in a specific Cisco IOS image. You can search by feature or release. Under the release section, you can compare releases side by side to display both the features unique to each software release and the features in common.
To access Cisco Feature Navigator, you must have an account on Cisco.com. If you have forgotten or lost your account information, send a blank e-mail to cco-locksmith@cisco.com. An automatic check will verify that your e-mail address is registered with Cisco.com. If the check is successful, account details with a new random password will be e-mailed to you. Qualified users can establish an account on Cisco.com by following the directions at http://www.cisco.com/register.
Cisco Feature Navigator is updated regularly when major Cisco IOS software releases and technology releases occur. For the most current information, go to the Cisco Feature Navigator home page at the following URL:
Availability of Cisco IOS Software Images
Platform support for particular Cisco IOS software releases is dependent on the availability of the software images for those platforms. Software images for some platforms may be deferred, delayed, or changed without prior notice. For updated information about platform support and availability of software images for each Cisco IOS software release, refer to the online release notes or, if supported, Cisco Feature Navigator.
Supported MIBs and RFCs
•
•
•
•
Prerequisites
Before you can configure your access server platform (Cisco AS5300, Cisco 3600, or other supported voice platform) with the Debit Card feature, complete the following activities:
•
•
•
•
Note
•
•
•
http://www.cisco.com/cgi-bin/tablebuild.pl/tclware
•
•
Configuration Tasks
Before starting the software configuration tasks for the Debit Card feature, complete the following preinstallation tasks:
•
•
Note
•
Use the call application voice app_name set-location command to create the application. Enter any name that is significant to how you use the feature and then enter the location where the TCL scripts are located. (See the "call application voice application_name location" section.
•
Note
When these tasks have been completed, you can begin the software configuration to configure the Cisco platform to perform Debit Card Calling services.
•
•
Configuring the Inbound POTS Dial Peer
To configure the inbound POTS dial peer, use the following commands:
Configuring AAA
The Cisco IOS software AAA accounting user interface can be configured to use the H.323 method as follows:
The authentication command line creates a method list named H.323 with RADIUS being its only member.
Also note that the accounting command line looks like a regular RADIUS accounting command line for connection accounting. Connection accounting has to be globally enabled using this command line. Start-stop or stop only methods may be used.
Note
Tips
•
•
Verifying the Debit Card Configuration
Execute the show call application voice summary command to verify that the newly created application is listed.
Router #show call app voice summname descriptionsession Basic app to do DID, or supply dialtone.fax_hop_on Script to talk to a fax redialerclid_authen Authenticate with (ani, dnis)clid_authen_collect Authenticate with (ani, dnis), collect if that failsclid_authen_npw Authenticate with (ani, NULL)clid_authen_col_npw Authenticate with (ani, NULL), collect if that failsclid_col_npw_3 Authenticate with (ani, NULL), and 3 tries collectingclid_col_npw_npw Authenticate with (ani, NULL) and 3 tries without pwprepaid tftp://keyer/debitcard.tclRouter #Next, execute the show dial-peer voice <peer tag> command and verify that the application associated with the dial-peer is correct.
Router #show dial-peer voice 30001VoiceEncapPeer30001information type = voice,tag = 30001, destination-pattern = `300..',answer-address = `', preference=0,group = 30001, Admin state is up, Operation state is up,incoming called-number = `', connections/maximum = 0/unlimited,application associated:prepaidtype = pots, prefix = `300',session-target = `', voice-port = `2:D',direct-inward-dial = disabled,register E.164 number with GK = TRUEConnect Time = 0, Charged Units = 0,Successful Calls = 0, Failed Calls = 20,Accepted Calls = 20, Refused Calls = 0,Last Disconnect Cause is "4F ",Last Disconnect Text is "service not implemented",Last Setup Time = 24591Router #Debit Card Feature Configuration Example
Router # show running configurationBuilding configuration...Current configuration:!version 12.0service timestamps debug datetime msec localtimeservice timestamps log datetime msec localtimeno service password-encryptionservice internal!hostname Router name!no logging buffered! AAA configuration!--------------------------------------aaa new-modelaaa authentication login h323 group radiusaaa authorization exec h323 group radiusaaa accounting connection h323 start-stop group radius!------------------------------------!enable secret 5 $1$rLpz$DpgRh8qfaDqCPteN4/KXD0enable password xxx!username Router password 0 xyxyxyusername s!!resource-pool disable!!!!!!ip subnet-zerono ip domain-lookup! TFTP address configuration!----------------------------------ip host keyer 223.255.254.254! prepaid application creation!-----------------------------------call application voice prepaid tftp://keyer/debitcard.tcl! passing parameters to prepaid application!----------------------------------call application voice prepaid uid-len 4call application voice prepaid language 1 encall application voice prepaid language 2 chcall application voice prepaid set-location en 0 tftp://keyer/mta receive maximum-recipients 1024!dial-control-mib max-size 300!controller T1 0shutdownframing esflinecode b8zscablelength short 133!controller T1 1shutdownframing esflinecode b8zscablelength short 133!controller T1 2framing esfclock source line primarylinecode b8zscablelength short 133pri-group timeslots 1-24!controller T1 3framing esfclock source line secondary 1linecode b8zscablelength short 133pri-group timeslots 1-24!!voice-port 2:Dtimeouts call-disconnect 0!voice-port 3:Dtimeouts call-disconnect 0! configuring voip gw accounting!-------------------------------gw-accounting h323 vsa! associating application to dial-peer!------------------------------------dial-peer voice 30001 potsapplication prepaiddestination-pattern 300..port 2:Dprefix 300!dial-peer voice 40001 potsdestination-pattern 400..direct-inward-dialport 3:Dprefix 400!dial-peer voice 50001 voipdestination-pattern 500..session target ipv4:147.14.25.1!dial-peer voice 60001 voipdestination-pattern 600..session target ipv4:147.14.25.1!process-max-time 200!interface Ethernet0description ip address 132.132.1.2 255.255.255.0ip address 1.13.103.1 255.255.255.0no ip directed-broadcastno ip route-cacheno ip mroute-cacheload-interval 30no keepaliveno cdp enable!interface Serial2:23description D-Channel - To Abacusno ip addressno ip directed-broadcastisdn switch-type primary-5essisdn protocol-emulate userisdn incoming-voice modemfair-queue 64 256 0no cdp enable!interface Serial3:23description D-Channel - To Abacusno ip addressno ip directed-broadcastisdn switch-type primary-5essisdn protocol-emulate userisdn incoming-voice modemfair-queue 64 256 0no cdp enable!interface FastEthernet0ip address 147.14.25.100 255.255.0.0no ip directed-broadcastno ip route-cacheno ip mroute-cache
Guest
