Availability Of Commands; Command Response Syntax - Polycom RealPresence Group Series Reference Manual

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.
Note: API support is not available for software versions for the Joint Interoperability
Test Command (JITC) certification.

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
Polycom, Inc.
System Commands
117