Star Code Profile Features Of The Obi Device; S Tar C Ode S Cript V Ariables (Var) - Obihai OBi100 Administration Manual

Star Code Profile Features of the OBi Device

Star codes are short sequences of digits where each sequence serves as a command to the OBi Device to perform certain
operation. Each sequence usually starts with the * key followed by a 2-digit code (such as *69), hence the term star code. A
typical operation to carry out is to set the value of one or more configuration parameters. At present the OBi device allows
user to issue star code from the PHONE port only; user issues a star code the same way he dials a number to make a call. In
OBi every star code and its operation are defined with a short Star Code Script parameter. The set of star codes that can be
dialed from the PHONE port is collectively referred to as a Star Code Profile.
OBi has two star code profiles available in its configuration, known as Start Code Profile A and B respectively. Each profile
has 30 star code script parameters, known as Code1 to Code30. You can select which star code profile to use by setting
PHONE Port::StarCodeProfile to A or B, or None if star code is not to be used.
A star code script is defined with the help of a number of predefined variables and actions. Each variable represents one or
one group of configuration parameters. An action can be checking or setting the value of a variable, collecting a phone
number from the user, or calling a certain number.
Star Code Script Variables (VAR)
A star code script variable or VAR can be trunk specific or phone-port specific. The general format of a phone-port specific
variable is $var and it applies to the current phone port where the star code is entered. The general format of a trunk
specific variable is TK($var) , where TK is the abbreviated name of a trunk (SP1, SP2, LI1, or PP1). If TK is not specified for a
trunk-specific variable, it implies all the applicable trunks in the system.
Note that: SP1 is the SP1 Service, SP2 the SP2 Service, LI1 the LINE port and PP1 the OBiTALK Service. Each service is also
referred to as a "trunk" in this document.
Here is a list of the supported $var variables:
$CFA = call forward unconditional enable (trunk specific; admissible value: 0 for disable, 1 for enable)
$CFB = call forward busy enable (trunk specific; admissible value: 0 for disable, 1 for enable)
$CFN = call forward no-answer enable (trunk specific; admissible value: 0 for disable, 1 for enable)
$CFAN = call forward unconditional number (trunk specific; admissible value: a token representing a call forward number)
$CFBN = call forward busy number (trunk specific; admissible value: a token representing a call forward number)
$CFNN = call forward no-answer number (trunk specific; admissible value: a token representing a call forward number)
$MWS = message waiting state (trunk specific; admissible value: 0 for no new messages, 1 for one or more new messages)
$DND = do-not-disturb enable (trunk specific; admissible value: 0 for disable, 1 for enable)
$BAC = block-anonymous caller enable (trunk specific; admissible value: 0 for disable, 1 for enable)
$BCI = block outbound caller-ID enable (trunk specific; admissible value: 0 for disable, 1 for enable)
$CWA = call-waiting enable on this phone port (phone-port specific; admissible value: 0 for disable, 1 for enable)
$BCI1 = block caller-ID once in the next call on this phone port (phone-port specific; admissible value: 1 for enable)
$UBCI1 = unblock caller-ID once in the next call on this phone port (phone-port specific; admissible value: 1 for enable)
$LBM1 = Loopback media (audio samples) once in the next call on this phone port (phone-port specific; admissible value: 1)
$LBP1 = Loopback RTP packets once in the next call on this phone port (phone-port specific; admissible value: 1)
$BAR1 = Barge-In once in the next call on this phone port (phone-port specific; admissible value: 1)
Copyright 2010-2013 Obihai Technology, Inc. 175