Detailed 2G Command Description

Command Line Interface (CLI) commands are used to configure IVR functionality in the Tenor unit. All applicable CLI commands are detailed in this section.

Note

For general information about CLI, see the Command Line Interface (CLI) document for your product on the Quintum website.

This section is divided into two sections: IVR Commands and RADIUS commands. For each section, the applicable CLI commands are listed in tables; each table defines a specific CLI command. Table definitions are as follows:

Command. Name for the command and the prompt in which it is available.
Description. A brief description of the command, including any specific usage requirements.
Usage. The applicable prompt and usage rules, including default options.
Example. An example of how to use the command.

Configure IVR Commands

IVR Prompt Server IP (PrimaryServerIPAddr)

Command	PrimaryServerIPAddr (available from the config-IVRFileServer-1 prompt)
Description	Sets the IVR Prompt server (also known as the File Server) IP address in the Tenor’s database.
How to use it	At the config-IVRFileServer-1 prompt, type set psipa (or ssipa) [ipaddr]. For Primary and Secondary IP, the default value is 0.0.0.0. For improved reliability, set two different IVR Prompt servers in the database.
Example	config-IVRFileServer-1# set psipa [ipaddr] Sets the IP address for the primary IVR File server.

Set Language Type (IVRLanguage)

Command	IVRLanguage (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt)
Description	Sets the default voice prompt language. Tenor supports English, Persian, Mandarin, French, Spanish, German, Arabic, Russian, and Cantonese. This field defines prompt files used for IVR files.
How to use it	At the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt, type set ivrlanguage (followed by language ID). The language ID specifies which language will be used for the default voice prompts. Valid entries: 0 (English), 1 (Persian), 2 (Mandarin), 3 (French), 4 (Spanish), 5 (German), 6 (Arabic), 7 (Russian), and 8 (Cantonese). Default value: 0 (English). For using one language: Access the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt and type ivrl, followed by the language ID of the desired language, 0 through 8. Whichever number is chosen, the associated language will be the default language and played for all messages. For using multiple languages: Access the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt and type ivrl, followed by the language ID of the desired languages, 0 through 8, in the priority in which you would like to be prompted for the languages. The first number configured in the list will be the language used in the welcome message. Once the welcome message is played, a voice selection prompt asks the user to press 1 for the first language configured, 2 for the second language configured, or 3 for the third language configured. For example, if the field is configured 3 0 2, the welcome message will be played in French and the message that follows asks the user to hear the rest of the messages, Press 1 for French (played in French), Press 2 for English (played in English), or Press 3 for Mandarin (played in Mandarin). When this field is changed in the database, all the prompt files accumulated in the cache memory will be flushed from the memory.
Example	config-TrunkCircuitRoutingGroup-1# set ivrl 2 Sets the language type to Mandarin Chinese on this TCRG. config-TrunkCircuitRoutingGroup-1# set ivrl 2,0,1,3 Configures this TCRG to support 4 different languages; first Mandarin Chinese, then English, Farsi and French.

Set Multi-Session Call (IVRMultiSession)

Command	IVRMultiSession (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt )
Description	This command enables/disables the multisession call capability. The multi-session feature enables the user to make another call at the end of a call, without having to hang up and call again. At the end of the first call, a voice prompt will ask if the user wants another call. In addition, the user will be able to terminate an ongoing call and make another call, by pressing ** or ##.
How to use it	To enable multisession, at the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt , type set ivrms followed by ## or . To disable, type set ivrms** without a string.
Example	config-LineCircuitRoutingGroup-1# set ivrms Gives Customers of this LCRG the ability to make more than one phone call per connection by typing "" on their phone keypad.

Set IVR Type (IVRType)

Command	IVRType (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt)
Description	This command is used to have the 2G Tenor provide a secondary prompt for calls that come in to this Routing Group. This includes providing a simple second dial tone or a series of Interactive Voice Response (IVR) prompts for Pre-paid or Post-paid accounts.
How to use it	At the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt, enter set ivrt (followed by 1, 2, 3, 4, 5, 6, 7, 8, 9, or 11). Definitions for these fields are as follows: 0: IVR is disabled. This field is the default value. 1: 2nd Dial Tone. Provides second dial tone. 2: Pre-paid Calling Card. Supports pre-paid calling type. 3: Post-paid Calling Account (type 0). Supports post-paid calling type. 4: ANI Authentication (type 1). Enables calling subscribers to receive authentication based on the calling number. 5: ANI Authentication (type 2). Enables calling subscribers to receive three authentication types based on the calling number: Authentication with ANI, No ANI case (if no ANI in coming packet, Tenor asks PIN number by prompt) and Incoming packet has the ANI, but authentication with the ANI fails and Tenor prompts for the PIN number. 6: Postpaid account (type 1). For use with RADIUS servers that do not support post-paid with separate account number and PIN. The PIN number is appended to the end of the account number before being sent for authorization. If you set this option to 2 (Pre-paid Calling Card), you will need to set the card length via the Set IVR Card Length field; if you set this option to 3 (Post-paid Calling Account), you will need to set the account length via the IVR Account Length field. 7: Provides Second Dial Tone with Voice Prompt. The 2G Tenor will authenticate PIN entries against the value set in the PIN field. Selection #7 will play a voice prompt (dtprompt.wav) to give directions instead of just progress tones, as on selection #1. The user must listen to the entire voice prompt before accessing the second dial tone. 8: Same as option 7, but the user may interrupt the voice prompt with a keypress to access the second dial tone. 9: Provides "single-stage" pass-through authentication. This is intended for serving calls that are sent with the actual destination number as the DNIS. Calls under this IVRType are authenticated using ANI and authorized using DNIS. If the Authentication and Authorization are successful, no prompt is played and the call is routed through. If the call is rejected by RADIUS, a busy signal is played to the user. 11: Type 11 is almost identical with IVRType 2, except the RADIUS server chooses pre-paid or post-paid service. If the server returns billingmodel 1, IVRType 11 works exactly the same as IVRtype 2. If the server returns billingmodel 0, IVRType 11 works the same as IVRType 3, except it uses IVRCardNumLength instead of IVRAccountNumLength.
Example	config-TrunkCircuitRoutingGroup-1# set ivrt 2 Sets the IVRType to Prepaid Calling Card.

IVR Access Number (IVRAccessNumber)

Command	IVRAccessNumber (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt)
Description	Sets an Access Number for the user to access the IVR system. This number must match the access number used by the RADIUS server or the call will fail.
How to use it	At the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt, enter set ivran (followed by an access number). The maximum entry is 14 digits.
Example	config-LineCircuitRoutingGroup-1# set ivran 18005554321 Sets the phone number of the external IVR system to 18005554321.

IVR Answer Delay (IVRAnswerDelay)

Command	IVRAnswerDelay (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt)
Description	When the user dials the access number, the answer delay sets the amount of time that passes before the call picks up.
How to use it	At the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt, enter set ivrad (followed an amount of time in msec, the time must be between 0 - 10 seconds). Default value: 0.
Example	config-TrunkCircuitRoutingGroup-1# set ivrad 2000 Sets the delay time to 2 seconds.

IVR Account Length (IVRAccountNumLength)

Command	IVRAccountNumLength (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt)
Description	For Post-paid Accounts, this field sets the account length.
How to use it	At the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt, enter set ivranl (followed by the account length for post-paid accounts). Valid entry: numeric up to 20 digits. If the number of digits dialed is less than the number set in this field, the user must press the “#” key when done entering the account number, and the entry will be submitted. Any subsequent digits will be applied to the PIN.
Example	config-LineCircuitRoutingGroup-1# set ivranl 10 Sets the number of account digits to 10.

IVR PIN Length (IVRPinNumLength )

Command	IVRPinNumLength (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt)
Description	For Post-paid Accounts, this field sets the length of an personal identification number (PIN) used by the IVR system to verify the user.
How to use it	At the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt, enter set ivrpnl (followed by the length, numeric up to 20). Default entry: 0. If this field is set to “0,” the user must press # when finished entering the pin number. If the number of digits dialed is less than the number set in this field, the user must press # when done entering the PIN length and the entry will be submitted
Example	config-TrunkCircuitRoutingGroup-1# set ivrpnl 12 Sets the number of PIN digits to 12.

IVR Card Length (IVRCardNumLength)

Command	IVRCardNumLength (available from the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt)
Description	Sets the length of calling card digits used by the IVR system.
How to use it	At the config-LineCircuitRoutingGroup-1# or config-TrunkCircuitRoutingGroup-1# prompt, enter set ivrcnl (followed by the length, numeric up to 20) of the calling card. If the number of digits dialed is less than the number set in this field, the user must press # when done entering the card number and the entry will be submitted.
Example	config-TrunkCircuitRoutingGroup-1# set ivrcnl 12 Sets the number of digits of a Calling Card Account to 12.

Configure RADIUS Commands

RADIUS Primary Server IP Address, Authentication Port, Accounting Port

Command	PrimaryServerIPAddr (available from the config-RadiusInfo-UserServer# prompt) PrimaryAuthenticationPort (available from the config-RadiusInfo-UserServer# prompt) PrimaryACcountingPort (available from the config-RadiusInfo-UserServer# prompt)
Description	These commands are set on the Tenor for communication with the RADIUS server: Primary Server IP address, Authentication Port and Accounting Port. Depending upon the RADIUS software, you may need to adjust the application ports for authentication and accounting. The Primary Server IP address is the address of the RADIUS server. You can set an IP address for the Primary and Secondary Server (the Secondary Server is optional). The Authentication port is the port on the RADIUS server used for authentication of information, such as the password, card number, and PIN. The Accounting Port is the port used to record accounting data, such as the length of the call, date, time, etc. All of these commands are available for both the Primary RADIUS Server and Secondary RADIUS Server. These commands are required for the Primary RADIUS Server and optional for the Secondary RADIUS server (if the Secondary RADIUS server is configured).
How to use it	At the config-RadiusInfo-UserServer# prompt, type each of the following for the primary RADIUS Server and Secondary RADIUS Servers: set psipa (or ssipa), followed by the applicable IP address. The letter p indicates primary RADIUS server; s indicates secondary RADIUS server. set pap (or sap), followed by the port number. Default value: 1812. set pacp (or sacp), followed by the accounting port. Default value: 1813.
Example	config-RadiusInfo-UserServer# set psipa 192.168.100.211 Sets the Primary RADIUS Server IP address to 192.168.100.211. config-RadiusInfo-UserServer# set sap 1812 Sets the Secondary Authentication Port to 1812. config-RadiusInfo-UserServer# set pacp 1646 Sets the Primary Accounting Port to 1646.

RADIUS Shared Secret (SharedSecret)

Command	SharedSecret (available from the config-RadiusInfo-UserServer# prompt)
Description	Sets the RADIUS key. As a security measure, the sharedsecret enables the Tenor to share encrypted data with the RADIUS server. The data is sent to the RADIUS server encrypted, and the RADIUS server can then decrypt it. The value must be identical to the value configured in the RADIUS server.
How to use it	At the config-RadiusInfo-UserServer# prompt, enter set ss (followed by the RADIUS key). Valid entry: up to 64 characters.
Example	config-RadiusInfo-UserServer# set ss 1a2b3c Sets the shared secret of the 2G Tenor to 1a2b3c.

RADIUS Request Timeout (Timeout)

Command	Timeout (available from the config-RadiusInfo-UserServer# prompt)
Description	The number of seconds for the Tenor to wait for a RADIUS Server response.
How to use it	At the config-RadiusInfo-UserServer# prompt, enter the timeout (followed by the number of seconds to wait for RADIUS response). Valid entry: numeric. Default: 5 seconds.
Example	config-RadiusInfo-UserServer# set t 3 Sets the number of seconds to wait for a RADIUS response to 3.

RADIUS Request Retry (RetryCount)

Command	RetryCount (available from the config-RadiusInfo-UserServer# prompt)
Description	The number of requests the Tenor sends to the RADIUS Server for a retry before it will stop sending requests.
How to use it	At the config-RadiusInfo-UserServer# prompt, enter set rt (followed by the number of retries). Valid entry: numeric. Default entry: 3.
Example	config-RadiusInfo-UserServer# set rc 5 Sets the number of retries of RADIUS data transmission to 5.

Accounting Type (AccountingType)

Command	AccountingType (available from the config-RadiusInfo-UserServer# prompt)
Description	When a call is entered, this field determines the number of accounting messages the Tenor delivers to the RADIUS server.
How to use it	At the config-RadiusInfo-UserServer# prompt, enter set at (followed by 0 \| 1 \| 2 \| 3 \| 4 \| 5 ). Valid settings are as follows: “0” disables the accounting type field (no accounting messages will be sent). “1” indicates only one stop accounting message is sent to the RADIUS server. “2” indicates one stop accounting message will be sent per each leg of call (including multiple outbound attempts). "3" indicates one start accounting and one stop accounting message will be sent. "4" indicates two start accounting and two stop accounting messages will be sent per each leg of the call (including multiple outbound attempts). "5" indicates one stop accounting message for the answer (incoming) leg, and only one stop accounting message for the originate (outgoing) leg. When this option is used, Start-Accounting and Update-Accounting messages are disabled and will not be generated. If the accountingtype field is set to “0”, no “stop accounting” message will be sent.
Example	config-RadiusInfo-UserServer# set at 2 Sets the number of RADIUS accounting messages to 2.

Update Accounting

Command	UpdateAccountingType (available from the config-RadiusInfo-UserServer# prompt)
Description	This command sets the type of Update Accounting messages that are sent to the RADIUS server per call. AccountingType must have messaging turned on for this command.
How to use it	At the RadiusInfo-UserServer# prompt, type set uat (followed by 0 \| 1 \| 2 \| 3). Valid settings are as follows: 0 = Disabled (default) 1 = Generate Update-Accounting only for the outgoing leg 2 = Generate Update-Accounting only for the outgoing leg 3 = Generate Update-Accounting for incoming and outgoing legs Setting this command to 3 (generate update accounting messages for both incoming and outgoing leg) requires the RADIUS server to send a return code in the Update-Accounting response. A non zero value of the return code should result in the termination of the call. A timeout after the retries configured in the database should also result in the termination of the call.
Example	config-RadiusInfo-UserServer# set uat 3 Sets the Tenor to generate update accounting messages for both incoming and outgoing legs.

Command	UpdateAccountingInterval (available from the config-RadiusInfo-UserServer# prompt)
Description	This command configures how often to generate Update-Accounting requests. AccountingType must have messaging turned on for this command, and UpdateAccountingType must have a non-zero value.
How to use it	At the RadiusInfo-UserServer# prompt, type set uai (followed by the number of minutes). Valid entry: 1-30 minutes. Default: 3 minutes.
Example	config-RadiusInfo-UserServer# set uai 5 Sets the update accounting interval to 5 minutes.