TANDBERG 6000MXP - Manual (Page 49)

D 13887.08
MAY 2008 49
TANDBERG 3000 MXP & 6000 MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
When issuing a command, the system will return a set of return values. The
response will by default be on the same format as the standard XACLI Status
format. The other supported status formats (completepath/XML) are also
supported – ref.
xpreferences .
EXAMPLE
xcommand dial 558458
*r Result (status=OK):
CallRef: 1
LogTag: 6
*r/end
OK
If complete path is enabled for the RS-232/Telnet session
(“
xpreferences completepath on”):
EXAMPLE
xcom dial 558458
*r Result (status=OK):
*r Result CallRef: 1
*r Result LogTag: 4
OK
XACLI – Command-type Commands – Issuing a Command
About the TANDBERG API
A command must start with the command-type command ( xcommand), followed by a command name, followed
by a set of parameters. Parameters values are identified by specifying the parameter name followed by a ‘ :’
<command-type command> <command name> <parameter:value> <parameter:value>...
EXAMPLE:
xcommand dial number:558458 restrict:on callrate:128 subaddress:10
If there are multiple instances of a parameter, the item number is added after the tag separated with a dot:
<command-type command> <command> <parameter.item:value> <parameter.item:value>...
EXAMPLE:
xcommand groupentryadd name:TANDBERG localentryid.1:15 localentryid.2:57
Issuing a Command Command Response
Sequence Notation (Optional)
<command-type root command> <command> <value> <value>...
When using this notation the parameter values must be entered in the sequence as stated in the help text:
EXAMPLE:
*h xCommand Dial
Number: <S: 0, 60>
SecondNumber: <S: 0, 60>
SubAddress: <S: 0, 20>
CallRate: <Tlph/1xh221/2xh221/64/128/192/256/320/384/H0/512/768/1152/1472/1
920/2560/3072/4096/Max/Auto>
Restrict: <On/Off>
NetProfile: <1..7>
BillingCode: <S: 0, 16>
To dial a participant with the following properties: Number: 666, SecondNumber:777, SubAddress: 8, CallRate:
128, Restrict: On
xcommand dial 666 777 8 128 on
A combination of markup notation and sequence is also supported. The
marked parameters will be assigned the user entered values first, then the
system will assign the sequence entered parameters for the parameters not
yet having been assigned a value:
EXAMPLE:
xcommand dial 666 restrict:on 777 8 128
Combination of Markup Notation and Sequence (Optional)
NOTE! When using XACLI as a machine-machine interface we recommend that
you use markup notation and always supply complete tag names.