System Commands
Polycom, Inc. 118
When your system is registered for notifications, always use the API registration response for status.
Commands that Restart the System
Commands that Restart the System without a Prompt
● reboot now
● resetsystem
Additional Tips
● The system does not provide flow control.
● If the connection is lost (e.g., the system restarts, goes into sleep mode, among other reasons), you
must re-establish the connection.
● The API processes one command at a time.
● Polycom does not recommend sending multiple commands simultaneously without a pause or delay
between them.
● For commands with a single action and a single response: A delay of 200 milliseconds between
commands is usually sufficient. Examples of these commands include the commands for switching
cameras (camera near 1), sending content (vcbutton play), and checking the status of the
audio mute (mute near get).
● For commands with a single action and a more extensive response: The time required to receive the
response, and thus the time between commands, may be longer than 200 milliseconds. The
response length, which can vary in size, determines the time required to receive the response.
Examples of these commands include the commands for retrieving the local address book
(addrbook all), the global address book (gaddrbook all), the list of system settings, and
system session information (such as whoami).
● When developing your program, always allow enough time for the response to the requested
command to complete before sending another command.
● Polycom does not recommend that you send any commands while an incoming or outgoing call is
being established.
● The API provides feedback status in two ways: registrations or polling.
● Send registration and notification API commands only once. Registrations are written to Flash
memory and retained when the system restarts.
● Polycom recommends putting registrations in the initialization or startup of Crestron and AMX
systems.
● Registrations are recommended over polling since they will provide status updates without having to
query for changes.
● Never poll for registrations.
● Registrations are specific to the port from which they are registered. If you register for notifications
from com port 1, registration will not be sent to com port 2 or Telnet port 24.
To Next Page
Loading...
Need help?
General
