Understanding The Table Layout - TANDBERG Codec 3000 MXP Reference Manual

Command Information

Understanding the Table Layout

Status Information
AlertToneTest — CallMute
Command
Command
AlertToneTest
Brief description of
what the command
is used to.
Parameters used with this
Boot
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
CallAccept
for your information only.
CallMute
Required parameters are identified by an
D 13887.X3
AUGUST 2006
An exhaustive
TIP!
description of the API
structure can be found
in the section
The TANDBERG API
D 13887.08
MAY 2008
Description Parameters
Command used to Tone(r): <1..10>
test the supported
The tone to test.
alert tones. When the
command is issued the
system will playback the
specified alert tone.
Command used to ParameterRestore: <On/Off>
reboot the system.
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.
Command used to None
answer an incoming
call if autoanswer is
disabled.
Command used to mute Call(r): <1..11>
incoming audio from a
Reference to the call to be muted or
specific call in a Multi-
unmuted.
Site conference.
Mode(r): <On/Off>
Denotes whether the call is to be
muted or unmuted.
(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.
REFERENCE USER GUIDE FOR SYSTEM INTEGRATORS
Result parameters Result parameters Example
when OK when error
xcommand alerttonetest tone:5
None Cause: <1...>
*r Result (status=OK):
Cause code
*r/end
specifying why the
OK
command was not
accepted by the
system
Description:
Textual description
of the cause code.
xcommand boot parameterrestore: on
None As above.
*r Result (status=OK):
*r/end
OK
xcommand callaccept
None As above
*r Result (status=OK): /
*r/end
OK
xcommand callmute call:2 mode:on
None As above
*r Result (status=OK):
*r/end
OK
3
141
TANDBERG 3000
REFERENCE GUIDE FOR SYSTEM INTEGRATORS
Example of the
TANDBERG 3000 MXP & 6000 MXP
command when
executed succesfully.
If the command was not
executed succesfully,
a description telling
why will be provided.
Details are found in this
column.
If the command is
executed succesfully,
any result parameter
returned will be stated
here.
MXP & 6000 MXP