Specifications

Integrator’s Reference Manual for Polycom HDX Systems
4 - 2
About the API Commands
Syntax Conventions
The following conventions are used for the API command descriptions in this
chapter. All of the commands are case sensitive.
Although the API command parser may accept the minimum number of
characters in a command which makes it unique, you should always use the
full command string.
Availability of Commands
The availability of API commands depends on the type of system and optional
equipment installed or connected. If a particular command is not supported on
the system, the command returns feedback such as “
error: this command is
not supported on this model
” or “ command is not available in current
system configuration
”.
Deprecated commands are included for backward compatibility only and are
not recommended for use with this version. Suitable replacements are noted
for each deprecated command.
Convention Meaning
<param1|param2|param3> Multiple valid parameters are enclosed in angle brackets and separated by
the pipe (“|”) character.
Example: allowdialing <yes|no|get> shows that the allowdialing
command must be followed by one of the parameters listed.
[param]
[“param”]
Optional parameters are enclosed in square brackets. Quotation marks
indicate strings to be supplied by the user.
Example:
teleareacode set ["telephone_area_code"] shows that you
can supply a value for the area code, or omit it and let the default value
apply. You do not need to enclose the actual value in quotes unless it
contains a space.
{a..z} A range of possible alphanumeric values is enclosed in braces.
Example:
abk letter {a..z} shows that the abk command can be used
to return address book entries that begin with an alphanumeric character in
the range specified.
Example: camera near {1..4} shows that the camera command can be
used to select camera 1, 2, 3, or 4 at the near site.
“x” Quotation marks indicate strings to be supplied by the user. You do not
need to enclose the value in quotes unless it contains a space.