Polycom 2457-23216-002 User Manual

System Commands

Polycom, Inc.

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.
•

camera near 1 <CR>

API command

returns

camera near 1<CR><LF>

API acknowledgement

notification:vidsourcechange:near:1:Main:people<CR><LF>

API registration response

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 with a Prompt

•

reboot

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.