manualshive.com logo in svg

TANDBERG MPS API Interface D13639, User Manual, Page: 54 / 84

Share
Download
TANDBERG MPS API Interface D13639 User Manual Download Page 54

TANDBERG MPS API 

User Guide 

52 

•

         

AudioG728: <On/Off> 

•

         

CascadingPreference: <Auto/Master/Slave> 

•

         

BillingCode: <S: 0, 16> 

•

         

CPAutoSwitch: <0..60> 

•

         

NetworkId: <1..32> 

•

         

ConferenceSelfview: <On/Off> 

•

         

Protect: <On/Off> 

•

         

TemplateReference: <1..10> 

•

         

HDEnabled: <On/Off> 

 
OK Result 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: 

xcommand conferenceredifine conference:1 duovideo:on 
                            restrict:on 
 
*r Result (status=OK): 
*r/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/Off> 

•

         

Password: <S: 0, 8> 

•

         

PasswordOnOutgoingCalls: <On/Off> 

•

         

Encryption: <On/Off> 

•

         

EncryptionType: <DES/AES-128/Auto> 

•

         

SecondaryRate: <On/Off> 

•

         

WelcomeMessage: <On/Off> 

•

         

DuoVideo: <On/Off> 

•

         

AudioG728: <On/Off> 

•

         

CascadingPreference: <Auto/Master/Slave> 

•

         

BillingCode: <S: 0, 16> 

•

         

CPAutoSwitch: <0..60> 

•

         

NetworkId: <1..32> 

•

         

ConferenceSelfview: <On/Off> 

•

         

Protect: <On/Off> 

•

         

TemplateReference: <1..10> 

•

         

HDEnabled: <On/Off>onference(r): <1..12> 

 

OK Result parameters: 

None 

ERROR Result parameters: 

•

         

Cause: <1…>

 Cause code specifying why the command was not 

accepted by the system 

Summary of Contents for MPS API Interface D13639

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

Page 2: ...nced 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 commands xcommand 26 2 5 XML Output xgetxml 29 2 6 Special Commands 30 3 API Configurations 36 3 1 configuration xml xconfiguration 37 3 2 directory xml xdirectory 46 4 API Commands 47 4 1 command xml xcomm...

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

Page 4: ...ents 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 the container element SerialPort contains five sub elements All these sub elements are value elements each holding values for the properties BaudRate Parity...

Page 5: ...ate 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 Status 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 a...

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

Page 7: ...e 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 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 number is omitted for an e...

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 boolean expressions To address all Synced H323 calls in a system the following expression can be used Status Call status Synced AND protocol H323 CallRate ...

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 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 inf...

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

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

Page 12: ...tem 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 Cause item 1 255 Cause Call 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...

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

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

Page 15: ...e 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 Description DialResult Command ...

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 will be returned On Incorrect XPath expression a Fault element with a XPathError element will be returned formputxml REQUEST formputxml PARAM xmldoc an XML document of Configuration Directory or Comman...

Page 17: ...n 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 http 10 47 8 41 getxml location Directory http 10 47 8 41 getxml location Command http 10 47 8 41 getxml location ValueSpace Exercise 3 This exercise shows how to use XPath expressions to r...

Page 18: ...I 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 DisconnectCall Command ...

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

Page 20: ...tion 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 pro...

Page 21: ...ing 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 status Active Protocol H263 Resolution CIF Rate 704 Video 2 status Inactive Data status Inactive Channels 2 type Outgoing Rate 768 Restrict Off Encryption status Off Audio status Active Protocol G722 Ra...

Page 22: ...g 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 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 ...

Page 23: ...back 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 xhistory and then an XPath address expression or a TANDBERG SimplePath expression status type root command address expression Example 2 4 xstatus call 1 remotenumber s Call 1 status Synced type Vtlph...

Page 24: ...s 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 1 Gateway IP Status XACLI s IP Address 10 47 8 20 SubnetMask 255 255 248 0 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 wh...

Page 25: ...ingTlphCall 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 MCU SNMP FeedbackFilter MediaBoard 1 12 SSH Gateway NetProfile 1 7 STUN H323CallSetup 1 2 NTP SystemClock H323Gatekeeper 1 2 PrefixDialIn SystemUnit HTTP QoS 1 2 Telnet OK xdirectory Directory Local...

Page 26: ...el 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 command followed by an address expression configuration type root command address expr Example 2 8 User wants to read IP configurations xconfiguration ip c xConfiguration IP Assignment Static c xCon...

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: ...eedbackDeregister SiteDisconnect CameraTrackingStop FeedbackRegister SiteView CameraWhiteBalance FloorRelease SiteViewEnd ChairRelease FloorRequest SPIDAutoConfigure ChairTake FloorToSite StillImageSend ConferenceDisconnect FloorToSiteEnd StreamingStart DefaultValuesSet GroupEntryAdd StreamingStop Dial GroupEntryDelete TextDelete DialGlobalEntry LocalEntryAdd TextDisplay DialGroupEntry LocalEntryD...

Page 29: ...the 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 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 Ex...

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 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 1...

Page 31: ...d 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 item 1 Address item 1 10 47 8 20 Address SubnetMask item 1 255 255 248 0 SubnetMask Gateway item 1 10 47 8 1 Gateway IP Status OK ...

Page 32: ...nges 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 index or 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 reg...

Page 33: ...tatus 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 direction Outgoing s end Example 2 22 User only wants to know when calls are connected and disconnected xfeedback register status call status Synced OK xfeedback register status call status Disconnected OK...

Page 34: ...hen 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 status Synced OK xcom dial 10 47 15 127 r Result status OK CallRef 1 LogTag 5 r end OK CONNECT s Call 1 status Synced type Vtlph protocol H323 direction Outgoing Cal...

Page 35: ...rences 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 xmlconfigfeedback on off or xpreferences xmlstatusfeedback on off or xpreferences xmlcommandresult on off OK xpreferences xpathwrite on off This command disables enables the XPath engine when issuing confi...

Page 36: ...els 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 logTag 3 Channels 1 type Incoming Audio status Active Protocol G722 Rate 64 RemoteIPAddress LocalIPAddress 10 47 8 28 2326 Encryption status On Type AES 128 RSVP Off RSVPRate 0 DynamicRate 64 TotalPacke...

Page 37: ...Protocol 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 Protocol item 1 G722 Protocol Rate item 1 64 Rate Audio Channels Call Status xpreferences xmlcommandresult on off If xmlcommandresult is set to on response for commands will be returned in XML format Exam...

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

Page 39: ...erenceTemplate 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 ConferenceTemplate 1 10 PictureMode 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 16Spl...

Page 40: ...ferenceTemplate 1 10 PhoneIndication On Off ConferenceTemplate 1 10 SpeakerIndication On Off ConferenceTemplate 1 10 VideoText On Off Auto ConferenceTemplate 1 10 VideoTextTimeout 0 30 ConferenceTemplate 1 10 ChairControl On Off ConferenceTemplate 1 10 LectureMode On Off ConferenceTemplate 1 10 Protect On Off ConferenceTemplate 1 10 BandwidthThreshold 64 128 192 256 320 384 512 768 1152 1472 1920 ...

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 Gateway CustomFormats On Off Gateway DuoVideo On Off Gateway Encryption Mode Independent Transparent Gateway Encryption H320 On Off Auto Gateway Encryption H323 On Off Auto Gateway H264 On Off Gateway...

Page 42: ...mber 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 ISDNInterfaceCard 1 6 ISDN PRI NSFTelephony Number 0 31 ISDNInterfaceCard 1 6 ISDN PRI NSFVideoTelephony Mode On Off ISDNInterfaceCard 1 6 ISDN PRI NSFVideoTelephony Number 0 31 ISDNInterfaceCard 1 6 ...

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 ISDNInterfaceCard 1 6 G703 Interface 1 8 Enable On Off ISDNInterfaceCard 1 6 G703 Interface 1 8 IncludeE1Channel16 On Off ISDNInterfaceCard 1 6 G703 Interface 1 8 Call 1 5 StartChannel 0 30 ISDNInterfaceCard...

Page 44: ...scription 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 Auto NetProfile 5 Network H320 H323 SIP Auto NetProfile 6 Network H320 H323 SIP Auto NetProfile 7 Network SIP NTP NTP Address IPv4v6Addr 0 43 AllowNTSCCP AllowNTSCCP On Off PrefixDialIn PrefixDialIn Ad...

Page 45: ...v 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 SerialInterfaceCard SerialInterfaceCard 1 6 Port 1 32 Callcontrol RS366Adtran Dial_Manual SerialInterfaceCard 1 6 Port 1 32 Clocking Dual Single SerialInterfaceCard 1 6 Port 1 32 DTRPulse On Off SerialInterfaceCard ...

Page 46: ...0 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 Authentication Password S 0 60 SIP Interface Transport Default TCP UDP SNMP SNMP Mode On Off ReadOnly TrapsOnly SNMP CommunityName S 0 16 SNMP SystemContact S 0 70 SNMP SystemLocation S 0 70 SNMP HostIPAddr ...

Page 47: ...0 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 will not be available if 1 MPS doesn t have GW option 2 MPS have MCU and GW option ...

Page 48: ...ber 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 NetProfile 1 7 LocalEntry 1 250 NetworkId 1 32 LocalEntry 1 250 NetworkModule 0 6 GroupEntry GroupEntry 1 16 Name S 0 48 GroupEntry 1 16 LocalEntryId 1 32 0 250 ...

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: ...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 CallMoveToQCIF Command used to move a call to QCIF Parameters Call r 1 108 OK Result parameters None ERROR Result parameters Cause 1 Cause code specifying why the command was not accepted by the system Description Textual description of the cau...

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 call to another H 323 party Parameters GatewayCall r 1 80 Number r S 0 60 ERROR Result parameters Cause 1 Cause code specifying why the call was not accepted by the system Description Textual descri...

Page 52: ...sult 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 conferencedisconnect conference 1 r Result status OK r end OK ConferenceModify Command used to modify conference settings Parameters Conference r 1 35 PictureMode Auto VS 2Split 3Split 4Split 4 3Split 5 1Split ...

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 the system Description Textual description of the cause code Example xcommand conferencemodify conference 1 agc on floortofull on r Result status OK r end OK ConferenceRedefine Command used to modif...

Page 54: ...r 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 Off Password S 0 8 PasswordOnOutgoingCalls On Off Encryption On Off EncryptionType DES AES 128 Auto SecondaryRate On Off WelcomeMessage On Off DuoVideo On Off AudioG728 On Off CascadingPreference Auto...

Page 55: ...and 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 parameters None ERROR Result parameters Cause 1 Cause code specifying why the call was not accepted by the system Description Textual description of the cause code ConferenceTerminate Command used to t...

Page 56: ...te 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 768 1152 1472 15 36 1920 Tlph Specifies the callrate to use Restrict On Off NetProfile 1 7 NetworkId 1 32 NetworkModule 1 12 DTMFSend S 0 32 OK Result parameters CallRef 1 96 Reference to the call T...

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 1 groupentryid 19 r Result status OK CallRef 2 LogTag 313 CallRef 1 LogTag 312 CallRef r end OK DialInNumberAdd Command used to add a dial in number Parameters Conference r 1 15 NetProfile r 2 7 Numb...

Page 58: ...l 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 Command used to disconnect a call Parameters Call r 1 176 Reference to the call to be disconnected OK Result parameters None ERROR Result parameters Cause 1 Cause code specifying why the command was not ac...

Page 59: ...urn XML feedback over HTTP S to specific URLs The parts of the Status and Configuration XML documents to monitor are specified by XPath expressions The system supports issuing feedback to 3 different URLs The system allows a total of 20 XPath expressions to be registered with a maximum of 15 for a single URL Parameters ID 1 3 ID for the registration If this parameter is omitted the system uses the...

Page 60: ...loorToSiteEnd 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 Result 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 xcommand floortos...

Page 61: ...the 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 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 t...

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 Reference to the Directory position the entry is stored ERROR Result parameters Cause 1 Cause code specifying why the command was not accepted by the system Description Textual description of the cause cod...

Page 63: ...on 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 to move ToConferenceItem r 1 35 Conference to move to OK Result parameters None ERROR Result parameters Cause 1 Cause code specifying why the command was not accepted by the system Description Textual...

Page 64: ...s 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 CallItem r 1 176 Call to set text to Text S 0 61 The text to set Visible On Off If text is visible OK Result parameters None ERROR Result parameters Cause 1 Cause code specifying why the command was not ac...

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

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 PictureMode Full RequestingPassword Off MuteVideo Off MuteOutgoing Off VideoText System20020 NOR FURBlock Off FURAlert Off LayoutLock Off LayoutLockWindow 0 Channels 1 type Incoming Rate 384 Restrict Of...

Page 67: ...84 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 64 TotalPackets 801652 PacketLoss 1 Jitter 0 Video 1 status Active Protocol H264 Resolution CIF Rate 320 RemoteIPAddress 10 47 20 20 2336 LocalIPAddress 10 47 9 150 2344 Encryption status Off RSVP Of...

Page 68: ...Rate 384 Restrict Off Password PasswordOnOutgoingCalls Off Dynamic On ID Encryption Off EncryptionType Auto WelcomeMessage On DuoVideo On AudioG728 On CascadingPreference Auto BillingCode CPAutoSwitch 0 PictureMode VS VideoFormat Auto CustomFormats On AGC On AllowIncomingCalls On Duration 0 MaxAudioSites 0 MaxVideoSites 0 EntryExitTones On LegacyLevel 0 TelephoneFilter On FloorToFull On WebCallLis...

Page 69: ...llRef 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 Picture RemoteMain CallRef 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 L...

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 On DuoVideo On AudioG728 On CascadingPreference Auto BillingCode CPAutoSwitch 0 PictureMode 4Split VideoFormat Auto CustomFormats On AGC On AllowIncomingCalls On Duration 0 MaxAudioSites 8 MaxVideoSi...

Page 71: ...ress 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 given Feedback ID ref command FeedbackRegister Summary Lists the URL and feedback expressions registered for the given Feedback ID Examples s Feedback 1 status Off s end s Feedback 1 status On URL http...

Page 72: ...tekeeper 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 SubnetMask 255 255 248 0 Description Gateway 10 47 8 1 V6 Address 1 type NA Address 2 type NA DNS Server 1 Address 10 0 0 2 Server 2 Address 127 0 0 1 Server 3 Address 127 0 0 1 Server 4 Address 127 0 0 1 Se...

Page 73: ...emUnit 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 Configuration Telephony 16 VideoTelephony 40 AdvancedVideoOption 40 Encryption 40 PRIPorts 0 SerialPorts 0 MaxBW 30720 ManagedResources Conference 0 Telephony 0 VideoTelephony 0 AdvancedVideoOption ...

Page 74: ...annelsFree 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 Channels 10 type BChannel status Idle Channels 11 type...

Page 75: ...9 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 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 Channels 10 type BChannel status Idle Channels 1...

Page 76: ...CallingNumber 032875677 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels 30 type BChannel status Disconnected CallingNumber 032875677 CauseLocation 2 ChannelCause 17 ConnectionTime 0 Channels 31 type BChannel status Idle 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...

Page 77: ...e 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 status Inactive URI Registration 10 status Inactive URI Registration 11 status Inactive URI Registration 12 status Inactive URI Registration 13 status Inactive URI Registration 14 status Inactive URI Regi...

Page 78: ...on 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 URI Registration 36 status Inactive URI Registration 37 status Inactive URI Registration 38 status Inactive URI Registration 39 status Inactive URI Registration 40 status Inactive URI s end SystemLo...

Page 79: ...n 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 Option 27 Option 28 Option 29 Option 30 Option 31 Option 32 Option 33 Option 34 Option 35 Option 36 Option 37 Option 38 Option 39 Option 40 Option 41 Option 42 Option 43 Option 44 Option 45 Option 46...

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: ...ph 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 DisconnectCause NA Duration 0 UptimeAtEndOfCall 7758 BillingCode l end Conference 1 20 Top level attributes None Summary Returns information about ended conferences Examples l Conference 1 LogTag 1 Name C...

Page 82: ...CallFURErrorAlert FURAlert Rate CallRef LogTag ConferenceRef ConferenceLogTag e end CallMovedFromReception e CallMovedFromReception CallRef LogTag ConferenceRef ConferenceLogTag ServiceType Protocol Direction CallRate RemoteNumber Encryption Incoming Outgoing e end CallStatisticsIP e CallStatisticsIP CallRef LogTag ConferenceRef ConferenceLogTag Duration ...

Page 83: ...ed MaxJitter e end CallSuccessful e CallSuccessful CallRef LogTag ConferenceRef ConferenceLogTag ServiceType Protocol Direction CallRate RemoteNumber Encryption Incoming Outgoing e end DialInError e DialInError IncomingNumber RemoteNumber e end DownspeedingFinished e DownspeedingFinished CallRef LogTag ConferenceRef ConferenceLogTag Rate ...

Page 84: ...82 e end H320Statistics e H320Statistics CallRef LogTag ConferenceRef ConferenceLogTag Duration FramingLoss Last Total BondingReSync Last Total e end SystemActivity e SystemActivity Service RemoteIPAddress Uptime Description e end ...

Reviews:

No comments