Using the API
Polycom, Inc. 111
Using the API with the Maximum Security Profile
Enabled
When configured for the Maximum security profile, API sessions using a LAN Connection (telnet) are not
available, and API sessions using an RS-232 port or SSH require you to log on using a valid user ID and
password. The system will accept either the local admin account user ID (and associated remote access
password) or the local user account user ID (and associated remote access password).
In addition, if Active Directory External Authentication is enabled, then Active Directory account credentials
can also be used. In this case, however, the local user account is disabled and so cannot be used. See the
Polycom RealPresence Group Series Administrator Guide for details on the use of Active Directory External
Authentication.
Using the API with a LAN Connection
If you have a computer connected to the LAN, you can send API commands to the RealPresence Group
Series system through telnet (port 24) and SSH (port 22).
To use the API with a LAN connection:
1 On the computer, open a command line interface.
2 Start a telnet session using the RealPresence Group Series system IP address and port number
that is currently configured for telnet API—for example, telnet 10.11.12.13 24.
3 Log in, if prompted, using the local admin account's remote access password.
Using the API Controller Code
With their cooperation, Polycom has provided AMX, Crestron, and Extron the complete RealPresence
Group Series API for development of their Partner modules. These modules are available and can be
obtained from the manufacturer’s websites.
Secure API Access
You can access a RealPresence Group Series system using the Secure Shell (SSH) protocol. Secure API
access is authenticated for local and Active Directory (AD) accounts.
Note: If your computer is running the Windows 7 operating system, you might need
to install the telnet client before starting a telnet session. The telnet client is not
installed by default with Microsoft Windows 7 operating systems.
Note: When a password is empty, SSH will not validate credentials and allow a user to log in.
Polycom recommends that you consistently use passwords for secure access.