Table of Contents
Advertisement
System Commands
This chapter describes the API commands for HDX software version 3.1.3.
For an alphabetical list of all the commands, refer to the table of contents for this document. For a list of
commands by category, refer to
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.
Convention
<param1|param2|param3>
[param]
["param"]
{a..z}
"x"
Although the API command parser may accept the minimum number of characters in a command that
makes it unique, you should always use the full command string.
Polycom, Inc.
Categorical List of API Commands
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: 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 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.
on page 625.
108
Advertisement
Table of Contents
