Specifications

Table Of Contents
Using the API
Polycom, Inc. 3–3
Using the API with the Department of Defense (DoD) Security Profile Enabled
On a system with the Security Profile set to DoD, you can access the API
commands using an RS-232 connection only, and must log in as an Admin or
User.
The availability of certain API commands and parameters depends on
whether you are logged in as Admin or User. For example, if you are logged
in to the API session as Admin, you can set and get the ISDN area code using
the
areacode
command. If you are logged in as User, you can only get the
ISDN area code.
For a complete list of API commands and parameters available to the User and
Admin IDs, refer to U.S. DoD DSN Deployment Guide for Polycom HDX
Systems.
Using the API with a LAN Connection
If you have a computer connected to the LAN, you can send API commands
to the Polycom HDX system via Telnet port 24.
1 On the computer, open a command line interface.
2 Start a Telnet session using the Polycom HDX system IP address and port
number — for example,
telnet
10.11.12.13 24
.
You cannot use Telnet to access the system if Security Mode is enabled.
Using the API Controller Code
In cooperation with the leading touch panel controller manufacturers,
Polycom Video Division is proud to offer its own version of controller code
designed to run on Crestron and AMX systems. This independent code base
was developed specifically to address issues of code compatibility with video
system software releases. It provides a fully executable controller program but
also serves as a guideline for ongoing development using Polycom preferred
methodology and commands.
To download the API controller code, refer to
www.polycom.com/forms/amx_code.html. Additionally, AMX controller
code or Crestron controller code is available for controlling the Polycom
EagleEye HD camera. Companion documents are also available to further
explain how to interface your controller with Polycom video systems and
utilize the API efficiently.