TANDBERG MPS API, User Manual

Page 1: ...TANDBERG MPS API User Guide TANDBERG D13639 Rev 07 March 2008...

Page 2: ...ced Command Line Interface 17 2 1 XACLI 18 2 2 The Status type root commands xstatus xhistory 21 2 3 The Configuration type root commands xconfiguration xdirectory 23 2 4 The Command type root command...

Page 3: ...nd 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 o...

Page 4: ...nts 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...

Page 5: ...te Audio Video item 1 status Active Protocol item 1 H264 Protocol Resolution item 1 SIF Resolution Rate item 1 704 Rate Video Video item 2 status Inactive Data item 1 status Inactive Channels Call Sta...

Page 6: ...TANDBERG MPS API User Guide 4 StopBits item 1 1 StopBits Mode item 1 Auto Mode SerialPort Configuration...

Page 7: ...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 nu...

Page 8: ...in Example 1 2 The below expression will address the CallRate element of all Synced calls in a system Status Call status Synced CallRate To add more constraints on element attributes XPath supports bo...

Page 9: ...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 c...

Page 10: ...nfiguration 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 in...

Page 11: ...urns 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...

Page 12: ...em 1 Off Restrict Encryption item 1 status Off Audio item 1 status Active Protocol item 1 G722 Protocol Rate item 1 56 Rate Audio Call Call item 6 status Disconnected type NA protocol NA direction NA...

Page 13: ...ns 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 su...

Page 14: ...sponse 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...

Page 15: ...13 Example 14 Below is an example of the Dial command not being accepted by the system Command DialResult item 1 status Error Cause item 1 17 Cause Description item 1 Too much bandwidth requested Des...

Page 16: ...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 wi...

Page 17: ...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 Conf...

Page 18: ...User Guide 16 SerialPort BaudRate 2400 BaudRate SerialPort Conference H263 Off H263 Downspeed Off Downspeed Conference Configuration Command Dial Number 10 47 8 42 Number Dial Command Command Disconn...

Page 19: ...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 oppos...

Page 20: ...ion 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 di...

Page 21: ...ng CallRate 768 RemoteNumber 10 47 15 127 Mute Off Microphone Off Duration 10 Channels 1 type Incoming Rate 768 Restrict Off Encryption status Off Audio status Active Protocol G722 Rate 64 Video 1 sta...

Page 22: ...Encryption status Off Audio status Active Video 1 status Active Video 2 status Inactive Data status Inactive s end Request for Call 1 element with exposure option xstatus call 1 s Call 1 status Synce...

Page 23: ...ack 1 3 SIP GatewayCall 1 80 SystemActivity H323Gatekeeper SystemClock IP SystemLoad ISDNInterfaceCard 1 6 SystemUnit OK To access status type data simply type the status type root command xstatus or...

Page 24: ...XML formatting and XACLI formatting for the same status element IP Example 2 5 XML Status IP item 1 Address item 1 10 47 8 20 Address SubnetMask item 1 255 255 248 0 SubnetMask Gateway item 1 10 47 8...

Page 25: ...ngTlphCall HTTPS RTP AllowNTSCCP IP 1 2 SerialInterfaceCard 1 6 Conference 1 40 IPProtocol Session ConferenceTemplate 1 10 ISDNInterfaceCard 1 6 SingleNumberDialIn Ethernet 1 2 LoS SIP ExternalManager...

Page 26: ...l elements are returned To get help on all configurations supported by the system type xconfiguration or xconfiguration 2 3 2 Configuration read To read configurations type the configuration type root...

Page 27: ...TANDBERG MPS API User Guide 25 Example 2 9 User wants to set IP assignment xconfiguration ip assignment static or xconfiguration ip assignment static...

Page 28: ...edbackDeregister SiteDisconnect CameraTrackingStop FeedbackRegister SiteView CameraWhiteBalance FloorRelease SiteViewEnd ChairRelease FloorRequest SPIDAutoConfigure ChairTake FloorToSite StillImageSen...

Page 29: ...he help text or a combination of these methods Markup notation command type root command command parameter value parameter value When using this notation the sequence the parameters are entered is une...

Page 30: ...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 comma...

Page 31: ...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 Status IP...

Page 32: ...ges 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 XPathExpression or xfeedback deregister...

Page 33: ...atus Alerting type Vtlph protocol H323 direction Outgoing s end CONNECT s Call 1 status Syncing type Vtlph protocol H323 direction Outgoing s end s Call 1 status Synced type Vtlph protocol H323 direct...

Page 34: ...en 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 sta...

Page 35: ...ences lets the user control application individually configure the Telnet RS 232 session in use xpreferences usage xpreferences xpathwrite on off or xpreferences detaillevel 1 2 or xpreferences xmlcon...

Page 36: ...ls 1 type Incoming Audio status Active Protocol G722 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 log...

Page 37: ...rotocol G722_1 Rate 32 s end XML format Status Call item 1 status Synced type Vtlph protocol H323 direction Outgoing Channels item 1 type Incoming Rate item 1 768 Rate Audio item 1 status Active Proto...

Page 38: ...es 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...

Page 39: ...renceTemplate 1 10 Password S 0 8 ConferenceTemplate 1 10 PasswordOnOutgoingCalls On Off ConferenceTemplate 1 10 Encryption On Off ConferenceTemplate 1 10 EncryptionType DES AES 128 Auto ConferenceTem...

Page 40: ...erenceTemplate 1 10 PhoneIndication On Off ConferenceTemplate 1 10 SpeakerIndication On Off ConferenceTemplate 1 10 VideoText On Off Auto ConferenceTemplate 1 10 VideoTextTimeout 0 30 ConferenceTempla...

Page 41: ...0 64 ExternalManager Path S 0 255 FeedbackFilter FeedbackFilter Conference 0 10 FeedbackFilter Call 0 10 Gateway Gateway BandwidthPercentage 0 100 Gateway LoadLimit 0 100 Gateway NaturalVideo On Off G...

Page 42: ...ber On Off ISDNInterfaceCard 1 6 ISDN ParallelDial On Off ISDNInterfaceCard 1 6 ISDN HLC On Off ISDNInterfaceCard 1 6 ISDN SpeechTimers On Off ISDNInterfaceCard 1 6 ISDN PRI NSFTelephony Mode On Off I...

Page 43: ...8 NFASEnable On Off ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 NFASGroupId 1 4 ISDNInterfaceCard 1 6 ISDN PRI Interface 1 8 NFASInterfId 0 127 ISDNInterfaceCard 1 6 G703 PhysicalLayer E1 T1 ISDNInte...

Page 44: ...cription S 0 16 NetProfile NetProfile 1 7 Name S 0 8 NetProfile 1 7 CallPrefix S 0 9 NetProfile 1 Network Auto NetProfile 2 Network H320 NetProfile 3 Network H323 NetProfile 4 Network H320 H323 SIP Au...

Page 45: ...VideoTelephony Video 0 63 QoS 1 2 Diffserv VideoTelephony Data 0 63 QoS 1 2 Mode Precedence Diffserv Off QoS 1 2 ToS MinDelay MaxThrough MaxReliable MinCost Off RTP RTP MTU 1200 1400 SerialInterfaceC...

Page 46: ...SIP SIP Mode On Off SIP Interface Server Address S 0 255 SIP Interface Server Type Auto Nortel Microsoft Cisco Alcatel Experimental SIP Interface Authentication UserName S 0 80 SIP Interface Authenti...

Page 47: ...GatekeeperAdhocString S 0 10 TrafficShaping On Off OutbandDTMF On Off LanguageAdmin S 0 3 LanguageGraphic S 0 3 DefaultConferenceTemplate 1 10 Telnet Telnet Mode On Off The Gateway LoadLimit command...

Page 48: ...er S 0 60 LocalEntry 1 250 SubAddress S 0 60 LocalEntry 1 250 CallRate 1xh221 2xh221 64 128 192 256 320 384 512 768 1152 1472 1920 Tlph H0 Max Auto LocalEntry 1 250 Restrict On Off LocalEntry 1 250 Ne...

Page 49: ...TANDBERG MPS API User Guide 47 4 API Commands This section gives an overview of the supported system Commands All examples are presented using the standard XACLI format...

Page 50: ...one ERROR Result parameters Cause 1 Cause code specifying why the command was not accepted by the system Description Textual description of the cause code CallMoveToQCIF Command used to move a call to...

Page 51: ...system Description Textual description of the cause code Example xcommand CallMuteOutgoing call 2 mode on r Result status OK r end OK CallTransfer Command used to transfer the H 323 party of a Gateway...

Page 52: ...ult parameters None ERROR Result parameters Cause 1 Cause code specifying why the command was not accepted by the system Description Textual description of the cause code Example xcommmand conferenced...

Page 53: ...BestVideoStandard BestResolution BandwidthManagement Manual Auto WebSnapshots On Off OK Result parameters None ERROR Result parameters Cause 1 Cause code specifying why the command was not accepted by...

Page 54: ...end OK ConferenceStart Command used to start a new conference Parameters Conference r 1 35 Name S 0 30 CallRate 1xh221 2xh221 64 128 192 256 320 384 H0 512 768 1152 1472 15 36 1920 Tlph Restrict On O...

Page 55: ...nd conferencestop conference 1 r Result status OK r end OK ConferenceShowDuration Command used to show remaining time of conference Parameters Conference r 1 15 Time r 1Min 5Min 10Min Off OK Result pa...

Page 56: ...e an outgoing call Parameters Conference r 1 35 Number S 0 60 Number to dial SecondNumber S 0 60 2Xh221 second number SubAddress S 0 60 Sub address CallRate 1xh221 2xh221 64 128 192 256 320 384 H0 512...

Page 57: ...call log ERROR Result parameters Cause 1 Cause code specifying why the call was not accepted by the system Description Textual description of the cause code Example xcommand dialgroupentry conference...

Page 58: ...was not accepted by the system Description Textual description of the cause code Example xcommand diallocalentry localentryid 15 r Result status OK CallRef 1 LogTag 312 r end OK DisconnectCall Comman...

Page 59: ...rn 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 U...

Page 60: ...oorToSiteEnd 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 Conference r 1 35 OK...

Page 61: ...he system Description Textual description of the cause code Example xcommand groupentrydelete groupentryid 15 r Result status OK r end OK LayoutLock Command use to lock a call id e g a participant to...

Page 62: ...Off Whether to use restrict or not when calling this entry NetProfile 1 7 The Net Profile to use when calling this entry NetworkId 1 32 NetworkModule 1 6 OK Result parameters LocalEntryId 1 250 Refere...

Page 63: ...n of the cause code ParticipantMove Command used to move participant from from one conference to another conference Parameters FromConferenceItem r 1 35 Conference to move from CallItem r 1 176 Call t...

Page 64: ...Cause 1 Cause code specifying why the command was not accepted by the system Description Textual description of the cause code VideoTextSet Command used to set video text for a call Parameters CallIt...

Page 65: ...his 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 a...

Page 66: ...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 16036 Pic...

Page 67: ...4 Restrict Off Encryption status Off Audio status Active Protocol AAC LD Rate 64 RemoteIPAddress 10 47 20 20 2334 LocalIPAddress 10 47 9 150 2342 Encryption status Off RSVP Off RSVPRate 0 DynamicRate...

Page 68: ...ate 384 Restrict Off Password PasswordOnOutgoingCalls Off Dynamic On ID Encryption Off EncryptionType Auto WelcomeMessage On DuoVideo On AudioG728 On CascadingPreference Auto BillingCode CPAutoSwitch...

Page 69: ...lRef 1 1 CallRef 2 2 CallRef 3 3 DuoVideo status Off Floor None Current CallRef 3 Previous CallRef 2 OutgoingPicture 1 name Current Layout type 5 1Split Window 1 Picture RemoteMain CallRef 3 Window 2...

Page 70: ...IPOnly On FullySwitched Off Dynamic Off Hybrid On Properties Name TCS Test CallRate 384 Restrict Off Password PasswordOnOutgoingCalls Off Dynamic Off Encryption Off EncryptionType Auto WelcomeMessage...

Page 71: ...ess Returns Ethernet speed Example s Ethernet 1 MacAddress 00 50 60 7F FA FB Speed 10full s end Feedback 1 3 Top level attributes status on off Indicates if there are HTTP feedback registered for a gi...

Page 72: ...ekeeper 1 status Rejected Address 10 47 9 0 Port 0 s end IP 1 2 Top level attributes None Summary Returns current IP address Subnet Mask and Gateway address Example s IP 1 Address 10 47 8 222 SubnetMa...

Page 73: ...mUnit ProductType TANDBERG MPS MCU ProductId TANDBERG MPS200 Uptime 600587 UptimeStr 6 days 22 hours 49 minutes 47 seconds Software Version J3 0Beta9 TEST SW Name test ReleaseDate 2006 01 13 17 44 ert...

Page 74: ...nnelsFree 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 Cha...

Page 75: ...H0ChannelsFree 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 Id...

Page 76: ...allingNumber 032875677 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels 30 type BChannel status Disconnected CallingNumber 032875677 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels...

Page 77: ...URI Registration 4 status Inactive URI Registration 5 status Inactive URI Registration 6 status Inactive URI Registration 7 status Inactive URI Registration 8 status Inactive URI Registration 9 statu...

Page 78: ...n 30 status Inactive URI Registration 31 status Inactive URI Registration 32 status Inactive URI Registration 33 status Inactive URI Registration 34 status Inactive URI Registration 35 status Inactive...

Page 79: ...6 Option 7 Option 8 Option 9 Option 10 Option 11 Option 12 Option 13 Option 14 Option 15 Option 16 Option 17 Option 18 Option 19 Option 20 Option 21 Option 22 Option 23 Option 24 Option 25 Option 26...

Page 80: ...TANDBERG MPS API User Guide 78 Option 52 Option 53 Option 54 Option 55 Option 56 Option 57 Option 58 Option 59 Option 60 Option 61 Option 62 Option 63 Option 64 s end...

Page 81: ...h protocol H323 direction Outgoing PartOf Conference LogTag 4 ConferenceLogTag 2 ConferenceRef 1 RemoteNumber 10 47 12 242 EncryptionIn Off EncryptionOut Off CallRate 384 DisconnectCauseValue 16 Disco...

Page 82: ...allFURErrorAlert FURAlert Rate CallRef LogTag ConferenceRef ConferenceLogTag e end CallMovedFromReception e CallMovedFromReception CallRef LogTag ConferenceRef ConferenceLogTag ServiceType Protocol Di...

Page 83: ...d MaxJitter e end CallSuccessful e CallSuccessful CallRef LogTag ConferenceRef ConferenceLogTag ServiceType Protocol Direction CallRate RemoteNumber Encryption Incoming Outgoing e end DialInError e Di...

Page 84: ...2 e end H320Statistics e H320Statistics CallRef LogTag ConferenceRef ConferenceLogTag Duration FramingLoss Last Total BondingReSync Last Total e end SystemActivity e SystemActivity Service RemoteIPAdd...