Table of Contents
Advertisement
Integrator's Reference Manual for Polycom HDX Systems
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."
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.
Command Response Syntax
When you send a command, the system returns responses using the syntax described in the following
sections, where <CR> indicates a carriage return and <LF> indicates a line feed.
When Not Registered to Receive Notifications
When your system is not registered to receive any notifications and you send an API command, a single
API acknowledgement is returned.
For example:
camera near 2 <CR>API command
returns
camera near 2<CR><LF>API acknowledgement
In the example above, the command was sent with an end of line character of a carriage return <CR>.
The API expects a carriage return <CR> as well as the standard end of line characters carriage return/line
feed <CR><LF>. All API responses end in carriage return/line feed <CR><LF>.
When Registered to Receive Notifications
Registering for notifications adds extra line responses in the form of API registration responses. The number
of additional lines depends on the specific registration. In the following example, the response shows an API
acknowledgement and an API registration response returned:
Polycom, Inc.
API support is not available for:
•
Telnet ports 23 and 24 when Security Mode is enabled.
•
Software versions for the Joint Interoperability Test Command (JITC)
certification.
The end of line (EOL) character for the echo is different for serial and LAN
responses. The feedback examples below and elsewhere in the Integrator's
Reference Manual are based on the serial response.
System Commands
109
Advertisement
Table of Contents
