Home

TANDBERG D13639 User's Manual

1. xstatus xhistory xconfiguration xdirectory xcommand The information in the TANDBERG XML engine is divided into three main types Status Information Configuration Information and Command Information ref the documentation of the TANDBERG XML API As there is a fundamental difference in these three main types of information there is also three different ways of working with the information using XACLI 2 1 3 Addressing XACLI supports XPath for addressing Status Information and Configuration Information In addition there is support for the proprietary TANDBERG SimplePath notation With SimplePath notation an element or a group of elements are addressed by supplying a space separated list of element names elemName and optional element instance numbers item lt elemName gt item lt elemName gt item If the instance number of a given element is omitted the expression addresses all instances of this element Example 2 1 To address the BaudRate sub element of SerialPort 2 XPath SerialPort 2 BaudRate SimplePath SerialPort 2 BaudRate To address the BaudRate sub element of all SerialPort elements XPath SerialPort BaudRate SimplePath SerialPort BaudRate 18 TANDBERG MPS API User Guide 2 1 4 Exposure options By adding an exposure option after the address XPath or SimplePath expression the system can be instructed to return only parts of the information within an element
2. or xconfiguration 2 3 2 Configuration read To read configurations type the configuration type root command followed by an address expression lt configuration type root command address expr gt Example 2 8 User wants to read IP configurations xconfiguration ip cas omiiia He EAST e mites e Ste ates c wg Conmtiguecscion JE Aceresss Wd05 27439 20 se Com Herren dem do SelomecMashkes 2595 2990 2443 0 se meComeu eueiciom ue Ceceweys 10 47 8 1 OR 2 3 3 Configuration set write To set configurations the address expression follovving the configuration type root command must end vvith a colon The value to be set must be added after the colon lt configuration type root command address expr gt value 24 TANDBERG MPS API User Guide Example 2 9 User wants to set IP assignment xconfiguration ip assignment static or xconfiguration ip assignment static 25 TANDBERG MPS API User Guide 2 4 The Command type root commands xcommand To get an overview of the supported commands within a command type root command type or help after the command type root command lt command type root command gt Example 2 10 xcommand User Commands Boot DuoVideoStart MessageBoxDisplay CallAccept DuoVideoStop PIPHide CallMute FECCFocus PIPShov CameraBrightness FECCMove PresetActivate CameraFocus FECCPresetActivat
3. Direction CallRate RemoteNumber Encryption Incoming Outgoing e end e CallStatisticsIP CallRef LogTag ConferenceRef ConferenceLogTag Duration 80 CallSuccessful DiallnError DownspeedingFinished TANDBERG MPS API User Guide Incoming Audio TotalPackets PacketLoss PacketsDropped MaxJitter Video TotalPackets PacketLoss PacketsDropped MaxJitter e end e CallSuccessful CallRef LogTag ConferenceRef ConferenceLogTag ServiceType Protocol Direction CallRate RemoteNumber Encryption Incoming Outgoing e end e DiallnError IncomingNumber RemoteNumber e end e DownspeedingFinished CallRef LogTag ConferenceRef ConferenceLogTag Rate 81 TANDBERG MPS API User Guide e end H320Statistics e H320Statistics CallRef LogTag ConferenceRef ConferenceLogTag Duration FramingLoss Last Total BondingReSync Last Total e end SystemActivity e SystemActivity Service RemotelPAddress Uptime Description e end 82
4. e Description Textual description of the cause code Example xcommand conferencemodify conference 1 agc on floortofull on r Result status 0K r end OK Command used to modify conference settings for a started conference with no active calls Parameters e Conference r lt 1 35 gt e Name S 0 30 gt e CallRate 1xh221 2xh221 64 128 192 256 320 384 H0 512 768 1152 1472 15 36 1920 Tlph Restrict lt On Off gt Password lt S 0 8 gt PassvvordOnOutgoingCalls lt On Off gt Encryption lt On Off gt EncryptionType lt DES AES 128 Auto gt SecondaryRate lt On Off gt WelcomeMessage lt On Off gt DuoVideo lt On Off gt 51 ConferenceStart TANDBERG MPS API User Guide AudioG728 lt On Off gt CascadingPreference lt Auto Master Slave gt BillingCode lt S 0 16 gt CPAutoSwitch lt 0 60 gt Networkld lt 1 32 gt ConferenceSelfview lt On Off gt Protect lt On Off gt TemplateReference lt 1 10 gt HDEnabled lt On Off gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand conferenceredifine conference 1 duovideo on BS Bric SO r Result status OK r end OK Command used to start a new conference Parameters e Conference r lt 1 35 gt e Name lt S 0 30 gt e CallRate l
5. Channels 10 type BChannel status Idle Channels 11 type BChannel status Idle Channels 12 type BChannel status Idle Channels 13 type BChannel status Idle Channels 14 type BChannel status Idle Channels 15 type BChannel status Idle Channels 16 type DChannel status NA Channels 17 type BChannel status Idle Channels 18 type BChannel status Idle Channels 19 type BChannel status Idle Channels 20 type BChannel status Idle Channels 21 type BChannel status Idle Channels 22 type BChannel status Idle Channels 23 type BChannel status Idle Channels 24 type BChannel status Idle Channels 25 type BChannel status Disconnected CallingNumber a ERT 73 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels 26 type BChannel status Disconnected CallingNumber 061336971 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels 27 type BChannel status Disconnected CallingNumber 061336971 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels 28 type BChannel status Disconnected CallingNumber 061336971 CauseLocation 0 ChannelCause 16 ConnectionTime 0 Channels 29 type BChannel status Disconnected CallingNumber 032875677 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels 30 type BChannel status Disconnected CallingNumber CauseLocation 2 ChannelCause 17
6. ISDNInterfaceCard 1 6 G703 Interface 1 8 Call 1 5 StartChannel lt 0 30 gt ISDNInterfaceCard 1 6 G703 Interface 1 8 Call 1 5 MaxChannels lt 0 30 gt ISDNInterfaceCard 1 6 E1 Port 1 8 CRC4 lt On Off gt ISDNInterfaceCard 1 6 T1 Port 1 8 CableLength lt Range1 Range2 Range3 Range4 Range5 gt ISDNInterfaceCard 1 6 Description lt S 0 16 gt LoS Duration Exponent lt 10 30 gt LoS Duration Offset lt 0 65535 gt LoS Inhibit lt 0 65535 gt LoS Initial lt 0 65535 gt 41 MCU MediaBoard NetProfile NTP AllowNTSCCP PrefixDialln QoS TANDBERG MPS API User Guide LoS Polarity lt Positive Negative gt LoS Retry lt 0 65535 gt MCU AdditiveRegEnable lt On Off gt MCU H264 lt On Off gt MCU H264RCDO lt On Off gt MediaBoard 1 12 IP Address lt IPAddr gt MediaBoard 1 12 IP SubnetMask lt IPAddr gt MediaBoard 1 12 IP Gateway lt IPAddr gt MediaBoard 1 12 IP Networkld lt 1 2 gt MediaBoard 1 12 Ethernet Speed lt Auto 10half 10full 100half 100full None gt MediaBoard 1 12 Description lt S 0 16 gt NetProfile 1 7 Name lt S 0 8 gt NetProfile 1 7 CallPrefix lt S 0 9 gt NetProfile 1 Network lt Auto gt NetProfile 2 Network lt H320 gt NetProfile 3 Network lt H323 gt NetProfile 4 Network lt H320 H323 SIP Auto gt NetProfile 5 Network lt H320 H323 SIP Auto gt NetProfile 6 Network lt H3
7. Option s end 528 59 54 de 5623 57 59 B 398 GOE Gils ESCH 5 9 8 64 ES I ed TANDBERG MPS API User Guide 78 TANDBERG MPS API User Guide 5 2 history xml xhistory Call 1 96 Top level attributes e type Tiph Vtlph e protocol H320 H323 SIP e direction Incoming Outgoing e PartOf Conference GatewayCall Summary e Returns information about disconnected calls Examples 1 Call 1 type Vtlph protocol H323 direction 0utgoing PartOf Conference LogTag 4 ConferenceLogTag 2 ConferenceRef 1 RemoteNumber 10 47 12 242 EncryptionIn Off EncryptionOut Off CallRate 384 DisconnectCauseValue 16 DisconnectCause NA Dwicaicsoime 0 UptimeAtEndOfCall 7758 Ban king Coces Ye 1 end Conference 1 20 Top level attributes None Summary e Returns information about ended conferences Examples Conference 1 Log ees I Name CallRate 384 ReSTELOCCS OEE Password INGE AOE eme T Dreem 0 1 end 79 TANDBERG MPS API User Guide 5 3 Event xml xevent AuthenticationFailure CallFURErrorAlert CallMovedFromReception CallStatisticsIP e AuthenticationFailure Service RemotelPAddress Uptime e end e CallFURErrorAlert FURAlert Rate CallRef LogTag ConferenceRef ConferenceLogTag e end e CallMovedFromReception CallRef LogTag ConferenceRef ConferenceLogTag ServiceType Protocol
8. TEOMID Om FullySwitched Off Dynamic Off Eidomaels Om Properties Name TCS Test CallRate 384 Restrict Off Passord PasswordOnOutgoingCalls Off DYMamle z Ox Enersyprlon Wort EncryptionType Auto WelcomeMessage On DuoVideo On AudioG728 On CascadingPreference Auto Salmo Ce cler CPAUBOSVAEG NER PictureMode 4Split VideoFormat Auto CustomFormats On AGC On AllowIncomingCalls On Duration 0 MaxAudioSites 8 MaxVideoSites 40 EntryExitTones On LegacyLevel 0 TelephoneFilter On EO OS IO EE OM WebCallListTimeout Off BandwidthThreshold 128 NetworkId ConferenceSelfview On 68 Ethernet 1 2 Feedback 1 3 TANDBERG MPS API User Guide PhoneIndication On SpeakerIndication On VideoText On VideoTextTimeout 5 laut zeessen OT LectureMode Off Prosa RE VideoCodingMode Transcoding SecondaryRate Off FarTlphEchoSupression Normal NetErrorHandling None IPLRRobustMode Auto FURBlockSites Auto FURFilterInterval 3 HDEnabled Off VoiceSwitchTimeout 2 s end Top level attributes None Summary e Returns MAC Address e Returns Ethernet speed Example s Ethernet 1 MacAddress 00 50 60 7F FA FB Speed 10full s end Top level attributes e status on off Indicates if there are HTTP feedback registered for a given Feedback ID ref command FeedbackRegister Summary e Lists the URL and feedback expressions registe
9. 31 gt Conference 1 35 Numbers PRI lt S 0 60 gt Conference 1 35 Numbers H323ID lt S 0 50 gt Conference 1 35 Numbers SIP URI lt S 0 60 gt ConferenceTemplate ConferenceTemplate 1 10 Name lt S 0 30 gt ConferenceTemplate 1 10 CallRate lt 1xh221 2xh221 64 128 192 256 320 384 H0 512 768 1152 147 2 1536 1920 TIph gt ConferenceTemplate 1 10 Restrict lt On Off gt ConferenceTemplate 1 10 MaxVideoSites lt 0 160 gt ConferenceTemplate 1 10 MaxAudioSites lt 0 16 gt ConferenceTemplate 1 10 Password lt S 0 8 gt ConferenceTemplate 1 10 PasswordOnOutgoingCalls lt On Off gt ConferenceTemplate 1 10 Encryption lt On Off gt ConferenceTemplate 1 10 EncryptionType lt DES AES 128 Auto gt ConferenceTemplate 1 10 PictureMode lt Auto VS 2Split 3Split 4Split 4 3Split 5 1Split 7 1Split 8 2S plitTopBottom 8 2SplitBottomTop 8 2SplitTop 8 2SplitBott om 9Split 12 1SplitCenter 12 1SplitTopLeft 12 2Split 16Spli t 30 2Split 2 1SplitWide 3SplitWide 3 1SplitWide 4 1SplitW ide 6SplitWide 8 1SplitWide 12SplitWide CPAuto gt ConferenceTemplate 1 10 VideoFormat lt Auto Motion Sharpness gt ConferenceTemplate 1 10 CustomFormats lt On Off gt ConferenceTemplate 1 10 AGC lt On Off gt ConferenceTemplate 1 10 TelephoneFilter lt On Off gt ConferenceTemplate 1 10 AllowIncomingCalls lt On Off gt ConferenceTemplate 1 10 Duration lt 0 999 gt 37 Conf
10. AllowlncomingTlphCall EUNTES RTP AllowNTSCCP xb 15542 SerialInterfaceCard sc 61 Conference 1 40 Protocol Session ConferenceTemplat ISDNInterfaceCard SingleNumberDialIn ON Le c 61 Ethernet 1 2 Los SIS ExternalManager MCU SNMP FeedbackFilter MediaBoard 1 12 SSH Gateway NetProfile 1 7 STUN BIS CIS ua DL aa NTP SystemClock H323Gatekeeper 1 2 PrefixDialIn SystemUnit ESTE OOS AZ Telhet OK xdirectory Directory JS Le cs 2501 OR 2 3 1 Configuration help To get help on configurations type the configuration type root command then an address expression followed by 2 or help The possible values for the elements matching the address expression vvill be returned 23 TANDBERG MPS API User Guide lt configuration type root command gt lt address expr gt help Example 2 7 User wants to configure I SE eren Lee a Y h xConfiguration IP Assignment lt DHCP Static gt h xConfiguration IP Address lt IPAddr gt h xConfiguration IP SubnetMask lt IPAddr gt h xConfiguration IP Gateway lt IPAddr gt NOTE Only typing xconfiguration actually addresses all configuration elements within the xconfiguration root command One would therefore expect that help on all configurations would be returned But as described above this is a special case and only listings of the top level elements are returned To get help on all configurations supported by the system type xconfiguration
11. Call 2 status Disconnected type NA protocol NA direction NA logTag NA conferenceRef NA Cause 255 s end 65 TANDBERG MPS API User Guide Conference Top level attributes 1 40 E status NotStarted Started Active Summary Includes references to the calls being connected to the conference DuoVideo status Includes information about the pictures generated by the MultiSite Cascading status MCU Site list On Air information Examples s Conference 1 status NotStarted s end s Conference 1 status Started MEUTD T99 Properties Name Marius sin CallRate 384 BC SIC Quir Password PasswordOnOutgoingCalls Off Dynamic On ID we Enersyprlon Qr EncryptionType Auto WelcomeMessage On DuoVideo On AudioG728 On CascadingPreference Auto E Song Cocks Wy CPAutoSwitch 0 PictureMode VS VideoFormat Auto CustomFormats On AGC On AllowlncomingCalls On Diecdons 0 MaxAudioSites 0 MaxVideoSites 0 EntryExitTones On LegacyLevel 0 TelephoneFilter On Loro Om WebCallListTimeout On BandwidthThreshold 128 Networkld ConferenceSelfview On PhoneIndication On SpeakerIndication On VideoText On VideoTextTimeout 2 Chalco nia OKON LectureMode Off Protect Off VideoCodingMode Transcoding SecondaryRate On 66 FarTl lphEchoSupression TANDBERG MPS API User Guide Normal NetErrorHandling None IPLRRobustMode FURBlockSites Auto
12. ConnectionTime 0 Channels 31 type BChannel PRI 3 ready False State RedAlarm PRI 4 ready False State RedAlarm PRI 5 ready False State RedAlarm PRI 6 ready False State RedAlarm PRI 7 ready False State RedAlarm PRI 8 ready False State RedAlarm G703 1 ready False State RedAlarm G703 2 ready False State RedAlarm G703 3 ready False State RedAlarm G703 4 ready False State RedAlarm G703 5 ready False State RedAlarm G703 6 ready False State RedAlarm G703 7 ready False State RedAlarm G703 8 ready False VWOS2S 7 59 7 1 V TANDBERG MPS API User Guide status Idle 74 ExternalManager NTP SIP s end State RedAlarm s ExternalManager Address ROTOS ol URL tms public external management SystemManagementServ ice asmx s end SNE Address s end xS Se Mode On Interface Server status Active Address 10 47 8 88 Authentication Off Registration DRESSUR Registration URI Yw Registration URT Hi Registration URL m Registration Ur Vu Registration EINE Ww Registration URI Y Registration URT mn Registration URT D Registration UM Tu Registration URIg Tu Registration UE Bun Registration URLS mn Registration URT Wi Registration URT Yw Registration ORT Ww Registration URI TV Registration URT mn Registration URL 5 Registration 1 2 20 TANDBERG MPS API 1
13. Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive 0 status OK User Guide 76 Options Ss Quom 8 Options Key Description MRRX XU telephony ports OPEROR Keyz Description STRES MRRXX MU Opt On Key Description Option Option Option Option Option Option Dep Zem I Opt Lem I Ode domn 1 optiona Dezem I Opciom 1 Deem Option 1 Option 1 Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option Option option Option ens is ta M 4 A OO IR OO ES i EN Un ds 69 RI ES ES oe oc EC COS 69 Jee TES ba bo ba ba Na RO K H Sy Ko 69 ssi em ee Gm CO CO w N CO CO CO CO CO CO Ro CO A CO UI BE Pa Un Gal d ges d d Es d s de dd VO Sy Ney Ce ss ey Su Em 09 bob SS SN SS SS E SS c c e e a ee a SS SS TANDBERG MPS API User Guide 40 video telephony ports 16 Advanced Video Option on 40 Encryption on 40 sites 77 Option Option Option Option option Option Option Option Option Option Option Option
14. On gt ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 10 FURFilterinterval lt 0 60 gt 10 HDEnabled lt On Off gt 10 VoiceSwitchTimeout lt 1 10 gt 10 SecondaryRate lt On Off gt 10 FarTiphEchoSupression 38 Ethernet ExternalManager FeedbackFilter Gateway H323CallSetup H323Gatekeeper TANDBERG MPS API User Guide lt Off Normal High gt ConferenceTemplate 1 10 OptimalVideoQuality lt On Off gt ConferenceTemplate 1 10 EncoderSelectionPolicy lt BestBitRate BestVideoStandard BestResolution gt ConferenceTemplate 1 10 BandwidthManagement lt Manual Auto gt ConferenceTemplate 1 10 WebSnapshots lt On Off gt ConferenceTemplate 1 10 AutoAspectRatio4x3 lt On Off gt Ethernet 1 2 Speed lt Auto 10half 10full 100half 100full None gt ExternalManager Address lt S 0 64 gt ExternalManager Path lt S 0 255 gt FeedbackFilter Conference lt 0 10 gt FeedbackFilter Call lt 0 10 gt Gateway BandwidthPercentage lt 0 100 gt Gateway LoadLimit lt 0 100 gt Gateway NaturalVideo lt On Off gt Gateway CustomFormats lt On Off gt Gateway DuoVideo lt On Off gt Gateway Encryption Mode lt Independent Transparent gt Gateway Encryption H320 lt On Off Auto gt Gateway Encryption H323 lt On Off Auto gt Gateway H264 lt On Off gt Gateway H264rcdo lt On Of
15. and Development Department TANDBERG Philip Pedersen vei 22 1366 Lysaker Norway Tel 47 67 125 125 Fax 47 67 125 234 COPYRIGHT 2007 TANDBERG TANDBERG MPS API User Guide 1 1 Introduction to XML XML is a markup language for documents containing structured information All information elements in an XML document are marked by a tag and a corresponding end tag The end tag has the same name as the tag but is prefixed with a slash All tags are put within angular brackets lt gt Example 1 1 Below is an example of how configurations of a Serial Port could be represented using XML lt Configuration gt lt SerialPort item 1 gt lt BaudRate item 1 gt 9600 lt BaudRate gt lt Parity item 1 gt None lt Parity gt lt DataBits item 1 gt 8 lt DataBits gt lt StopBits item 1 gt 1 lt StopBits gt lt Mode item 1 gt Control lt Mode gt lt SerialPort gt lt Configuration gt From the tree structure of this example we can see that BaudRate Parity Databits StopBits and Mode are properties of the SerialPort We can distinguish between container elements and value elements Container elements contain one or more sub elements while value elements contain a value This is analogous to files and folders on a computer Container elements are folders that can contain sub folders and files while value elements are files containing data In the XML structure for the Serial Port we see that
16. braces are removed in the XACLI format o XACLI is not using end tags except for a tag to mark end of top element 21 TANDBERG MPS API User Guide o XACLI is using indent spaces to present the data structure o XACLI hides instance number item number in XML of an element if there only exist one instance of a given element o A status top level element starts with s Example 2 5 shows XML formatting and XACLI formatting for the same status element IP Example 2 5 XML Seale lise lt IP item 1 gt lt Address item 1 gt 10 47 8 20 lt Address gt lt SubnetMask item 1 gt 255 255 248 0 lt SubnetMask gt lt Gateway item 1 gt 10 47 8 1 lt Gateway gt lt IP gt lt Status gt XACLI wis TE Address 10 47 8 20 Subnet Masia See Gateway 10 47 8 1 s end NOTE To write a parser for the XACLI format the parser must keep track of the levels by counting white spaces The indent is increased by two whitespaces for each level 22 TANDBERG MPS API User Guide 2 3 The Configuration type root commands xconfiguration xdirectory The information accessible through these commands is the exact same information that is available in the corresponding XML documents To get an overview of accessible top level configuration elements type or help after the configuration type root command lt configuration type root command gt Example 2 6 xconfiguration User Contiguraclons
17. five parameters while only the Number parameter is required as specified by the attribute required The value domain for the parameters is referenced by the attribute valueSpaceRef lt Command gt lt Dial item 1 gt lt Number item 1 required True valueSpaceRef ValueSpace RemoteNumber gt lt SubAddress item 1 required False valueSpaceRef ValueSpace SubAddress gt 11 TANDBERG MPS API User Guide lt CallRate item 1 required False valueSpaceRef ValueSpace Bandwidth gt lt Restrict item 1 required False valueSpaceRef ValueSpace OnOff NetProfile item 1 required False valueSpaceRef ValueSpace NetprofileRef Dial lt Command gt To issue a command the command structure is posted back to the system together with values for the various parameters Optional parameters can be omitted when posting the structure back to the system Example 12 To place a call to number 999 the user can simply post the following XML structure to the system lt Command gt lt Dial item 1 gt Number item 1 gt 999 lt Number gt lt Dial gt lt Command gt When issuing Commands the system will return an XML structure in response The response structure will have the same name as the command issued but it will be post fixed with Result All commands will have an attribute named status stating whether the command was accepted or not If a command i
18. gt lt Parity item 1 gt None lt Parity gt lt DataBits item 1 gt 8 lt DataBits gt TANDBERG MPS API User Guide StopBits item 1 gt 1 lt StopBits gt Mode item 1 gt Auto lt Mode gt lt SerialPort gt lt Configuration gt TANDBERG MPS API User Guide 1 2 Introduction to XML Path Language XPath XPath is a comprehensive language to address data in XML documents It is though very simple to understand the basics If you are able to specify the path to a file on your computer you are able to specify the path to an element in a XML structure Example 1 5 Let us go back to the serial port configurations of Example 1 1 lt Configuration gt lt SerialPort item 1 gt lt BaudRate item 1 gt 9600 lt BaudRate gt lt Parity item 1 gt None lt Parity gt sparato imiten AN Dara ud P lt StopBits item 1 gt 1 lt StopBits gt lt Mode item 1 gt Control lt Mode gt lt SerialPort gt lt Configuration gt To specify the path to the SerialPort element we simply start at the root level and separate the levels in the tree structure by a slash Configuration SerialPort The path to the BaudRate element is Configuration SerialPort BaudRate Example 1 6 To address a specific item of an element the item number is added within brackets IT after the element name The path to the BaudRate element of SerialPort item 2 in Example 1 4 is Configuration SerialPort 2 BaudRate If the item numbe
19. only when the call is in Synced state By registering the below expression the system will not provide feedback on the call before it reaches the Synced state When it first enters the Synced state it will provide status for the complete call After this the system will only give feedback on elements changing values provided that the call is still in Synced state xfeedback register status call fstatus Synced OK xcom dial 10 47 15 127 r Result status 0K Call l aemes I HOG teles 5 r end OR CONNEC s Call 1 status Synced type Vtlph protocol H323 direction Outgoing CallRate 768 RemoteNumber 10 47 15 127 Mute Off Microphone Off Duration 0 Channels 1 type Incoming Rate 768 RES Bac S T Encryption status Off Audio status Active Protocol G722 Rate 64 Video 1 status Active Pirorocols 203 Resolution CIF Rate 704 Video 2 status Inactive Data status Inactive Channels 2 type Outgoing 32 TANDBERG MPS API User Guide Rate 768 REIS Brat PE OEE Encryption status 0ff Audio status Active Protocol G722 Rate 64 Video 1 status Active Protocol EH sis Resolution ICIF Rate 704 Video 2 status Inactive Data status Inactive s end suddenly there is a change in audio protocol s Call 1 status Synced type Vtlph protocol H323 direction Outgoing Channels 1 type Incoming Rate 704 Audi
20. then the documents putxml REQUEST putxml PARAM HTTP BODY as argument Putxml is like formputxml put uses the complete BODY as argument i e the content of the xmldoc parameter The Content type should be text xml or application xml or text plain though no check at the moment Except for application x www form urlencoded this will cause a failure 14 TANDBERG MPS API User Guide 1 6 Exercises The exercises in this section are based on using a TANDBERG 6000 MXP codec and Microsoft Internet Explorer Some of the examples may however also apply to other systems and other browsers NOTE Replace the ip address 10 47 8 41 in the below examples with the ip address of your system Exercise 1 The example in this exercise shows how to read the supported XML documents from the system using a web browser Enter the following address in the browsers address field http 10 47 8 41 status xml http 10 47 8 41 history xml http 10 47 8 41 configuration xml http 10 47 8 41 directory xml http 10 47 8 41 command xml http 10 47 8 41 valuespace xml Exercise 2 This exercise shows how to use getxml to read the supported XML documents from the system Enter the following expressions in the browsers address field NOTE The first letter in the document names is uppercase http 10 47 8 41 getxml location Status http 10 47 8 41 getxml location History http 10 47 8 41 getxml location Configuration h
21. 0 471 10 WAT 6 Os LY status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive User Guide 75 SystemLoad SystemClock SystemActivity s end SG SYSE s end SS Syst E R S s end SS SE s end URT Vu Registration URI g ww Registration EISE Registration URI 7 Registration URE 5 Registration Umm Registration DTE Registration URT Un Registration URT m Registration URL m Registration URTg Yw Registration URI g ww Registration URT n Registration URT Hi Registration URE Registration Uem Registration URIg w Registration URT m5 Registration URT m Registration URE Registration Unie Ww emLoad 2 emClock EE suilt 22 23 24 25 26 2 28 219 30 31 32 ER 34 85 36 S 38 80 40 Configuration Used 1 ate 2048 tate Josue RI emActivity allsActive 2 TANDBERG MPS API status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status Inactive status
22. 20 H323 SIP Auto gt NetProfile 7 Network lt SIP gt NTP Address lt IPv4v6Addr 0 43 gt AllowNTSCCP lt On Off gt PrefixDialln AdHoc H323ID lt S 0 50 gt PrefixDialln AdHoc H323Alias lt E164 0 31 gt PrefixDialln DID H323ID lt S 0 50 gt PrefixDialln DID H323Alias lt E164 0 31 gt QoS 1 2 Precedence Telephony Audio lt 0 1 2 3 4 5 6 7 Auto Off gt 42 RTP SeriallnterfaceCard Session TANDBERG MPS API User Guide QoS 1 2 Precedence Telephony Signalling lt 0 1 2 3 4 5 6 7 Auto Off gt QoS 1 2 Precedence VideoTelephony Audio lt 0 1 2 3 4 5 6 7 Auto Off gt QoS 1 2 Precedence VideoTelephony Signalling lt 0 1 2 3 4 5 6 7 Auto Off gt QoS 1 2 Precedence VideoTelephony Video lt 0 1 2 3 4 5 6 7 Auto Off gt QoS 1 2 Precedence VideoTelephony Data lt 0 1 2 3 4 5 6 7 Auto Off gt QoS 1 2 Diffserv Telephony Audio lt 0 63 gt QoS 1 2 Diffserv Telephony Signalling lt 0 63 gt QoS 1 2 Diffserv VideoTelephony Audio lt 0 63 gt QoS 1 2 Diffserv VideoTelephony Signalling lt 0 63 gt QoS 1 2 Diffserv VideoTelephony Video lt 0 63 gt QoS 1 2 Diffserv VideoTelephony Data lt 0 63 gt QoS 1 2 Mode lt Precedence Diffserv Off gt QoS 1 2 ToS MinDelay MaxThrough MaxReliable MinCost Off RTP MTU lt 1200 1400 gt SeriallnterfaceCard 1 6 Port 1 32 Callcontrol RS366Adtran Dial Manual SeriallnterfaceCard 1 6 Port 1
23. 32 Clocking lt Dual Single gt SeriallnterfaceCard 1 6 Port 1 32 DTRPulse lt On Off gt SeriallnterfaceCard 1 6 Port 1 32 Bandwidth lt 64 128 192 256 320 384 512 768 1152 1472 1536 1920 gt SeriallnterfaceCard 1 6 Port 1 32 Restrict lt On Off gt SeriallnterfaceCard 1 6 Port 1 32 Clocking lt Dual Single Internal gt SeriallnterfaceCard 1 6 Description lt S 0 16 gt SeriallnterfaceCard 1 6 InternalBandwidth lt 64 128 192 256 320 384 512 768 1152 1472 1536 1920 gt TimeOut lt 0 65534 gt 43 SingleNumberDialln SIP SNMP SSH STUN SystemClock SystemUnit TANDBERG MPS API User Guide SingleNumberDialln Active lt On Off gt SingleNumberDialln Numbers ISDN lt S 0 60 gt SingleNumberDialln Numbers IP lt S 0 60 gt SingleNumberDialln Numbers H323Alias lt E164 0 31 gt SingleNumberDialln Numbers H323ID lt S 0 50 gt SingleNumberDialln Numbers SIP lt S 0 60 gt SingleNumberDialln Password lt On Off gt SingleNumberDialln NumberOfLoginTries lt 1 10 gt SingleNumberDialln WaitingRoomTimer lt 1 60 gt SIP Mode lt On Off gt SIP Interface Server Address lt S 0 255 gt SIP Interface Server Type lt Auto Nortel Microsoft Cisco Alcatel Experimental gt SIP Interface Authentication UserName lt S 0 80 gt SIP Interface Authentication Password lt S 0 60 gt SIP Interface Transport Default lt TCP UDP gt SNMP Mode lt On
24. 60 gt 2Xh221 second number SubAddress S 0 60 Sub address CallRate 1xh221 2xh221 64 128 192 256 320 384 H0 512 768 1152 1472 15 36 1920 Tlph gt Specifies the callrate to use Restrict lt On Off gt NetProfile lt 1 7 gt Networkld lt 1 32 gt NetworkModule lt 1 12 gt DTMFSend S 0 325 OK Result parameters e Caller lt 1 96 gt Reference to the call To be used as reference when monitoring the call e LogTag 1 Unique reference to call Identifies the call in the call log ERROR Result parameters e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code Example xcommand dial number 666 callrate 256 netprofile 3 r Result status 0K Callies 26 LogTag 312 r end 54 DialGroupEntry DiallnNumberAdd DiallnNumberRemove TANDBERG MPS API User Guide OK Command used to dial an entry from the Group Directory Dialing from the Group Directory makes it possible to set up a MultiSite conference in one operation Parameters e Conference r lt 1 35 gt e GroupEntryld r lt 1 16 gt Reference to the directory entry to be dialed OK Result parameters The system will return the following elements for each call initiated e CallRef lt 1 96 gt Reference to the call To be used as reference when monitoring the call e LogTag 1 Unique reference to call Identifies th
25. 8 gt Reference to the call to be muted or unmuted e Mode r lt On Off gt Denotes whether the call is to be muted or unmuted OR Result parameters None ERROR Result parameters 48 CallMuteOutgoing CallTransfer CallTransferToDirEntry TANDBERG MPS API User Guide e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand callmute call 2 mode on r Result status 0K r end OK Command used to mute outgoing audio from a specific call Parameters e Call r lt 1 128 gt Reference to the call to be muted or unmuted e Mode r lt On Off gt Denotes whether the call is to be muted or unmuted OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand CallMuteOutgoing call 2 mode on r Result status 0K r end OK Command used to transfer the H 323 party of a Gateway call to another H 323 party Parameters e GatewayCall r lt 1 80 e Number r S 0 605 ERROR Result parameters e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code Command used to transfer the H 323 party of a Gateway call to a H 323 directory entry in the local phone book P
26. 8796 lt RemoteNumber gt lt RemoteNumber item 2 gt lt RemoteSubAddress item 1 gt Mute item 1 gt 0ff lt Mute gt Microphone item 1 gt 0ff lt Microphone gt lt LogTag item 1 gt 25 lt LogTag gt lt Channels item 1 type Incoming gt lt Rate item 1 gt 384 lt Rate gt lt ReSt ler cen db or RESTELO lt A pto nen MS Sais Or gt lt Audio item 1 status Active gt Protocol item 1 gt G722 lt Protocol gt lt Rate item 1 gt 56 lt Rate gt lt Audio gt lt Calis lt Call item 6 status Disconnected type NA protocol NA direction NA gt Cause ticem i S255 lt Cause gt Cali gt In the above example we see that the Bonding element RemoteNumber 2 and SubAddress is not present for H323 calls On the other hand for H323 calls the Audio channel element holds information regarding packet loss etc which is not present for H320 calls If the call is disconnected the Ca11 element only contains the disconnect cause value 1 4 3 Configuration documents rw The structure of the Configuration documents is independent of system state i e the structure will be constant in time In addition to holding the values for the various configurations each configuration value element includes an attribute valueSpaceRef referencing the value domain for the configuration 10 TANDBERG MPS API User Guide Example 10 From the XML structure below we see that the BaudRate elem
27. Audio status Active Deococols AG TD Rate 64 evel 0 RemoteIPAddress oc LIP Address RO AO LS EI ES BV ON Seems OnE E ES WIES Oig ag RSVPRate 0 DynamicRate 64 TotalPackets 801748 PacketLoss O0 newer 0 Video 1 status Active Protocol H264 Resolution SIF Rate 160 RemoteIPAddress 64 TANDBERG MPS API User Guide LocalIPAddress 10 47 9 150 2344 Encryption status 0ff INSWIPs OTE RSVPRate 0 DynamicRate 157 TotalPackets 476674 PacketLoss 1 dt o LO Video 2 status Active Beococeols 1203 Resolution XGA Rate 160 RemoteIPAddress LocalIPAddress 10 47 9 150 2346 EE ENEE EE ESB O fits RSVPRate 0 DynamicRate 72 TotalPackets 161681 PacketLoss O0 gabe 27 Data status Inactive Channels 2 type Outgoing Rate 384 Rescedets Quer Encryption status Off Audio status Active Protocolli ANC ILID Rate 64 RemoteIPAddress 10 47 20 20 2334 IO SOREA GIS ES Sk WW 4 7 95 15082 42 W Encryption status Off ROVE MOTE RSVPRate 0 DynamicRate 64 TotalPackets 801652 PacketLoss 1 Opis teste 3 0 Video 1 status Active Protocol H264 Resolution CIF Rees 320 RemoteIPAddress 10 47 20 20 2336 LocalIPAddress 10 47 9 150 2344 Encryption status Off ESB O la RSVPRate 0 DynamicRate 164 TotalPackets 259599 PacketLoss 0 Vaktene y Video 2 status Inactive Data status Inactive s end s
28. Inactive s end Request for Call 1 element with exposure option xstatus call 1 s Call 1 status Synced type Vtlph protocol H323 direction Outgoing s end 2 1 5 Misc The XACLI interface is not case sensitive XACLI allows using only partial names 20 TANDBERG MPS API User Guide 2 2 The Status type root commands xstatus xhistory The information accessible through these commands is the exact same information that is available in the corresponding XML documents To get an overview of accessible top level elements within a status type root command type or help after the status type root command Example 2 3 xstatus Seacus Call 1553981 MediaBoard 1 12 Conference 1 40 NTP Ethernet Options ExternalManager SerialInterfaceCard 1 6 Feedback 1 3 STE GatewayCall 1 80 SystemActivity H323Gatekeeper SystemClock ME SystemLoad ISDNInterfaceCard 1 6 SystemUnit OK To access status type data simply type the status type root command xstatus or xhistory and then an XPath address expression or a TANDBERG SimplePath expression lt status type root command gt lt address expression gt Example 2 4 xstatus call 1 remotenumber s Call 1 status Synced type Vtlph protocol H323 direction Outgoing RemoteNumber 10 47 15 127 s end OK 2 2 1 Format Status information is presented by a mark up notation similar to XML Main differences o all
29. MORELL eere we Terence olle HDEnabled Off VoiceSwitchTimeout OptimalVideoQuality Auto 3 2 On Off EncoderSelectionPolicy BestBitRate BestVideoStandard BandwidthManagement Auto Manual WebSnapshots On Off AutoAspectRatio4x3 Off s end e Conrerenes 1 status Active Calls Gecttzeug ko 2 Caller 23 2 CARRS 35 3 DuoVideo status 0ff Floor None Current CMRE NEN Previous Galles 2 OutgoingPicture 1 name Current Layout type 5 1Split window 1 Picture RemoteMain Galles 2 Window 2 Picture RemoteMain Callas 2 Window 3 Picture RemoteMain CallRef 1 Window 4 Picture NA CallRef None Window 5 Picture NA CallRef None Window 6 Picture NA CallRef None OutgoingPicture 2 name Previous Layout type 5 1Split Window 1 Picture RemoteMain Calles 2 Window 2 Picture RemoteMain CMRE ceS Window 3 Picture RemoteMain CallRef 1 Window 4 Picture NA CallRef None Window 5 67 TANDBERG MPS API User Guide Picture NA CallRef None Window 6 Picture NA CallRef None OutgoingPicture 3 name Duo Layout type NA PictureModeActual Full MEU ell CascadingMode StandAlone MCUSiteList Sitemi MCUID 1 Termina MDETZ2 Name Systemi CallRef 1 Site 2 JCDS 4 TerminalID 3 Name System2 CallRef 2 Sitelo JMCDS 34 TerminalID 4 Name System3 CNREE
30. Off ReadOnly TrapsOnly gt SNMP CommunityName lt S 0 16 gt SNMP SystemContact lt S 0 70 gt SNMP SystemLocation lt S 0 70 gt SNMP HostlPAddr 1 3 lt IPv4v6Addr 0 43 gt SSH Mode lt On Off gt STUN Server Address lt S 0 255 gt SystemClock Port lt 0 32 gt Name lt S 0 50 gt Password lt S 0 16 gt ResourceManagement lt On Off gt ResourceManagementPercent lt 0 100 gt 44 TANDBERG MPS API User Guide DefaultIpConference lt 0 15 gt TerminalSyncLossTimer lt 5 90 gt GatekeeperAdhocString lt S 0 10 gt TrafficShaping lt On Off gt OutbandDTMF lt On Off gt LanguageAdmin lt S 0 3 gt LanguageGraphic lt S 0 3 gt DefaultConferenceTemplate lt 1 10 gt Telnet Telnet Mode lt On Off gt The Gateway LoadLimit command will not be available if 1 MPS doesn t have GW option 2 MPS have MCU and GW option 45 TANDBERG MPS API User Guide 3 2 directory xml xdirectory LocalEntry GroupEntry LocalEntry 1 250 Name lt S 0 48 gt LocalEntry 1 250 Number lt S 0 60 gt LocalEntry 1 250 SecondNumber lt S 0 60 gt LocalEntry 1 250 SubAddress lt S 0 60 gt LocalEntry 1 250 CallRate lt 1xh221 2xh221 64 128 192 256 320 384 512 768 1152 1472 1920 Tlph H0 Max Auto gt LocalEntry 1 250 Restrict lt On Off gt LocalEntry 1 250 NetProfile lt 1 7 gt LocalEntry 1 250 Networkld lt 1 32 gt LocalEn
31. SplitTop 8 2SplitBottom 9Split 12 1Spl itCenter 12 1SplitTopLeft 12 2Split 16Split 30 2Split 2 1SplitWide 3 SplitWide 3 1SplitWide 4SplitWide 4 1SplitWide 6SplitWide 8 1Split Wide 12SplitWide CPAuto e VideoFormat lt Auto Motion Sharpness gt e CustomFormats lt On Off gt e AGC lt On Off gt AllowIncomingCalls lt On Off gt Duration lt 0 999 gt MaxAudioSites lt 0 16 gt MaxVideoSites lt 0 160 gt 50 ConferenceRedefine TANDBERG MPS API User Guide EntryExitTones lt On Off gt LegacyLevel lt 0 15 gt TelephoneFilter lt On Off gt FloorToFull lt On Off gt BandwidthThreshold lt 64 128 192 256 320 384 512 768 1152 1472 1920 gt WebCallListTimeout lt On Off gt Phonelndication lt On Off gt Speakerlndication lt On Off gt VideoText lt On Off Auto gt VideoTextTimeout lt 0 30 gt ChairControl lt On Off gt LectureMode lt On Off gt NetErrorHandling lt IPLR FURBlock None gt IPLRRobustMode lt Auto On gt FURBlockSites lt Auto On gt FURFilterinterval lt 0 60 gt VoiceSwitchTimeout lt 1 10 gt FarTiphEchoSupression lt Off Normal High gt OptimalVideoQuality lt On Off gt EncoderSelectionPolicy lt BestBitRate BestVideoStandard BestResolution gt e BandwidthManagement lt Manual Auto gt e WebSnapshots lt On Off gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system
32. TANDBERG API This document is a guide to the API interface of the TANDBERG MPS products All rights reserved This document contains information that is proprietary to TANDBERG No part of this publication may be reproduced stored in a retrieval system or transmitted in any form or by any means electronically mechanically by photocopying or otherwise without the prior written permission of TANDBERG Nationally and internationally recognized trademarks and trade names are the property of their respective holders and are hereby acknowledged Disclaimer The information in this document is furnished for informational purposes only is subject to change without prior notice and should not be construed as a commitment by TANDBERG The information in this document is believed to be accurate and reliable however TANDBERG assumes no responsibility or liability for any errors or inaccuracies that may appear in this document nor for any infringements of patents or other rights of third parties resulting from its use No license is granted under any patents or patent rights of TANDBERG This document was written by the Research and Development Department of TANDBERG Norway We are committed to maintaining a high level of quality in all our documentation Towards this effort we welcome your comments and suggestions regarding the content and structure of this document Please fax or mail your comments and suggestions to the attention of Research
33. TANDBERG MPS API User Guide 1 4 The XML Documents 1 4 1 Documents The XML Data in the TANDBERG systems are divided into three main types of documents The division is based on whether the information is Read Information Write Information or Read Write information 1 Status documents r Documents holding all available Status Information in the system Supported documents a status xml b history xml 2 Configuration documents rw Documents holding all system configurations Supported documents a configuration xml b directory xml 3 Command documents w Documents defining the supported system commands used to initiate system processes This is write data i e the parameter values for a given command are defined by the user and posted to the system The posted values will not be returned when reading the document from the system Reading a command document from the system returns descriptions of the supported commands with empty parameter values Supported documents a command xml 4 Meta Documents Meta documents contain information that can be referenced by other documents e g value domains of configurations or command parameters Supported Meta Documents a valuespace xml 1 4 2 Status Documents r The Status Documents are characterised by an extensive use of XML attributes In addition to holding information the attributes are used to reflect the structure of the sub elements which are dependent on the state of th
34. TANDBERG MPS API User Guide TANDBERG D13639 Rev 07 March 2008 TANDBERG MPS API User Guide Table of Contents BETZEEDU IH 1 Ix BIdicsum 1 1 1 Introductionto XML A ae anne an aaa erden een enden 2 1 2 Introduction to XML Path Language Pat 5 1 3 The TANDBERG XML Engine sorornnrrrnavrrnnnvnnnnvverorrrrsnnvnrrnnvensvvensavnssnnvnnsnnvessarnssnnnsnsnvnnnr 7 1 4 The XML Documents Aen 9 1 5 Introduction to TANDBERG XML API Service TTXAG rena na 14 EE Ee eege e Ee ee 15 2 The XML based Advanced Command Line Interface mssmsssrsssrsrarsrsrsrssrsrsrsrsrnrsr rr rr sr norr ror arna 17 See ee 18 2 2 The Status type root commands xstatus XNIStOrY ssesrsesrsssrsssersssrsssrssnrsnnrsnnr snaran 21 2 3 The Configuration type root commands xconfiguration xdirectory 23 2 4 The Command type root commands veommand sss 26 2 5 XML Output xgetxml E 29 2 6 Special Commands en 30 3 API Configurations x 2 caddie ien een 36 3 1 configuration xml xconfiguration sssssssssseeeeeenenneeennenn enne 37 3 2 directory xml XdireCtOry rettet iet e re aca da 46 SE een Le ET 47 4 1 command xml xcommand sss enne ener entr nnne ARR RR Rn nn 48 NESCIT Rn ehe 63 5 1 status xml ET 64 5 2 history xml XNIStONY u e een 79 EE E En LE 80 TANDBERG MPS API User Guide 1 The
35. a very flexible interface both optimized for machine machine interaction and man machine interaction It is based on the powerful TANDBERG XML engine and offers many of the same features as the TANDBERG XML interface The main distinction between XACLI and the TANDBERG XML interface is the input format As XACLI is a command line interface all inputs from the user control application have to be put on one line in opposite to the XML interface where a complete XML document can be posted to the system in one operation A basic understanding of the information structuring in the TANDBERG XML engine is important in order to get the most out of the XACLI interface It is therefore recommended to read the documentation of the TANDBERG XML API prior to reading this section 17 TANDBERG MPS API User Guide 2 1 XACLI 2 1 1 Accessing XACLI XACLI can be accessed through Telnet via the LAN interface or through RS 232 by connecting a serial cable to the serial interface connector referred to as the Dataport 48 Telnet sessions can be active at the same time in addition to the RS 232 connection 2 1 2 Root commands For each of the XML documents supported by the system there is a corresponding XACLI root command The root command has the same name as the corresponding XML document except that the root command is prefixed by an x XML document status xml history xml configuration xml directory xml command xml XACLI root command
36. arameters e GatewayCall r lt 1 80 gt e DirectoryEntry r lt 1 99 gt ERROR Result parameters e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code 49 CallMuteVideo ConferenceDisconnect ConferenceModify TANDBERG MPS API User Guide Command used to mute incoming video from a specific call Parameters e Call r lt 1 128 gt Reference to the call to be muted or unmuted e Mode r lt On Off gt Denotes whether video is to be muted or unmuted OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand callmutevideo call 2 mode on r Result status 0K r end OK Command used to disconnect all calls in a conference Parameters e Conference r lt 1 12 gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommmand conferencedisconnect conference l r Result status 0K r end OK Command used to modify conference settings Parameters e Conference r lt 1 35 gt e PictureMode lt Auto VS 2Split 3Split 4Split 4 3Split 5 1Split 7 1Split 8 2SplitTopB ottom 8 2SplitBottomTop 8 2
37. ation can both be supplied and read by the user F ex default callrate baudrate of a serial port enabling disabling of various features etc All configuration information is structured in a hierarchy making up a database of System settings But for the Configuration information the data in the database can only be updated by the user control application 1 3 2 Addressing using XPath To address information in the hierarchic structure of Status and Configuration information the TANDBERG systems support abbreviated XML Path Language XPath This allows the user control application to address everything from a single element of data f ex the callrate of a specific call to larger parts of the hierarchy f ex all information available for a given call The structuring of information together with XPath for addressing makes up powerful features like searching and setting of multiple instances of a configuration 1 3 3 Feedback Feedback is an extremely powerful feature where the TANDBERG system actively returns updated status and configuration information to the user control application whenever changes occur The user control application can specify what parts of the status and TANDBERG MPS API User Guide configuration hierarchies it wants to monitor by using XPath The user control application can therefore limit the amount of information it receives from the target system to only those parts being of interest for the given application
38. d to show remaining time of conference Parameters e Conference r lt 1 15 gt e Time r lt 1Min 5Min 10Min Off gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code Command used to terminate a conference Parameters e Conference r lt 1 35 gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand ConferenceTerminate conference l r Result status 0K 53 DefaultValuesSet Dial TANDBERG MPS API User Guide r end OK Command used to reset configurations to default values Parameters e Level 1 3 Configurations are divided into three different storage classes The level parameter denotes that configurations on this level and all levels below are to be reset OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand defaultvaluesset level 2 r Result status 0K r end OK Command used to initiate an outgoing call Parameters e Conference r lt 1 35 gt Number S 0 60 gt Number to dial SecondNumber S 0
39. detail level equal to or less than the detaillevel defined for the interface will be listed Example 2 24 xstat call 1 channels 1 audio s Call 1 status Synced type Vtlph protocol H323 direction Outgoing Channels 1 type Incoming Audio status Active PROTOCOL 6722 Rate 64 s end OK xpreferences detaillevel 2 OK xstat call 1 channels 1 audio s Call 1 status Synced type Vtlph protocol H323 direction Outgoing logTag 3 Channels 1 type Incoming Audio status Active Preococols Cie Rate 64 RemotelPAddress Tocat B Ademess eO E Encryption status On Type AES 128 EISE Oicie RSVPRate 0 DynamicRate 64 TotalPackets 1618 PacketLoss 0 Jitter 10 s end OK xpreferences xmlconfigfeedback lt on off gt If xmiconfigfeedback is set to on feedback on configurations will be returned in XML format instead of the standard XACLI configuration format Example 2 25 XACLI format c xConfiguration SerialPort 1 BaudRate 2400 XML format lt Configuration gt SerialPort item 1 gt 34 TANDBERG MPS API User Guide lt BaudRate item 1 gt 2400 lt BaudRate gt lt SerialPort gt lt Configuration gt xpreferences xmlstatusfeedback on off If xmistatusfeedback is set to on all status feedback will be returned in XML format instead of the standard XACLI status format Example 2 26 XACLI format s Call 1 status Synced type Vtlph protocol H323 direction O
40. e DISC SCIC OC CameraHalt IS C Eme seis 9e ScreensaverActivate CameraMove FECCRequestStill ScreensaverDeactivate CameraPosition FECCSelectSource ScreensaverReset CameraTrackingStart FeedbackDeregister SiteDisconnect CameraTrackingStop FeedbackRegister SiteView CameraWhiteBalance FloorRelease SiteViewEnd ChairRelease FloorRequest SPIDAutoConfigure ChairTake FloorToSite StillImageSend ConferenceDisconnect FloorToSiteEnd StreamingStart DefaultValuesSet GroupEntryAdd StreamingStop Dial GroupEntryDelete TextDelete DialGlobalEntry ocalEntryAdd TextDisplay DialGroupEntry ocalEntryDelete VirtualMonitorReset DialLocalEntry DisconnectCall OK MessageBoxDelet VirtualMonitorSet To list usage for all commands with parameters type a double question mark after the command type root command lt command root command gt Example 2 11 xcommand 2 4 1 Command help To get help on a specific command type the command type root command then a command name followed by or help lt command type root command gt lt command name gt 26 TANDBERG MPS API User Guide Example 2 12 xcommand Dial h xCommand Dial Number ig 8 SS I 20 SubAddress lt S 0 10 gt Callarse lt ld0221 2 41221 04 123 2300 0 0 Restrict lt Om OEN Ner jrorilegs lt i 36 gt OK NOTE Required parameters are identified by an r behind the parameter name 2 4 2 Issuing a command A command must start
41. e call e LogTag 1 Unique reference to call Identifies the call in the call log ERROR Result parameters e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code Example xcommand diallocalentry localentryid 15 r Result status 0K CallRef 1 LogTag 312 r end OK Command used to disconnect a call Parameters e Call r lt 1 176 gt Reference to the call to be disconnected OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand disconnectcall call 9 r Result status 0K r end OK Command used to disconnect a gateway call Parameters e GatewayCall r lt 1 80 gt Reference to the call to be disconnected OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not 56 FeedbackDeregister FeedbackRegister TANDBERG MPS API User Guide accepted by the system e 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 e ID lt 1 3 gt ID for the registration to deregister OK Result parameters e ID 1 3 ERROR R
42. e call in the call log ERROR Result parameters e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code Example xcommand dialgroupentry conference 1 groupentryid 19 r Result status 0K Canillas 2 Togkag s SS CallRef 1 LogTag 312 CallRef r end OK Command used to add a dial in number Parameters e Conference r lt 1 15 gt e NetProfile r lt 2 7 gt e Number r lt S 0 60 gt e Callerld S 0 60 gt ERROR Result parameters e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code Command used to remove a dial in number Parameters e Conference r lt 1 15 gt e NetProfile r lt 2 7 gt e Number r S 0 60 gt e Callerld S 0 60 gt ERROR Result parameters 55 DialLocalEntry DisconnectCall DisconnectGWCall TANDBERG MPS API User Guide e Cause 1 Cause code specifying why the call was not accepted by the system e Description Textual description of the cause code Command used to dial a number from the locally stored directory Parameters e Conference r lt 1 35 gt e LocalEntryld r lt 1 99 gt Reference to the directory entry to be dialed OK Result parameters e Caller lt 1 96 gt Reference to the call To be used as reference when monitoring th
43. e system Example 9 The element ca11 will contain different sub elements depending on the call state call type or direction Call item 1 status Synced type Vtlph protocol H323 direction Outgoing gt lt CallRate item 1 gt 768 lt CallRate gt lt RemoteNumber item 1 gt 58458 lt RemoteNumber gt Mute item 1 gt 0ff lt Mute gt Microphone item 1 gt 0ff lt Microphone gt leet den liten 11 15 lt Dur dticons lt Channels item 1 type Incoming gt Rate item 1 gt 768 lt Rate gt lt sR strilot icon UND Orr RSS Pre lt Encryption item 1 status 0ff gt lt Audio item 1 status Active gt PEEL item Jl SE 7120 lt PELOS Rate item 1 gt 64 lt Rate gt TANDBERG MPS API User Guide RemoteIPAddress item 1 gt lt LocallPAddress item 1 gt 10 47 8 41 2326 lt LocalIPAddress gt Encryption item 1 status 0n gt Type item 1 gt AES 128 lt Type gt lt Encryption gt lt RSVP item 1 gt 0ff lt RSVP gt lt RSVPRate item 1 gt 0 lt RSVPRate gt lt DynamicRate item 1 gt 64 lt DynamicRate gt lt TotalPackets item 1 gt 367 lt TotalPackets gt lt PacketLoss item 1 gt 0 lt PacketLoss gt lt JIitter alpes 3 0 2 00 ee EE lt Audio gt lt Call gt Call item 2 status Synced type Vtlph protocol H320 direction Outgoing gt lt CallRate item 1 gt 384 lt CallRate gt lt Bonding item 1 gt On lt Bonding gt lt RemoteNumber item 1 gt
44. end Top level attributes e status on off Summary 44a00003 TANDBERG MPS API User Guide SIS SV MEP 20 System Como lese WEPEBUGN 2 3 0 0 384 0 0 2 O 384 0 e Returns information about the Serial interface card Example e Serlallimeerraceleido 1 Description s end s ISDNInterfaceCard 1 Description PRI L ready True BChannelsTotal BChannelsFree 20 28 HOChannelsFree 4 1 2 3 Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels Channels 19 Channels 20 Channels 21 Ro JOY Cn 89 lt I Or us 69 DIT O type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type BChannel type DChannel type BChannel type BChannel type BChannel type BChannel ai un ER mh eu x A zn ER SE type BChannel UN status Off status 0n status Idle status Idle status Idle status Idle status Idle status Idle status Idle status Idle status Idle status Idl status Idle status Idle status Idle status Idle status Idle status NA status Idle stat
45. ent of SerialPort 1 is configured to 9600 The BaudRate element references the SerialPortBaudrate element in the ValueSpace document showing the value domain for this configuration lt Configuration gt gt lt SerialPort item 1 gt lt BaudRate item 1 valueSpaceRef ValueSpace SerialPortBaudrate item 1 gt 9600 lt BaudR ate gt lt SerialPort gt lt Configuration gt lt ValueSpace gt lt SerialPortBaudrate item 1 type Literal gt lt Value gt 1200 lt Value gt lt Value gt 2400 lt Value gt lt Value gt 4800 lt Value gt lt Value gt 9600 lt Value gt lt Value gt 19200 lt Value gt lt Value gt 38400 lt Value gt lt Value gt 57600 lt Value gt lt Value gt 115200 lt Value gt lt SerialPortBaudrate gt lt ValueSpace gt To change configurations the part s of the document containing the configurations to be updated should be posted back to the system with the new values This will be described thoroughly in a later section 1 4 4 Command documents w Command documents contain descriptions of the supported commands for the system A Command consists of a Command name and a set of Command parameters The parameter elements have attributes to denote whether the parameter is optional or required in a addition to referencing the value domain for the given parameter Command parameters do not contain any values when read from the system Example 11 The command Dial is defined to take
46. erenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 lt Auto Master Slave gt ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 ConferenceTemplate 1 TANDBERG MPS API User Guide 10 EntryExitTones lt On Off gt 10 WelcomeMessage lt On Off gt 10 LegacyLevel lt 0 15 gt 10 DuoVideo lt On Off gt 10 AudioG728 lt On Off gt 10 CascadingPreference 10 BillingCode S 0 16 gt 10 CPAutoSwitch lt 0 60 gt 10 FloorToFull lt On Off gt 10 WebCallListTimeout lt On Off gt 10 Networkld lt 1 32 gt 10 ConferenceSelfview lt On Off gt 10 Phonelndication lt On Off gt 10 Speakerlndication lt On Off gt 10 VideoText lt On Off Auto gt 10 VideoTextTimeout lt 0 30 gt 10 ChairControl lt On Off gt 10 LectureMode lt On Off gt 10 Protect lt On Off gt 10 BandwidthThreshold lt 64 128 192 256 320 384 512 768 1152 1472 1920 gt ConferenceTemplate 1 10 NetErrorHandling lt IPLR FURBlock None gt ConferenceTemplate 1 10 IPLRRobustMode lt Auto On gt ConferenceTemplate 1 10 FURBlockSites lt Auto
47. esult parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand feedbackderegister id 1 r Result status 0K Jg 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 e ID lt 1 3 gt ID for the registration If this parameter is omitted the system uses the first vacant ID e URL r S 0 256 The URL to post feedback to e Expression 1 15 S 0 256 XPath expression OK Result parameters e ID 1 3 ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand feedbackregister url http 10 47 14 185 8000 expression l status call expression 2 status conferenc e r Result status 0K DE 2 57 FloorToSite FloorToSiteEnd GroupEntryAdd TANDBERG MPS API User Guide r end OK Command used to assign floor to a specific site in a conference Parameters e Conference r lt 1 35 gt e MCUID r lt 1 191 gt MCUID to the Mu
48. f gt FarTIphEchoSupression lt Off Normal High gt H323CallSetup 1 2 Mode lt Direct Gatekeeper gt H323Gatekeeper 1 2 Address lt S 0 64 gt H323Gatekeeper 1 2 Authentication Mode lt Auto Off gt H323Gatekeeper 1 2 Authentication ID lt S 0 50 gt 39 HTTP HTTPS IPProtocol IP ISDNInterfaceCard H323Gatekeeper 1 2 HTTP Mode lt On Off gt TANDBERG MPS API User Guide Authentication Password lt S 0 50 gt HTTPS Mode lt On Off gt IPProtocol lt IPv4 IPv6 Both gt IP 1 2 Address lt S 0 15 gt IP 1 2 SubnetMask lt S 0 15 gt IP 1 2 Gateway lt S 0 15 gt IP 1 2 DNS Server 1 5 Address lt IPv4v6Addr 0 43 gt IP 1 2 DNS Domain Name lt S 0 64 gt IP 1 2 Description lt ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 lt On Off gt ISDNInterfaceCard 1 lt 0 31 gt ISDNInterfaceCard 1 Mode lt On Off gt ISDNInterfaceCard 1 Number lt 0 31 gt ISDNInterfaceCard 1 lt NI ATT Euro Japan gt ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 ISDNInterfaceCard 1 S 0 16 gt 6 NetType lt PRI G703 gt 6 ISDN SendComplete lt On Off gt 6 ISDN SendNumber lt On Off gt 6 ISDN ParallelDial lt On Off gt 6 ISDN HLC lt On Off g
49. fying why the command was not accepted by the system e Description Textual description of the cause code 62 TANDBERG MPS API User Guide 5 API Status This section gives an overview of the Status Information available in the Status XML documents status xml history xml and the Status root commands xstatus xhistory of the XACLI interface All examples are presented using the standard XACLI format 63 TANDBERG MPS API User Guide 5 1 status xml xstatus Call 1 160 Top level attributes conferenceRef 1 9 direction Incoming Outgoing logTag 1 Unique number identifying the call This tag can be used to track the call in the call log history xml xhistory protocol H320 H323 status CallIDLE Dialing Alerting Proceeding EstablOut Establln AwaitlnCnf Connected Disconnecting Disconnected Await2nd nr ClearOut Clearln Syncing Capex Synced Unframed type TIph Vtiph Summary Returns all currently available information for a call Examples s Call 1 status Synced type Vtlph protocol H323 direction Outgoing logTag 1 conferenceRef 1 CallRate 384 RemoteNumber 5020020 Mute Off Microphone Off Duration 6036 PictureMode Full RequestingPassword Off MuteVideo Off MuteOutgoing Off VideoText System20020 NOR PUINIBILOCGI lt S OEE FOUR AVES Oe ayoutLock Off ayoutLockWindow 0 Channels 1 type Incoming Rate 384 Rest Cio ORE meryocdem Seacus Oris mm s
50. gate where information is exchanged between two systems a control application and a target system The control application transmits instructions to the target system while the target system supplies information about how these instructions are executed in addition to other system related information Thus the exchange of information can be divided into 1 information flowing from target hereby called read information r 2 information flowing to target hereby called write information w If we now look at the TANDBERG systems we can identify three main types of information either being read information r write information w or read write information rw 1 r Read information Status Information Information about the system and system processes i e information generated by the system F ex status about ongoing calls network status conference status etc All status information is structured in a hierarchy making up a database constantly beeing updated by the system to reflect process changes 2 w Write information Command Information Information supplied by the user to initiate an action F ex instructing the system to place a call assigning floor to a specific site disconnecting a site etc A command is usually followed by a set of parameters to specify how the given action is to be executed 3 rw Read Write information Configuration Information Information defining system settings This inform
51. ght starting with window number one at the top row Note Both the window id and the call id must be defined Parameters 59 LocalEntryAdd LocalEntryDelete TANDBERG MPS API User Guide e Window r lt 1 16 gt e CalllD r lt 1 176 gt Call ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command used to add a new entry to the locally stored Directory The entry is stored in the first vacant position in the Directory Parameters e Name lt S 0 48 gt The entry s name e Number lt S 0 60 gt The entry s number e SecondNumber S 0 60 gt The entry s second number 2XH221 number e SubAddress lt S 0 60 gt The entry s sub address e CallRate 1xh221 2xh221 64 128 192 256 320 384 H0 512 768 1152 1472 15 36 1920 Tlph gt The callrate to use when calling this entry e Restrict lt On Off gt Whether to use restrict or not when calling this entry e NetProfile lt 1 7 gt The Net Profile to use when calling this entry Networkld lt 1 32 gt e NetworkModule lt 1 6 gt OK Result parameters e LocalEntryld lt 1 250 gt Reference to the Directory position the entry is stored ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcom
52. ll to move e ToConferenceltem r lt 1 35 gt Conference to move to OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command used to add a protect number Parameters e Conference r lt 1 15 gt Conference to add number e NetProfile r lt 2 7 gt Net profile of number e o Number r S 0 60 gt Number to add OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code 61 ProtectNumberRemove VideoTextSet TANDBERG MPS API User Guide Command used to remove a protect number Parameters e Conference r lt 1 15 gt Conference to remove number e NetProfile r lt 2 7 gt Net Profile to remove e Number r S 0 60 gt Number to remove OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command used to set video text for a call Parameters e Callltem r lt 1 176 gt Call to set text to e Text S 0 61 gt The text to set e Visible lt On Off gt If text is visible OK Result parameters None ERROR Result parameters e Cause 1 Cause code speci
53. ltiSite the site is connected to e TerminallD r lt 1 191 gt The site s terminal id referenced to the MultiSite it is connected to OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand floortosite conference 4 mcuid 85 terminalid 2 r Result status OK r end OK Command used to end the assignment of floor to a specific site in a conference supporting Requires that the command FloorToSite has been issued in advance Parameters e Conference r lt 1 35 gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand floortositeend r Result status 0K r end OK Command used to add a new Group entry to the locally stored Group Directory or MultiSite Directory The entry is stored in the first vacant position in the Group Directory Parameters e Name lt S 0 48 gt The entry s name e LocalEntryld 1 32 lt 1 99 gt References to local entry ids to be included in this Group entry OK Result parameters 58 GroupEntryDelete LayoutLock LayoutUnLock TANDBERG MPS API User Guide e GroupEntryld lt 1 16 gt Reference to the Group Directory position the entry i
54. lues first and then the system will assign the sequence entered parameters for the parameters not yet having been assigned a value Example 2 17 xcommand dial 666 r on 10 128 Command response When issuing a command the system will return a set of return values ref the documentation of the TANDBERG XML API The response will be on the same format as the standard XACLI Status format Example 2 18 xcommand dial 10 47 15 127 r Result status 0K CallRef 1 LogTag 6 r end OK NOTE When using XACLI as a machine machine interface it is recommended to use markup notation and always supply complete tag names 28 TANDBERG MPS API User Guide 2 5 XML Output xgetxml As an alternative to the standard XACLI output format XML format is supported through the root command xgetxml xgetxml takes an XPath expression as parameter and the elements or complete document matching the expression will be returned Example 2 19 xgetxml status ip Siraicus lt IP item 1 gt lt Address item 1 gt 10 47 8 20 lt Address gt lt SubnetMask item 1 gt 255 255 248 0 lt SubnetMask gt lt Gateway item 1 gt 10 47 8 1 lt Gateway gt lt I gt lt Status gt OK 29 TANDBERG MPS API User Guide 2 6 Special Commands In addition to the root commands described above XACLI support a set of root commands that only applies to the Telnet session or RS232 session from where they are issued This lets the user co
55. mand localentryadd name John Galt number 666 r Result status 0K Loceullaiame ay ols 17 r end OK Command used to delete an entry in the locally stored Directory Parameters e LocalEntryld r lt 1 99 gt Reference to the entry to delete OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand localentrydelete localentryid 66 60 OptionKeyAdd OptionKeyDelete ParticipantMove ProtectNumberAdd TANDBERG MPS API User Guide r Result status 0K r end OK Command used to add option key Parameters e Key r S 0 90 gt Option key string OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command used to remove option key Parameters e OptionKeyld r lt 1 64 gt Option key Id to remove OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command used to move participant from from one conference to another conference Parameters e FromConferenceltem r lt 1 35 gt Conference to move from e Callltem r lt 1 176 gt Ca
56. ntifies the request and SOAP where a single URI is used but the request itself is encoded with XML 1 5 1 Bare bone HTTP S access The bare bone HTTP mode uses a unique URL to identify the specific request The contents of the HTTP body will be a XML document or part of it Bare bone HTTP S access is accomplished by passing arguments in the query string after in URL in a GET request or using the application x www form urlencoded content type mehtod of POSTing form data Each argument starts with a name and a value and every parameter separated with amp and opt NL getxml REQUEST getxml PARAM location XPath expression getxml request returns an XML document based on the location parameter passed to the request The elements or complete document matching the expression will be returned On Incorrect XPath expression a lt Fault gt element with a lt XPathError gt element will be returned formputxml REQUEST formputxml PARAM xmldoc an XML document of Configuration Directory or Command This is most useful in a POST to extend character limit of 255 of GET urls It posts a Configuration or Command document to set the configurations or issue a command Like getxml it has the data URL form data encoded with one single parameter The Content Type of the document must be of type application x www form urlencoded and the body must be encoded accordingly e g first line will be xmldoc lt
57. ntrol application individually configure the session s in use Supported special commands e xfeedback not supported on all platforms e xpreferences 2 6 1 xfeedback The special command xfeedback lets the user register user defined XPath expressions with possible exposure options to monitor changes in the XML XACLI data Whenever there is a change in one or more elements addressed by a registered XPath expression the part of the element structure containing these changes will be returned The system supports a total of 20 registered expressions with a total of 15 expressions for one session xfeedback usage xfeedback register lt XPathExpression gt or xfeedback deregister lt index gt Ors xfeedback list note deregistration with index 0 will deregister all registered expressions OK Example 2 20 User wants to monitor changes in audio protocols for all active calls xfeedback register status call channels audio protocol To view registered expressions xfeedback list xf 1 status call channels audio protocol OK The call changes audio protocol from G722 to G728 on incoming audio channel on call 1 s Call 1 status Synced type Vtlph protocol H323 direction Outgoing Channels 1 type Incoming Audio status Active Protocol 5728 s end When changing back to G722 s Call 1 status Synced type Vtlph protocol H323 direction Outgoing Channels 1 type Incoming Audio status Active I
58. o status Inactive s end s Call 1 status Synced type Vtlph protocol H323 direction Outgoing Channels 1 type Incoming Rate 720 Audio status Active Protocol G728 Rate 16 s end 2 6 2 xpreferences The special command xpreferences lets the user control application individually configure the Telnet RS 232 session in use xpreferences usage xpreferences xpathwrite on off or xpreferences detaillevel lt 1 2 gt or xpreferences xmlconfigfeedback on off Or xpreferences xmlstatusfeedback on off or xpreferences xmlcommandresult lt on off gt OK xpreferences xpathwrite lt on off gt This command disables enables the XPath engine when issuing configurations When the XPath engine is disabled the user control application must supply the complete path to the configurations to be set no double slashes allowed This will improve the performance of the system when issuing many consecutive configurations NOTE It is always recommended to supply the complete path for configurations to be set when issuing commands from an external control application 33 TANDBERG MPS API User Guide xpreferences detaillevel lt 1 2 gt Most information elements accessible by the status type root commands are defined to be level1 information However there are some information elements which are defined to be level2 information When reading status information only the information elements with a
59. r is omitted for an element all items of this element will be addressed The following expression addresses the BaudRate element of both serial ports Configuration SerialPort BaudRate Example 1 7 When using XPath it is possible to omit specifying intermediate levels in the address expression By using the powerful double slash you can address elements without having to specify the complete path The expression below addresses the BaudRat e element of both serial ports of Example 1 4 Configuration BaudRate TANDBERG MPS API User Guide Example 1 8 XPath also supports addressing by putting constraints on element attributes Let s go back to the Ca11 element in Example 1 2 The below expression will address the CallRate element of all Synced calls in a system Status Call Gstatus Synced CallRate To add more constraints on element attributes XPath supports boolean expressions To address all Synced H323 calls in a system the following expression can be used Status Call Gstatus Synced AND protocol H323 CallRate TANDBERG MPS API User Guide 1 3 The TANDBERG XML Engine The TANDBERG XML engine is optimized for advanced machine machine interaction between a TANDBERG system and an external control application The main features can be summarized to e Structuring of information e Addressing using XPath e Feedback 1 3 1 Structuring of Information An application programming interface can be seen as a
60. red for the given Feedback ID Examples s Feedback 1 status Off s end s Imexexoloewehs L Stanus 0m 3 inne Uis 7 10 427 1 2 13358000 Expression status call status Synced Expression Expression Expression EXPRESS EA Expression Expression Expression Expression Expression Expression Expression Expression Expression Expression 69 H323Gatekeeper 1 2 IP 1 2 MediaBoard 1 8 s end Top level attributes TANDBERG MPS API User Guide e Status Required Discovering Discovered Authenticating Authenticated Registering Registered Rejected lnactive Summary e Returns H323Gatekeeper status Examples s H323Gatekeeper 1 s end s H323Gatekeeper 1 Address Porcs 1719 s end s H323Gatekeeper 1 Address Bones 0 s end Top level attributes None status Inactive status Registered 191547 s De 31 status Rejected FLO AT NN Summary e Returns current IP address Subnet Mask and Gateway address Example SS 112 Le Address t VILO 878 2224 SubnetMask 255 255 248 0 DESereajoeseims WW Gateway 10 47 8 1 V6 Address 1 type NA Address 2 type NA DNS Server 1 Addresse Server 2 Address 5050 i Server 3 Neleizeisis O OA Server 4 Axoleuee ses 127 00 1 Server 5 GIS CSS 0 0 0 0 Domain Name s end Top level attributes None Summary e Retu
61. rns current IP and Ethernet information for the Media Boards 70 SystemUnit TANDBERG MPS API User Guide Example s MediaBoard 1 TemperatureCelcius 30 TemperatureFahrenheit 86 Description WW RES ELE SulbbnceMask MSSF Aon Acre Ol Gateway 10 47 8 1 V6 Address 1 type NA Address 2 type NA Ethernet MacAddress 00 50 60 00 ED 1F Speed 100full s end Top level attributes None Summary e Returns information about the System Unit Example s SystemUnit ProductType TANDBERG MPS MCU ProductId TANDBERG MPS200 Uptime 600587 UptimeStr 6 days 22 hours 49 minutes 47 seconds Software VERS TON USB cba ME INESSE SRM Name test Releasebacss V2006 01 12 17244 deu Configuration Telephony 16 VideoTelephony 40 AdvancedVideoOption 40 Encryption 40 PRP os e ERO SerialPorts 0 MaxBW 30720 ManagedResources Conference 0 Telephony 0 VideoTelephony 0 AdvancedVideoOption 0 ENCEYPE TON O MaxBW 0 MaxBChanPRI 0 TotalMCUResources Conference 10 Telephony 16 VideoTelephony 40 MaxBW 30720 MaxBChanPRI 0 TotalGWResources GatevayCall 0 MaxBChanPRI 0 Hardware 71 SeriallnterfaceCard ISDNInterfaceCard SerialNumber MainBoard BootSoftware Used locals Conference Telephony VideoTelephony BERARE RON Bandwidth Gateway GatewayCall BChanPRI MEUR Conference Telephony VideoTelephony Bandwidth BChanPRI s
62. s not accepted the response structure will contain a cause code If the command is accepted the response structure may contain information relevant for the specific command Example 13 The Dial command in the above example may return the following response structure lt Command gt DialResult item 1 status OK GRE Ate SN RE lt LogTag item 1 gt 6 lt LogTag gt lt DialResult gt lt Command gt The response structure for the Dial command DialResult states that the command was accepted by the system In addition to stating that the command was accepted the Dial command returns the elements CallRef and LogTag This lets the user identify trace the call in the Status documents status xml and history xml 12 TANDBERG MPS API User Guide Example 14 Below is an example of the Dial command not being accepted by the system lt Command gt lt DialResult item 1 status Error gt lt das abc ASS gt lt Description item 1 gt Too much bandwidth requested lt Description gt lt DialResult gt lt Command gt 13 TANDBERG MPS API User Guide 1 5 Introduction to TANDBERG XML API Service TXAS TXAS is a service provided by TANDBERG units for transmitting and receiving transceiving information encoded in XML format The API uses HTTP S as the transport mechanism and connects to the normal web port 80 TXAS can be accessed in two ways bare bone HTTP requests where URL s uniquely ide
63. s stored ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand groupentryadd name The Team localentryid 1 17 localentryid 2 29 localentryid 3 56 r Result status OK COU PE er PEC 1 5 r end OK Command used to delete an entry in the locally stored Group Directory Parameters e GroupEniryld r lt 1 16 gt Reference to the entry to delete OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand groupentrydelete groupentryid 15 r Result status OK r end OK Command use to lock a call id e g a participant to a given window in the CP layout The numbering goes from left to right starting with window number one at the top row Note If ConferenceSelfview is set to Off it is only possible to lock the call id to window number one Parameters e Window r lt 1 16 gt e CalllD r lt 1 176 gt Call ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command use to unlock a locked call id e g a participant from a given window in the CP layout The numbering goes from left to ri
64. seewecols 9722 s end 30 TANDBERG MPS API User Guide Example 2 21 Exposure options are also supported together with feedback User only wants to monitor call setup progression xfeedback register status call OK xcom dial 10 47 15 127 s Call 1 status EstablOut type Vtlph protocol H323 direction Outgoing s end r Result status 0K elles 1 LogTag 3 r end OK s Call 1 status Alerting type Vtlph protocol H323 direction Outgoing s end CONNEC s Call 1 status Syncing type Vtlph protocol H323 direction Outgoing s end s Call 1 status Synced type Vtlph protocol H323 direction Outgoing s end Example 2 22 User only wants to know when calls are connected and disconnected xfeedback register status call Qstatus Synced OK xfeedback register status call fstatus Disconnected OK xcom dial 10 47 15 127 r Result status OK CallRef 1 LogTag 4 r end OK CONNEC s Call 1 status Synced type Vtlph protocol H323 direction Outgoing 31 TANDBERG MPS API User Guide s end xcom disc sr Reguli eat S 7 r end OK NO CARRIER s Call 1 status Disconnected type NA protocol NA direction NA s end When conditional XPath expressions are used the system will provide feedback on all elements within the address the first time the condition is true Example 2 23 User wants to monitor call changes
65. structure lt root command gt lt address expression gt lt exposure option gt Supported exposure options hides all value elements e hides all sub elements Example 2 2 Request for Call 1 element with no exposure option xstatus call 1 s Call 1 status Synced type Vtlph protocol H323 direction Outgoing CallRate 768 RemoteNumber 10 47 15 127 Mute Off Microphone Off Duration 10 Channels 1 type Incoming Rate 768 Restrict TOTT Encryption status 0ff Audio status Active Prococols 572 Rate 64 Video 1 status Active Protocol i263 Resolution CIF Rate 704 Video 2 status Inactive Data status Inactive Channels 2 type Outgoing Rate 768 mersus OC Encryption status Off Audio status Active Protocol 72 Rate 64 Video 1 status Active Protocol 1263 Resolution ICIF Rate 704 video 2 status Inactive Data status Inactive s end Request for Call 1 element with exposure option xstatus call 1 s Call 1 status Synced type Vtlph protocol H323 direction Outgoing Channels 1 type Incoming Encryption status Off 19 TANDBERG MPS API User Guide Audio status Active Video 1 status Active Video 2 status Inactive Data status Inactive Channels 2 type Outgoing Encryption status Off Audio status Active Video 1 status Active Video 2 status Inactive Data status
66. t 6 ISDN SpeechTimers lt On Off gt 6 ISDN PRI NSFTelephony Mode 6 ISDN PRI NSFTelephony Number 6 ISDN PRI NSFVideoTelephony 6 ISDN PRI NSFVideoTelephony 6 ISDN PRI SwitchType 6 ISDN PRI TrunkGroups On Off 6 ISDN PRI InitialRestart lt On Off gt 6 ISDN PRI L2WindowsSize lt 1 7 gt 6 ISDN PRI Alert On Off 6 ISDN PRI Chanld On Off 40 LoS TANDBERG MPS API User Guide ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 MaxChannels lt 1 30 gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 HighChannel lt 1 31 gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 LowChannel lt 1 31 gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 Search lt High Low gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 NumberRangeStart lt S 0 60 gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 NumberRangeStop lt S 0 60 gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 Enable lt On Off gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 NFASEnable lt On Off gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 NFASGroupld lt 1 4 gt ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 NFASInterfld lt 0 127 gt ISDNInterfaceCard 1 6 G703 PhysicalLayer lt E1 T1 gt ISDNInterfaceCard 1 6 G703 Interface 1 8 Enable lt On Off gt ISDNInterfaceCard 1 6 G703 Interface 1 8 IneludeE1Channel16 lt On Off gt
67. t 1xh221 2xh221 64 128 192 256 320 384 H0 512 768 1152 1472 15 36 1920 TIphs Restrict sOn Offs Password lt S 0 85 PassvvordOnOutgoingCalls lt On Off gt Encryption lt On Off gt EncryptionType lt DES AES 128 Auto gt SecondaryRate lt On Off gt WelcomeMessage lt On Off gt DuoVideo lt On Off gt AudioG728 lt On Off gt CascadingPreference lt Auto Master Slave gt BillingCode lt S 0 16 gt CPAutoSwitch lt 0 60 gt Networkld lt 1 32 gt ConferenceSelfview sOn Offs Protect sOn Offs TemplateReference lt 1 10 gt HDEnabled lt On Off gt onference r lt 1 12 gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system 52 ConferenceStop ConferenceShowDuration ConferenceTerminate TANDBERG MPS API User Guide e Description Textual description of the cause code Example xcommand conferencestart conference l r Result status 0K r end OK Command used to stop a conference All active calls must be disconnected prior to stopping the conference Parameters e Conference r lt 1 35 gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand conferencestop conference l r Result status OK r end OK Command use
68. the container element SerialPort contains five sub elements All these sub elements are value elements each holding values for the properties BaudRate Parity DataBits StopBits and Mode Example 1 2 In this example we will look at element attributes Attributes are used to add meta information to an element Attributes are placed within the start tag of an element and different attributes are separated by space An XML structure representing the status of a call in a videoconferencing system is shown below lt Status gt lt Call item 1 status Disconnected type NA protocol NA gt lt Cause item 1 gt 255 lt Cause gt S Cad Status We can see from the status attribute of the Ca11 element that the call is disconnected The only relevant information regarding this call is the disconnect cause value Therefore the sub structure of the call element contains only one value element TANDBERG MPS API User Guide Example 1 3 If we now look at the call element for an active call we see that ca11 element contains a large sub structure SS NEGRES Call item 1 status Synced type Vtlph protocol H323 gt Cede team 1 gt 768 lt Cs1llkace gt lt RemoteNumber item 1 gt 10 47 15 127 lt RemoteNumber gt Channels item 1 type Incoming gt Audio item 1 status Active Protocol item 1 gt G722 lt Protocol gt Rate item 1 gt 64 lt Rate gt Audio Video item 1 status Active gt Pro
69. tocol item 1 gt H263 lt Protocol gt Resolution item 1 gt CIF lt Resolution gt Rate item 1 gt 704 lt Rate gt lt Video gt Video item 2 status Inactive Meira abe Ud searcus mae v EE Channels Channels item 2 type Outgoing Audio item 1 status Active Protocol item 1 gt G722 lt Protocol gt Rate item 1 gt 64 lt Rate gt Audio Video item 1 status Active Protocol item 1 gt H264 lt Protocol gt Resolution item 1 gt SIF lt Resolution gt Rate item 1 gt 704 lt Rate gt lt Video gt Video item 2 status Inactive Datoren Vi wenige gei gt lt Channels gt s ES lt Status gt In this example the attributes are used to provide valuable information in addition to establishing a dependency to the underlying sub structure of the element Example 1 4 In the above examples all elements are having an attribute named item This attribute specifies the instance number of the element If we expand Example 1 1 to a system having two serial ports the XML structure could look like this lt Configuration gt lt SerialPort item 1 gt lt BaudRate item 1 gt 9600 lt BaudRate gt lt Parity item 1 gt None lt Parity gt lt DataBits item 1 gt 8 lt DataBits gt StopBits item 1 gt 1 lt StopBits gt lt Mode item 1 gt Control lt Mode gt lt SerialPort gt lt SerialPort item 2 gt lt BaudRate item 1 gt 19200 lt BaudRate
70. try 1 250 NetworkModule lt 0 6 gt GroupEntry 1 16 Name lt S 0 48 gt GroupEntry 1 16 LocalEntryld 1 32 lt 0 250 gt 46 TANDBERG MPS API User Guide 4 API Commands This section gives an overview of the supported system Commands All examples are presented using the standard XACLI format 47 TANDBERG MPS API User Guide 4 1 command xml xcommand Boot CallFURBlock CallMoveToQCIF CallMute Command used to reboot the system Parameters None OK Result parameters None ERROR Result parameters e Cause lt 1 gt Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Example xcommand boot r Result status 0K r end OK Command used to block Fast updates to a call Parameters e Call r lt 1 176 gt e Value r lt On Off gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command used to move a call to QCIF Parameters e Call r lt 1 108 gt OK Result parameters None ERROR Result parameters e Cause 1 Cause code specifying why the command was not accepted by the system e Description Textual description of the cause code Command used to mute incoming audio from a specific call Parameters e Call r lt 1 12
71. ttp 10 47 8 41 getxml location Directory http 10 47 8 41 getxml location Command http 10 47 8 41 getxml locationz ValueSpace Exercise 3 This exercise shows how to use XPath expressions to read subsets of the XML documents http 10 47 8 41 getxml location Status SystemUnit http 10 47 8 41 getxml location Configuration SerialPort BaudRate http 10 47 8 41 getxml location ValueSpace SerialPortBaudrate item 1 http 10 47 8 41 getxml location Configuration Mode http 10 47 8 41 getxml location Command Dial Exercise 4 The address http 10 47 8 41 xmlput ssi contains an editor where XML data can be edited and then posted to the system by pressing the save button Below are examples of XML structures to be posted to the system lt Configuration gt lt SerialPort gt lt BaudRate gt 19200 lt BaudRate gt lt SerialPort gt lt Configuration gt lt Configuration gt 15 lt SerialPort gt lt BaudRate gt 2400 lt BaudRate gt lt SerialPort gt lt Conference gt lt H263 gt 0ff lt H263 gt lt Downspeed gt Off lt Downspeed gt lt Conference gt lt Configuration gt lt Command gt lt Dial gt lt Number gt 10 47 8 42 lt Number gt lt Dial gt lt Command gt lt Command gt DisconnectCall Command TANDBERG MPS API User Guide 16 TANDBERG MPS API User Guide 2 The XML based Advanced Command Line Interface The XML based Advanced Command Line Interface XACLI is
72. us Idle status Idle status Idle status Idle D lt ye SSS Ss e e a ieS SS SS SS SS SS SS Sy ES SS Es SS 72 TANDBERG MPS API User Guide Channels 22 type BChannel status Idle Channels 23 type BChannel status Idle Channels 24 type BChannel status Idle Channels 25 type BChannel status Idle Channels 26 type BChannel status Idle Channels 27 type BChannel status Idle Channels 28 type BChannel status Disconnected CaliingNeamber M 0 98 2 281990 CauseLocation 0 ChannelCause 16 ConnectionTime 16 Channels 29 type BChannel status Disconnected CallingNumber 074859215 CauseLocation 2 ChannelCause 16 ConnectionTime 11 Channels 30 type BChannel status Disconnecting CallingNumber 041669426 CauseLocation 2 ChannelCause 16 ConnectionTime 0 Channels 31 type BChannel status Disconnected CallingNumber 71269140 CauseLocation 0 ChannelCause 16 ConnectionTime 0 PRI 2 ready True BChannelsTotal 29 BChannelsFree 29 HOChannelsFree 4 Channels 1 type BChannel status Idle Channels 2 type BChannel status Idle Channels 3 type BChannel status Idle Channels 4 type BChannel status Idle Channels 5 type BChannel status Idle Channels 6 type BChannel status Idle Channels 7 type BChannel status Idle Channels 8 type BChannel status Idle Channels 9 type BChannel status Idle
73. utgoing Channels 1 type Incoming Rate 736 Audio status Active Precocols 657221 Rate 32 s end XML format Sracus lt Call item 1 status Synced type Vtlph protocol H323 direction Outgoing gt lt Channels item 1 type Incoming gt lt Rate item 1 gt 768 lt Rate gt lt Audio item 1 status Active gt s lle cn MS EAS Boo cole Rate item 1 gt 64 lt Rate gt lt Audio gt lt Channels gt lt Cede lt Status gt xpreferences xmlcommandresult lt on off gt If xmicommanaresult is set to on response for commands will be returned in XML format Example 2 27 XACLI format xcom dial 10 47 15 127 r Result status OK Caine LogTag 8 r end XML format xcom dial 10 47 15 127 lt Result item 1 status OK gt lt CallRef item 1 gt 1 lt CallRef gt LogTag item 1 gt 8 lt LogTag gt lt Result gt 35 TANDBERG MPS API User Guide 3 API Configurations This section gives an overview of the Configuration Information available in the Configuration XML documents configuration xml directory xml and the Configuration root commands xconfiguration xdirectory of the XACLI interface All examples are presented using the standard XACLI format 36 TANDBERG MPS API User Guide 3 1 configuration xml xconfiguration AllowIncomingTIphCall AllovincomingTIphCall lt On Off gt Conference Conference 1 35 Numbers E164Alias lt E164 0
74. with a command type root command followed by a command name followed by a set of parameters Parameters values can either be specified by a mark up notation or by placing the parameter values in the sequence specified by the help text or a combination of these methods Markup notation lt command type root command gt lt command gt lt parameter value gt lt parameter value gt When using this notation the sequence the parameters are entered is unessential Example 2 13 xcommand dial number 666 restrict on callrate 128 subaddress 10 Abbreviations can be used for the parameter names as long as the parameter names are unique within the command Example 2 14 xcommand dial nu 666 r on c 128 s 10 If there are multiple instances of a parameter the item number is added after the tag separated with a dot lt command type root command gt lt command gt lt parameter item value gt lt parameter item value gt Example 2 15 xcommand groupentryadd name TANDBERG localentryid 1 15 localentryid 2 57 27 TANDBERG MPS API User Guide Sequence notation lt command type root command gt lt command gt lt value gt lt value gt When using this notation the parameter values must be entered in the sequence as stated in the help text Example 2 16 xcommand dial 666 10 128 on Combination A combination of mark up notation and sequence are also supported The marked parameters will be assigned the user entered va

TANDBERG D13639 User's Manual

Contents

Download Pdf Manuals

Related Search

Related Contents