Polycom 2457-23216-002 User Manual

Page of 280
Integrator’s Reference Manual for the Polycom RealPresence Group Series  
50
Polycom, Inc.
 
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.
Availability of Commands
The availability of API commands depends on the type of system optional 
equipment installed or connected, security settings and the software version 
installed on the system. 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
”. If a setting is configured by a provisioning service, the 
command may return feedback such as “
this setting is controlled by a 
provisioning service and cannot be changed. For more information about 
provisioned settings, refer to your provisioning service 
administrator.
 
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.
Commands that are not listed in this chapter are not supported by Polycom. 
Commands might change or be removed at any time. Polycom discourages 
integrators from using unpublished commands.
{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.
Convention
Meaning
API support is not available for software versions for the Joint Interoperability 
Test Command (JITC) certification.