Copyright 2010-2017 Obihai Technology, Inc.
206
Star Code Profiles
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.
The 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 Settings
::
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 global (non-trunk specific). The general format of a global
variable is $var. The general format of a trunk specific variable is
TK
($var) , where
TK
is the abbreviated name of a trunk
(SP1-SP6, BT, or PP). If
TK
is not specified for a trunk-specific variable, it implies all the applicable trunks in the system.
Note that SP
n
is the SP
n
Service where
n
= 1-6, BT the OBiBluetooth Service, and PP the OBiTALK Service. Each service
is also referred to as a “trunk” in this document.
Here is a list of the supported $var:
$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 (global; admissible value: 0 for disable, 1 for enable)
$BCI1 = block caller-ID once (global; admissible value: 1 for enable)
$UBCI1 = unblock caller-ID once (global; admissible value: 1 for enable)
$LBM1 = Loopback media (audio samples) once in the next call
$LBP1 = Loopback RTP packets once in the next call
$CDM1 = Codecs to enable in the next call (temporarily overriding any codec preferences in device configuration). Each
bit of its value represents one audio codec:
