About The Api Commands; Syntax Conventions; Availability Of Commands - Polycom HDX series Reference Manual

Integrator's Reference Manual for Polycom HDX Systems

About the API Commands

Syntax Conventions

Convention
<param1|param2|param3>
[param]
["param"]
{a..z}
"x"

Availability of Commands

4 - 2
The following conventions are used for the API command descriptions in this
chapter. All of the commands are case sensitive.
Meaning
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.
Optional parameters are enclosed in square brackets. Quotation marks
indicate strings to be supplied by the user.
Example: ping "xxx.xxx.xxx.xxx" ["count"] shows that you can
supply a value for count, or omit it and let the default value apply. You do
not need to enclose a value in quotes unless it contains a space.
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.
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.
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.
The availability of API commands depends on the type of system and optional
equipment installed or connected. If a setting is not configured on the system,
issuing a command for that particular setting returns the feedback that the
command is not supported for this 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.