141
TANDBERG 3000
MXP
&
6000
MXP
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
D 13887.08
MAY 2008
Command Information
Understanding the Table Layout
3
TANDBERG 3000
MXP
&
6000
MXP
REFERENCE USER GUIDE FOR SYSTEM INTEGRATORS
Status Information
D 13887.X3
AUGUST 2006
Required parameters are identified by an
(r)
behind the parameter name. The
(r)
appears in this table for your information only and shall not be included when writing the commands – see the column
Example
for an illustration of this. Empty lines in the examples provided may have been removed to save space in the tables.
Command
Description
Parameters
Result parameters
when OK
Result parameters
when error
Example
AlertToneTest
Command used to
test the supported
alert tones. When the
command is issued the
system will playback the
specified alert tone.
Tone
(
r
)
: <1..10>
The tone to test.
None
Cause:
<1…>
Cause code
specifying why the
command was not
accepted by the
system
Description:
Textual description
of the cause code.
xcommand alerttonetest tone:5
*r Result (status=OK):
*r/end
OK
Boot
Command used to
reboot the system.
ParameterRestore: <On/Off>
When rebooting the system after
software upgrade, all configurations
will be restored.
By setting
ParameterRestore
to
Off
,
the system configurations prior to
software upgrade will be lost.
None
As above.
xcommand boot parameterrestore: on
*r Result (status=OK):
*r/end
OK
CallAccept
Command used to
answer an incoming
call if autoanswer is
disabled.
None
None
As above
xcommand callaccept
*r Result (status=OK): /
*r/end
OK
CallMute
Command used to mute
incoming audio from a
specific call in a Multi
-
Site conference.
Call
(r)
: <1..11>
Reference to the call to be muted or
unmuted.
Mode
(r)
: <On/Off>
Denotes whether the call is to be
muted or unmuted.
None
As above
xcommand callmute call:2 mode:on
*r Result (status=OK):
*r/end
OK
AlertToneTest — CallMute
TIP!
An exhaustive
description of the API
structure can be found
in the section
The TANDBERG API
Command
Brief description of
what the command
is used to.
Parameters used with this
command. If there is an
(r)
appearing, this indicates a
required parameter (i.e. a
parameter that always must
be specified. The
(r)
is not
to be written – it appears
for your information only.
If the command is
executed succesfully,
any result parameter
returned will be stated
here.
If the command was not
executed succesfully,
a description telling
why will be provided.
Details are found in this
column.
Example of the
command when
executed succesfully.
