D14128.03—JULY 2009
44
Codec C90
System Integrator Guide
Contents
Introduction
Getting Started
Interfaces
About the API
xConfiguration
xCommand
xStatus
Cameras
Appendices
Contact us
xCommand operations
Command type commands are used to instruct the
system to perform a given action.
Return result parameters
The following operations can be performed on
xCommand:
Command Help
•
*h
is used when returning the result of a
help
query
Command Write
•
*r
is used when returning the result of a
write
command
Example with xCommand Help
To get help on xCommand, type
?
or
help
after the command path (address expression):
xCommand <address expression> ?
xCom mand Dial ?
*h xCom mand Dial:
Number(r): <S: 0, 255>
Protocol: <H323/SIP>
CallRate: <64..6000>
OnlyAudio: <False/True>
OK
xCommand Help
To get help on a setting you can use a help query.
Enter the path followed by
?
or
help
.
•
xCom mand dial ?
Returns a set of return values. See the example
to the right.
•
xCom mand dial help
As above.
xCommand Write
When issuing a command, the system will return a
set of return values. The structure is described by
the example to the right.
•
xCom mand Dial Number: 12345
Issues the command and gives a response. See
the example to the right.
The response will by default be on the same format
as the standard XACLI Status format. The XML
status format is also supported.
You can read more about XML in the xPreferences
section.
Example with xCommand Write
Dial a number with only the required parameter:
xCom mand Dial Number: 558458
OK
*r DialResult (status=OK):
CallId: 2
ConferenceId: 1
*r/end
OK
Contents
Introduction
Getting started
Interfaces
About the API
xConfiguration
xCommand
xStatus
Cameras
Appendices
Contact us
About the API
