TANDBERG D13639 FeedbackDeregister FeedbackRegister, OK Result parameters Error Result parameters

Page 59

FeedbackDeregister

FeedbackRegister

TANDBERG MPS API

User Guide

accepted by the system

Description Textual description of the cause code.

Example:

xcommand disconnectgwcall gatewaycall:1

*r Result (status=OK): *r/end

OK

Command used to deregister XML feedback over HTTP(S).

Parameters:

ID: <1..3> ID for the registration to deregister.

OK Result parameters:

ID: <1..3>

ERROR Result parameters:

Cause: <1…> Cause code specifying why the command was not accepted by the system

Description Textual description of the cause code.

Example:

xcommand feedbackderegister id:1

*r Result (status=OK): ID: 2

*r/end

OK

Command used to instruct the system to return XML feedback over HTTP(S) to specific URLs. The parts of the Status and Configuration XML documents to monitor are specified by XPath expressions.

The system supports issuing feedback to 3 different URLs.

The system allows a total of 20 XPath expressions to be registered, with a maximum of 15 for a single URL.

Parameters:

ID: <1..3> ID for the registration. If this parameter is omitted the system uses the first vacant ID.

URL(r): <S: 0, 256> The URL to post feedback to.

Expression.1..15: <S: 0, 256> XPath expression

OK Result parameters:

ID: <1..3>

ERROR Result parameters:

Cause: <1…> Cause code specifying why the command was not accepted by the system

Description Textual description of the cause code.

Example:

xcommand feedbackregister url:http://10.47.14.185:8000 expression.1:status/call expression.2:status/conferenc

e

*r Result (status=OK): ID: 2

57

Image 59
Contents User Guide Tandberg MPS APITable of Contents Disclaimer Tandberg APIExample Introduction to XMLExample Tandberg MPS API Introduction to XML Path Language XPath Status/Call@status=Synced/CallRate Feedback Addressing using XPathTandberg XML Engine Structuring of InformationTandberg MPS API Status Documents r XML DocumentsDocuments Configuration documents rw Command documents w Command Dial item=1 Number item=1999/Number /Dial Example Formputxml Introduction to Tandberg XML API Service TxasBare-bone Https access GetxmlExercise ExercisesTandberg MPS API XML-based Advanced Command Line Interface Addressing Accessing XacliRoot commands Xstatus call Exposure optionsSupported exposure options Misc Xstatus call 1 remotenumber Status-type root commands Xstatus / xhistoryFormat Xstatus ?Xacli *s IP XMLXdirectory ? Configuration-type root commands xconfiguration/xdirectoryConfiguration help Xconfiguration ?Xconfiguration // ? Xconfiguration ?? Configuration readConfiguration set write Xconfiguration ip/assignment static Xcommand ?? Command-type root commands xcommandCommand help Xcommand ?Xcommand dial nu666 ron c128 s10 Issuing a commandExample 2.12 xcommand Dial ? Xcommand dial number666 restricton callrate128 subaddress10Xcommand dial Xcommand dial 666 10 128 onXcommand dial 666 ron 10 Xgetxml status/ip XML Output xgetxmlXfeedback register status/call/channels/audio/protocol Special CommandsXfeedback Xfeedback ?Xfeedback register status/call@status=Disconnected Xcom dial Xfeedback register status/call Xcom dialXfeedback register status/call@status=Synced Xcom dial Xcom discXpreferences ? XpreferencesXpreferences detaillevel Xstat call 1 channels 1 audio Xstat call 1 channels 1 audioBaudRate item=12400/BaudRate API Configurations Configuration.xml xconfiguration Tandberg MPS API Tandberg MPS API Http Mode On/Off H323Gatekeeper 1..2 Authentication Password S 0Tandberg MPS API MCU LoS Polarity Positive/Negative LoS RetrySerialInterfaceCard Session RTPSIP Interface Transport Default TCP/UDP SIP Mode On/OffSIP Interface Authentication UserName S 0 SIP Interface Authentication Password S 0Tandberg MPS API Directory.xml xdirectory API Commands Command.xml xcommand CallMuteOutgoing CallTransfer CallTransferToDirEntry Parameters Conferencer OK Result parameters CallMuteVideo ConferenceDisconnect ConferenceModifyConferenceRedefine ConferenceStart ConferenceStop ConferenceShowDuration ConferenceTerminate DefaultValuesSet Dial Description Textual description of the cause code DialGroupEntry DialInNumberAdd DialInNumberRemoveParameters Conferencer DialLocalEntry DisconnectCall DisconnectGWCall FeedbackDeregister FeedbackRegister OK Result parameters Error Result parametersParameters Name S 0, 48 The entry’s name FloorToSite FloorToSiteEnd GroupEntryAddGroupEntryDelete LayoutLock LayoutUnLock NetworkId NetworkModule OK Result parameters Windowr CallIDr 1..176 Call Error Result parametersLocalEntryAdd LocalEntryDelete Command used to add option key ProtectNumberRemove VideoTextSet API Status Examples Status.xml xstatusTandberg MPS API Examples Tandberg MPS API Mcuid Feedback Top level attributes Ethernet Top level attributesMediaBoard 1..8 Top level attributes User GuideEnd NoneSystemUnit Top level attributes None Summary Top level attributes Status on/off Summary SerialInterfaceCard ISDNInterfaceCardTandberg MPS API Tandberg MPS API NTP SIP SystemLoad SystemClock SystemActivity Options Option Option 64 / *s/end Conference Top level attributes History.xml xhistoryEvent.xml xevent PacketsDropped AudioTotalPackets PacketLossEnd