Xcommand Operations; Return Result Parameters; Xcommand Help; Xcommand Write - Cisco TelePresence System Codec C90 Reference Manual

Cisco TelePresence System Codec C90
Contents Introduction

xCommand operations

The xCommand 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
D14641.06 Codec C90 API Reference Guide TC5.0 November 2011.
© 2010-2011 Cisco Systems, Inc. All rights reserved.
About the API About the API

xCommand Help

To get help on a setting you can use a help
query. Enter the path followed by ? or help.
•
xCommand dial ?
Returns a set of return values. See the
example to the right.
•
xCommand 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.
•
xCommand 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.
xConfiguration xCommand
Example with xCommand Help
To get help on xCommand, type
xCommand <address expression> ?
xCommand Dial ?
*h xCommand Dial
Number(r): <S: 0, 255>
Protocol: <H323/Sip>
CallRate: <64..6000>
CallType: <Audio/Video>
ForceNewConference: <False/True>
ConferenceId: <0..65534>
OK
Example with xCommand Write
Dial a number with only the required parameter:
xCommand Dial Number: 95458458
OK
*r DialResult (status=OK):
CallId: 2
ConferenceId: 1
*r/end
OK
18
API Reference Guide
xStatus
? or help after the command path (address expression):
Appendices
www.cisco.com