Feedback From Codec Over Http - Cisco TelePresence SX20 Codec Reference Manual

Cisco TelePresence SX20 Codec
Contents Introduction

Feedback from codec over HTTP

To get notifications from the codec, you need to register HTTP
feedback expressions. The codec will then use HTTP POST
to send feedback messages to the supplied IP-address. This
means that you have to have a HTTP server running for your
application to receive updates from the codec.
Registering for feedback
The command for registering is
xCommand HttpFeedback Register. The syntax for this
command and its arguments are described in this section.
HttpFeedback Register syntax:
xCommand HttpFeedback Register
FeedbackSlot: <1..4>
ServerUrl(r): <S: 0, 2048>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
Expression: <S: 1, 255>
SX20 Codec API Reference Guide TC7.3, OCTOBER 2015.
D14949.13
About the API About the API xConfiguration
HttpFeedback Register arguments:
FeedbackSlot: The codec can register up to 4 slots of servers
requesting HTTP feedback. Set the registering to one of them.
Note: Avoid using FeedbackSlot 3 in an environment where
Cisco TelePresence Management Suite (TMS) is used as TMS
uses this feedbackslot to register its expressions.
ServerUrl: The URL that you want the codec to post the HTTP
feedback messages to.
Expression 1-15: Register the expressions you want to
receive feedback on. Refer to "Feedback mechanism" on
page 19.
Example: Registering feedback on configuration changes,
disconnect events and call status changes.
<Command>
<HttpFeedback>
<Register command="True">
<FeedbackSlot>1</FeedbackSlot>
<ServerUrl>http://127.0.0.1/
myhttppostscripturl</ServerUrl>
<Expression item="1">/Configuration</
Expression>
<Expression item="2">/Event/
CallDisconnect</Expression>
<Expression item="3">/Status/Call</
Expression>
</Register>
</HttpFeedback>
</Command>
22
xCommand xStatus
Feedback output
When the codec notifies the registered HTTP server about
changes, the body contains the same XML as when polling.
There is however one small difference. The root-node
contains an Identification node with children that specify the
codec from which the notification originated. This means that
you can handle multiple codecs with a single HTTP server URI.
Example: Audio volume changed.
<Configuration xmlns="http://www.company.com/XML/
CUIL/2.0">
<Identification>
<SystemName>integrator</SystemName>
<MACAddress>00:00:de:ad:be:ef</MACAddress>
<IPAddress>192.168.1.100</IPAddress>
<ProductType>Cisco Codec</ProductType>
<ProductID>Cisco Codec C90</ProductID>
<SWVersion>TC6.0.0.199465</SWVersion>
<HWBoard>101401-5 [08]</HWBoard>
<SerialNumber>PH0000000</SerialNumber>
</Identification>
<Audio item="1">
<Volume item="1">60</Volume>
</Audio>
</Configuration>
Copyright © 2015 Cisco Systems, Inc. All rights reserved.
API Reference Guide
Appendices