English dropdown-ico

TANDBERG MPS API Interface D13639 manual

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

Go to page of

Similar user manuals

A good user manual

The rules should oblige the seller to give the purchaser an operating instrucion of TANDBERG MPS API Interface D13639, along with an item. The lack of an instruction or false information given to customer shall constitute grounds to apply for a complaint because of nonconformity of goods with the contract. In accordance with the law, a customer can receive an instruction in non-paper form; lately graphic and electronic forms of the manuals, as well as instructional videos have been majorly used. A necessary precondition for this is the unmistakable, legible character of an instruction.

What is an instruction?

The term originates from the Latin word „instructio”, which means organizing. Therefore, in an instruction of TANDBERG MPS API Interface D13639 one could find a process description. An instruction's purpose is to teach, to ease the start-up and an item's use or performance of certain activities. An instruction is a compilation of information about an item/a service, it is a clue.

Unfortunately, only a few customers devote their time to read an instruction of TANDBERG MPS API Interface D13639. A good user manual introduces us to a number of additional functionalities of the purchased item, and also helps us to avoid the formation of most of the defects.

What should a perfect user manual contain?

First and foremost, an user manual of TANDBERG MPS API Interface D13639 should contain:
- informations concerning technical data of TANDBERG MPS API Interface D13639
- name of the manufacturer and a year of construction of the TANDBERG MPS API Interface D13639 item
- rules of operation, control and maintenance of the TANDBERG MPS API Interface D13639 item
- safety signs and mark certificates which confirm compatibility with appropriate standards

Why don't we read the manuals?

Usually it results from the lack of time and certainty about functionalities of purchased items. Unfortunately, networking and start-up of TANDBERG MPS API Interface D13639 alone are not enough. An instruction contains a number of clues concerning respective functionalities, safety rules, maintenance methods (what means should be used), eventual defects of TANDBERG MPS API Interface D13639, and methods of problem resolution. Eventually, when one still can't find the answer to his problems, he will be directed to the TANDBERG service. Lately animated manuals and instructional videos are quite popular among customers. These kinds of user manuals are effective; they assure that a customer will familiarize himself with the whole material, and won't skip complicated, technical information of TANDBERG MPS API Interface D13639.

Why one should read the manuals?

It is mostly in the manuals where we will find the details concerning construction and possibility of the TANDBERG MPS API Interface D13639 item, and its use of respective accessory, as well as information concerning all the functions and facilities.

After a successful purchase of an item one should find a moment and get to know with every part of an instruction. Currently the manuals are carefully prearranged and translated, so they could be fully understood by its users. The manuals will serve as an informational aid.

Table of contents for the manual

  • Page 1

    TANDBERG MPS API User Guide TANDBERG D13639 Rev 07 March 2008[...]

  • Page 2

    TANDBERG MPS API User Guide ii Table of Contents User Guide ..................................................................................................................... ............ 1 1 The TAND BERG API ............................................................................................................. . 1 1.1 Introducti on to XM[...]

  • Page 3

    TANDBERG MPS API User Guide 1 1 The T ANDBERG API This document is a guide to the API interf ace of the TANDBERG M PS produ cts. All rights reserved. This document contains information that is proprietary to TANDBERG. No pa rt of this publication may be reproduced, stored in a re trieval system, or transmitted, in any form, or by any means, electro[...]

  • Page 4

    TANDBERG MPS API User Guide 2 1.1 Introduction to XML XML is a markup language for document s co ntainin g structured information. All information elements in an XML document are marked by a tag and a correspondin g 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 (?[...]

  • Page 5

    TANDBERG MPS API User Guide 3 Example 1.3 If we now look at the call element for an active call we see that call element contains a large sub-struct ure: <Status> <Call item="1" status="Synced" type="Vtlph" protocol="H323"> <CallRate item="1">768</CallRate> <RemoteNumber i[...]

  • Page 6

    TANDBERG MPS API User Guide 4 <StopBits item="1">1</StopBits> <Mode item="1">Auto</Mode> </SerialPort> </Configuration>[...]

  • Page 7

    TANDBERG MPS API User Guide 5 1.2 Introduction to XML Path Language (XPath) XPath is a comprehensive langu age to address data in XML documents. It is though very simple to understand the basic s. If yo u are able to specify the path to a file on your computer, you are able to specify t he path to an element in a XML structure. Example 1.5 Let us g[...]

  • Page 8

    TANDBERG MPS API User Guide 6 Example 1.8 XPath also supports addressing by putting constr aint s on element attributes. Let’s go back to the Call element 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 attribut es[...]

  • Page 9

    TANDBERG MPS API User Guide 7 1.3 The TANDBERG XML Engine The TANDBERG XML engine is optimi ze d for advan ce d machine-machine interaction between a TANDBERG system and an external contro l appli c ation. The main features can be summarized to: • Structuring of information • Addressing using XPath • Feedback 1.3.1 Structuring of Informati on[...]

  • Page 10

    TANDBERG MPS API User Guide 8 configuration hierarchie s it want s to monitor by using XPath. The user/control application can therefore limit the amount of information it rece ives from the target system to only those parts being of interest for the given application.[...]

  • Page 11

    TANDBERG MPS API User Guide 9 1.4 The XML Documents 1.4.1 Documents The XML Data in the TANDBERG systems are divid ed 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 doc uments ( r) : Documents holding all available Status Information i[...]

  • Page 12

    TANDBERG MPS API User Guide 10 <RemoteIPAddress item="1" /> <LocalIPAddress item="1">10.47.8.41:2326</LocalIPAddress> <Encryption item="1" status="On"> <Type item="1">AES-128</Type> </Encryption> <RSVP item="1">Off</RSVP> <RSVPRate i[...]

  • Page 13

    TANDBERG MPS API User Guide 11 Example 10 From the XML structure below we see that the BaudRate element of SerialPort[1] is configured to 9600 . The BaudRate element references the SerialPortBaudrate element in the ValueSpace document, showing the value domain for this configu ration . <Configuration>> <SerialPort item="1">[...]

  • Page 14

    TANDBERG MPS API User Guide 12 <CallRate item="1" required="False" valueSpaceRef="/ValueSpace/Bandwidth"/> <Restrict item="1" required="False" valueSpaceRef="/ValueSpace/OnOff"/> <NetProfile item="1" required="False" valueSpaceRef="/ValueSpace/Netpro[...]

  • Page 15

    TANDBERG MPS API User Guide 13 Example 14 Below is an example of the Dial comm and, 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[...]

  • Page 16

    TANDBERG MPS API User Guide 14 1.5 Introduction to TANDBERG XML API Service (TXAS) TXAS is a service provided by TANDBERG units for transmitting and rece iving (transceiving) information encoded in XML format. The API uses HTTP(S) as the transport mech ani sm and connects to the normal web port (80). TXAS can be accessed in two ways; bare-bone HTTP[...]

  • Page 17

    TANDBERG MPS API User Guide 15 1.6 Exercises The exercises in this section are based on using a TANDBERG 6000 MXP codec and Microsoft Internet Explorer. Some of the exam ples may however also apply to other systems and other browsers. NOTE! Replace the ip address, 10.47.8.41, in the bel ow exampl es with the ip address of your system. Exercise 1 Th[...]

  • Page 18

    TANDBERG MPS API 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> --- <[...]

  • Page 19

    TANDBERG MPS API User Guide 17 2 The XML-based Advanced Command Line Interface The XML-based Advanced Command Line Interfa c e, XACLI, is a very flexible interface both optimized for machine-machine interacti on and man-machine interaction. It is based on the powerful TANDBERG XML engine and offers many of the same features as the T A NDBERG XML in[...]

  • Page 20

    TANDBERG MPS API User Guide 18 2.1 XACLI 2.1.1 Accessing XACLI XACLI can be accessed through Telnet via the LA N interface or th rough RS-232 by connecting a serial cable to the serial interface co nn ector, referred to as the Dataport . 48 Telnet sessions can be active at the same time in addition to the RS-232 con nection. 2.1.2 Root commands For[...]

  • Page 21

    TANDBERG MPS API User Guide 19 2.1.4 Exposure options By adding an exposure option after the address (XPa t h or SimplePath) expression, the system can be instructed to return only parts of t he information within an element structu r e. <root command> <ad dress expression> <exposure option> Supported exposure options: • “-“[...]

  • Page 22

    TANDBERG MPS API User Guide 20 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=Inactive): / *s/end Request fo r Call 1 element with exposure option ?[...]

  • Page 23

    TANDBERG MPS API User Guide 21 2.2 The Status-type root commands – xstatus / xhistory The information accessible through thes e comm and s is the exact same information that is available in the corresponding XML docu ments. To get an overview of accessible top-level el ements within a status-type root com mand, type ? or help after the status-typ[...]

  • Page 24

    TANDBERG MPS API User Guide 22 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 statu s el ement, IP[...]

  • Page 25

    TANDBERG MPS API User Guide 23 2.3 The Configuration-type root commands - xconfiguration/xdirectory The information accessible through thes e comm and s is the exact same information that is available in the corresponding XML docu ments. To get an overview of accessible t op-level configurati on elements, type ? or help after the configuration-type[...]

  • Page 26

    TANDBERG MPS API User Guide 24 <configuration-type root command> <address expr> ?/help Example 2.7 User wants to configure IP: xconfiguration ip ? *h xConfiguration IP Assignment: <DHCP/Static> *h xConfiguration IP Address: <IPAddr> *h xConfiguration IP SubnetMask: <IPAddr> *h xConfiguration IP Gateway: <IPAddr> [...]

  • 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

    TANDBERG MPS API User Guide 26 2.4 The Command-type root commands - xcommand To get an overview of the supported commands within a comm and-type root command, type ? or help after the command-type root command. <command-type root command> ? Example 2.10 xcommand ? - User Commands - Boot DuoVideoStart MessageBoxDisplay CallAccept DuoVideoStop [...]

  • Page 29

    TANDBERG MPS API User Guide 27 Example 2.12 xcommand Dial ? *h xCommand Dial Number(r): <S: 0, 30> SubAddress: <S: 0, 10> CallRate: <1xh221/2xh221/64/128/256... Restrict: <On/Off> NetProfile: <1..6> OK NOTE! Required pa ram eters are identified by an “(r)” behind the parameter name. 2.4.2 Issui ng a com mand A command[...]

  • Page 30

    TANDBERG MPS API User Guide 28 Sequence notation <command-type root command> <c ommand> <value> <value>... When using this notation the parameter values must be entered in the seq uence as stated in the help text: Example 2.16 xcommand dial 666 10 128 on Combination A combin ation of mark-up notation and seq uence are also s[...]

  • Page 31

    TANDBERG MPS API User Guide 29 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 expressio n as parameter and the elements (or complete document) matching the expression will be returned. Example 2.19 xgetxml status/ip <Status> <[...]

  • Page 32

    TANDBERG MPS API User Guide 30 2.6 Special Commands In addition to the root commands described ab ove, XACLI support a set of root commands that only applies to the Telnet session or RS232 sessio n from where they are issued. This lets the user/control application individually configure the se ssion(s) in use. Supported special comma nds: • xfeed[...]

  • Page 33

    TANDBERG MPS API User Guide 31 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=OK): CallRef: 1 LogTag: 3 *r/end O[...]

  • Page 34

    TANDBERG MPS API User Guide 32 *s/end xcom disc *r Result (status=OK): / *r/end OK NO CARRIER *s Call 1 (status=Disconnected, type=NA, protocol=NA, direction=NA): *s/end When conditional XPath expressio ns 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 m[...]

  • Page 35

    TANDBERG MPS API User Guide 33 Rate: 768 Restrict: Off Encryption (status=Off): / Audio (status=Active): Protocol: G722 Rate: 64 Video 1 (status=Active): Protocol: H263+ Resolution: ICIF Rate: 704 Video 2 (status=Inactive): / Data (status=Inactive): / *s/end …suddenly there is a change in audi o protocol: *s Call 1 (status=Synced, type=Vtlph, pro[...]

  • Page 36

    TANDBERG MPS API User Guide 34 xpreferences detaillevel <1..2> Most information elements acce ssi ble by t he status-type root commands are defined to be level1 information. However there are some info rmation eleme nts which are defined to be level2 information. When reading status information, only the information element s with a detail le[...]

  • Page 37

    TANDBERG MPS API User Guide 35 <BaudRate item="1">2400</BaudRate> </SerialPort> </Configuration> xpreferences xmlstatusfeedback <on/off> If xmlstatusfeedback is set to on, all status feedback will be retu rned in XML-format instead of the standard XACLI status format. Example 2.26 XACLI-format: *s Call 1 (sta[...]

  • Page 38

    TANDBERG MPS API User Guide 36 3 API - Configurations This section gives an overview of the Configuration Informatio n available in the Configuration XML documents ( configuration.xml / directory.xm l ) and the Configuration root commands ( xconfiguration / xdirectory ) of the XACLI interface. All examples are presented using the st anda rd XACLI f[...]

  • Page 39

    TANDBERG MPS API User Guide 37 3.1 configuration.xml – xconfiguration AllowIncomingTlphCall AllowIncomingTlphCall: <On/Off> Conference Conference [1..35] Numbers E164Alias: <E1 64: 0, 31> Conference [1..35] Numbers PRI: <S: 0, 60> Conference [1..35] Numbers H323ID: <S: 0, 50 > Conference [1..35] Numbers SIP URI: <S: 0, [...]

  • Page 40

    TANDBERG MPS API User Guide 38 ConferenceTemplate [1..10] EntryE xitTones : <On/Off> ConferenceTemplate [1..10] WelcomeMessage: <On/Off> ConferenceTemplate [1..10] Legacy Level: <0..15> ConferenceTemplate [1..10] DuoVideo : <On/O ff> ConferenceTemplate [1..10] AudioG728: <On/Off> ConferenceTemplate [1..10] CascadingPre[...]

  • Page 41

    TANDBERG MPS API User Guide 39 <Off/Normal/High> ConferenceTemplate [1..10] OptimalVideoQu ality : <On/Off> ConferenceTemplate [1..10] EncoderS electionPoli c y: <BestBitRate/BestVideoStandard/Be stResolution> ConferenceTemplate [1..10] Band w idthManagement: <Manual/Auto> ConferenceTemplate [1..10] WebSnapshots: <On/ Off[...]

  • Page 42

    TANDBERG MPS API User Guide 40 H323Gatekeeper [1..2 ] Authentication Password: <S: 0, 50> HTTP HTTP Mode: <On/Off> HTTPS HTTPS Mode: <On/Off> IPProtocol IPProtocol: <IPv4/IPv6/Both> IP IP [1..2] Address: <S: 0, 15> IP [1..2] SubnetMask: <S: 0, 15> IP [1..2] Gateway: <S: 0, 15> IP [1..2] DNS Server [1..5] Ad[...]

  • Page 43

    TANDBERG MPS API User Guide 41 ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] MaxChannels: <1..30> ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] HighChannel: <1..31> ISDNInterfaceCard [1..6] ISDN PRI Interface [1..8] LowChannel: <1..31> ISDNInterfaceCard [1..6] I SDN PRI Interface [1..8] Search: <High/Low> ISDNInter[...]

  • Page 44

    TANDBERG MPS API User Guide 42 LoS Polarity: <Positive/Negative> LoS Retry: <0..65535> MCU MCU AdditiveRegEnable: <On/Off> MCU H264: <On/Off> MCU H264RCDO: <On/Off > MediaBoard MediaBoard [1..12] IP Address: <IPAddr> MediaBoard [1..12] IP SubnetMask: <I PAddr > MediaBoard [1..12] IP Gateway: <IPAddr> [...]

  • Page 45

    TANDBERG MPS API User Guide 43 QoS [1..2] Precedence Telephony Signalling: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Precedence VideoTelephony Audio: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Precedence VideoTelephony Signalling: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1..2] Precedence VideoTelephony Video: <0/1/2/3/4/5/6/7/Auto/Off> QoS [1[...]

  • Page 46

    TANDBERG MPS API User Guide 44 SingleNumberDialIn SingleNumberDialIn Activ e: <On/Off> SingleNumberDialIn Numbers ISDN: <S: 0, 60> SingleNumberDialIn Numbers IP: <S: 0, 60> SingleNumberDialIn Numbers H323Alias: <E164 : 0, 31> SingleNumberDialIn Numbers H323ID: <S: 0, 50> SingleNumberDialIn Numbers SIP: <S: 0, 60>[...]

  • Page 47

    TANDBERG MPS API User Guide 45 Default IpConfe rence: < 0..15> TerminalSyncLossTimer: <5..90> 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> * Th[...]

  • Page 48

    TANDBERG MPS API User Guide 46 3.2 directory.xml – xdirectory LocalEntry LocalEntry [1..250] Name: <S: 0, 48> LocalEntry [1.. 250] Number: <S: 0, 60> LocalEntry [1.. 250] SecondNumb er: <S: 0, 60> LocalEntry [1.. 250] SubAddress : <S: 0, 60> LocalEntry [1.. 250] CallRate: <1xh221/2xh221/64/128/192/256/3 20/3 84/512/768/[...]

  • Page 49

    TANDBERG MPS API User Guide 47 4 API - Commands This section gives an overview of the su pported system Commands. All examples are presented using the st andard XACLI format.[...]

  • Page 50

    TANDBERG MPS API User Guide 48 4.1 command.xml – xcommand Boot Command used to reboot the system. Parameters: None OK Result parameters: None ERROR Result parame te rs: • Cause: <1…> Cause code specifying why the command wa s not accepted by the system • Description Textual description of the cause code. Example: xcommand boot *r Resu[...]

  • Page 51

    TANDBERG MPS API User Guide 49 • Cause: <1…> Cause code specifying why the command wa s not accepted by the system • Description Textual description of the cause code. Example: xcommand callmute call:2 mode:on *r Result (status=OK): *r/end OK CallMuteOutgoing Command used to mute outgoing audio from a specific call. Parameters: • Call[...]

  • Page 52

    TANDBERG MPS API User Guide 50 CallMuteVideo Command used to mute incoming video from a spe c ific call. Parameters: • Call(r): <1..128> Reference to the call to be muted or unmuted. • Mode(r): <On/Off> Denotes whether video is to be muted or unmuted. OK Result parameters: None ERROR Result parame te rs: • Cause: <1…> Caus[...]

  • Page 53

    TANDBERG MPS API User Guide 51 • EntryExitTones: <On/Off> • LegacyLevel: <0..15> • TelephoneFilter: <On/Off> • FloorToFull: <On/Off> • BandwidthThreshold: <64/128/192/256/320/384/512/76 8/1152/1472/1920> • WebCallListTimeout: <On/Off> • PhoneIndication: <On/Off> • SpeakerIndication: <On/O[...]

  • Page 54

    TANDBERG MPS API User Guide 52 • AudioG728: <On/Off> • CascadingPreference: <Auto/Ma ster/Slav e> • BillingCode: <S: 0, 16> • CPAutoS witch: <0..60> • NetworkId: <1..32> • ConferenceSelfvie w: <On/Off> • Protect: <On/Off> • TemplateReference: <1..10> • HDEnabled: <On/Off> OK Re[...]

  • Page 55

    TANDBERG MPS API User Guide 53 • Description Textual description of the cause code. Example: xcommand conferencestart conference:1 *r Result (status=OK): *r/end OK ConferenceStop Command used to stop a conference. All active calls must be disconnected prior to stopping the co nference. Parameters: • Conference(r): <1..35> OK Result parame[...]

  • Page 56

    TANDBERG MPS API User Guide 54 *r/end OK DefaultValuesSet Command used to reset configuratio ns to default values. Parameters: • Level: <1..3> Configurations are divided into three different storage classes. The level parameter den otes that configu rati ons o n this level and all levels below are to be reset. OK Result parameters: None ERR[...]

  • Page 57

    TANDBERG MPS API User Guide 55 OK DialGroupEntry Command used to dial an entry from the Grou p Directory. Dialing from the Group Directory makes it possible to se t up a MultiSite conference in one operation. Parameters: • Conference(r): <1..35> • GroupEntryId(r): <1.. 16> Reference to the directory entry to be dialed. OK Result par[...]

  • Page 58

    TANDBERG MPS API User Guide 56 • Cause: <1…> Cause code specifying why the call was not accepte d by the system • Description Textual description of the cause code. DialLocalEntry Command used to dial a number from the locally stored dire cto ry. Parameters: • Conference(r): <1..35> • LocalEntryI d(r): <1..9 9> Reference[...]

  • Page 59

    TANDBERG MPS API User Guide 57 accepted by the system • Description Textual description of the cause code. Example: xcommand disconnectgwcall gatewaycall:1 *r Result (status=OK): *r/end OK FeedbackDeregister Command used to deregist er XML feedback over HTTP(S). Parameters: • ID: <1..3> ID for the registration to deregister. OK Result par[...]

  • Page 60

    TANDBERG MPS API User Guide 58 *r/end OK FloorToSite Command u sed to assign floor to a specific site in a conference. Parameters: • Conference(r): <1..35> • MCUID(r): <1..191 > M CUID to the MultiSite the site is connected to. • TerminalID(r): <1..191> The site’s terminal id, referenced to the MultiSite it is connected to[...]

  • Page 61

    TANDBERG MPS API User Guide 59 • GroupEntryId: <1..16> Reference to the Group Dire ctory position the entry is stored. ERROR Result parame te rs: • Cause: <1…> Cause code specifying why the command wa s not accepted by the system • Description Textual description of the cause code. Example: xcommand groupentryadd name:”The Tea[...]

  • Page 62

    TANDBERG MPS API User Guide 60 • Window(r): <1..16> • CallID(r): <1..176> Call. ERROR Result parame te rs: • Cause: <1…> Cause code specifying why the command wa s not accepted by the system • Description Textual description of the cause code. LocalEntryAdd Command us ed to add a n ew entry to the locally stored Director[...]

  • Page 63

    TANDBERG MPS API User Guide 61 *r Result (status=OK): *r/end OK OptionKeyAdd Comm and u sed to add option key. Parameters: • Key(r): <S: 0, 90> Opt ion key string OK Result parameters: None ERROR Result parame te rs: • Cause: <1…> Cause code specifying why the command wa s not accepted by the system • Description Textual descrip[...]

  • Page 64

    TANDBERG MPS API User Guide 62 ProtectNumberRemove Command used to remove a protect num ber. Parameters: • Conference(r): <1..15> Conferen ce to remov e number • NetProfile(r): <2..7> Net Profile to remove • Number(r): <S: 0, 60> Number to remov e OK Result parameters: None ERROR Result parame te rs: • Cause: <1…> [...]

  • Page 65

    TANDBERG MPS API User Guide 63 5 API - S t atus This section gives an overview of the Status Information available i n the Status XML documents (status.xml / history.xml) and the Status root comma nd s (xstatus / xhistory) of the XACLI interface. All examples are presented using the st anda rd XACLI format.[...]

  • Page 66

    TANDBERG MPS API User Guide 64 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/P[...]

  • Page 67

    TANDBERG MPS API User Guide 65 LocalIPAddress: "10.47.9.150:2344" Encryption (status=Off): / RSVP: Off RSVPRate: 0 DynamicRate: 157 TotalPackets: 476674 PacketLoss: 1 Jitter: 10 Video 2 (status=Active): Protocol: H263+ Resolution: XGA Rate: 160 RemoteIPAddress: "" LocalIPAddress: "10.47.9.150:2346" Encryption (status=O[...]

  • Page 68

    TANDBERG MPS API User Guide 66 Conference [1..40] Top level attributes: • status: NotStarted/Started/Activ e Summary: • Includes references to the calls being conne c ted to the conference • DuoVideo status • Includes information about the pictures gene rated by the MultiSite • Cascading status • MCU Site list • On Air information Exa[...]

  • Page 69

    TANDBERG MPS API User Guide 67 FarTlphEchoSupression: Normal NetErrorHandling: None IPLRRobustMode: Auto FURBlockSites: Auto FURFilterInterval: 3 HDEnabled: Off VoiceSwitchTimeout: 2 OptimalVideoQuality: On/Off EncoderSelectionPolicy: BestBitRate/BestVideoStandard BandwidthManagement: Auto/Manual WebSnapshots: On/Off AutoAspectRatio4x3: Off *s/end [...]

  • Page 70

    TANDBERG MPS API User Guide 68 Picture: NA CallRef: None Window 6: Picture: NA CallRef: None OutgoingPicture 3 (name=Duo): Layout (type=NA): / PictureModeActual: Full MCUID: 1 CascadingMode: StandAlone MCUSiteList: Site 1: MCUID: 1 TerminalID: 2 Name: "System1" CallRef: 1 Site 2: MCUID: 1 TerminalID: 3 Name: "System2" CallRef: 2[...]

  • Page 71

    TANDBERG MPS API User Guide 69 PhoneIndication: On SpeakerIndication: On VideoText: On VideoTextTimeout: 5 ChairControl: Off LectureMode: Off Protect: Off VideoCodingMode: Transcoding SecondaryRate: Off FarTlphEchoSupression: Normal NetErrorHandling: None IPLRRobustMode: Auto FURBlockSites: Auto FURFilterInterval: 3 HDEnabled: Off VoiceSwitchTimeou[...]

  • Page 72

    TANDBERG MPS API User Guide 70 *s/end H323Gat ekeepe r [1..2] Top level attributes: • status:Required/Discov ering/ Discovered/Authenticating/ Authenticated/Registering/Regis tered/Rejected/Inactiv e Summary: • Returns H323Gatekeeper status Examples: *s H323Gatekeeper 1 (status=Inactive): / *s/end *s H323Gatekeeper 1 (status=Registered): Addres[...]

  • Page 73

    TANDBERG MPS API User Guide 71 Example *s MediaBoard 1: TemperatureCelcius: 30 TemperatureFahrenheit: 86 Description: "" IP: Address: "10.47.9.106" SubnetMask: "255.255.248.0" Gateway: "10.47.8.1" V6: Address 1 (type=NA): "" Address 2 (type=NA): "" Ethernet: MacAddress: "00:50:60:00:E[...]

  • Page 74

    TANDBERG MPS API User Guide 72 SerialNumber: "44a00003" MainBoard: "113637 MCP 820 System Controller" BootSoftware: "PPCBUG" Used: Total: Conference: 2 Telephony: 0 VideoTelephony: 1 BChanPRI: 0 Bandwidth: 384 Gateway: GatewayCall: 0 BChanPRI: 0 MCU: Conference: 2 Telephony: 0 VideoTelephony: 1 Bandwidth: 384 BChanPRI:[...]

  • Page 75

    TANDBERG MPS API User Guide 73 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): Calli[...]

  • Page 76

    TANDBERG MPS API User Guide 74 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 Connect[...]

  • Page 77

    TANDBERG MPS API User Guide 75 State: RedAlarm *s/end ExternalManager *s ExternalManager: Address: "10.47.1.10" Protocol: URL: "tms/public/external/management/SystemManagementServ ice.asmx" *s/end NTP *s NTP: Address: "127.0.0.1" *s/end SIP *s SIP: Mode: On Interface: Server (status=Active): Address: "10.47.8.88&q[...]

  • Page 78

    TANDBERG MPS API User Guide 76 URI: "" Registration 21 (status=Inactive): URI: "" Registration 22 (status=Inactive): URI: "" Registration 23 (status=Inactive): URI: "" Registration 24 (status=Inactive): URI: "" Registration 25 (status=Inactive): URI: "" Registration 26 (status=Inactive): U[...]

  • Page 79

    TANDBERG MPS API User Guide 77 Options *s Options: Option 1: Key: "****" Description: "40 video telephony ports + 16 telephony ports." Option 2: Key: "****" Description: "Advanced Video Option on 40 sites." Option 3: Key: "****" Description: "Encryption on 40 sites." Option 4: / Option 5: [...]

  • 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

    TANDBERG MPS API User Guide 79 5.2 history.xml – xhistory Call [1..96] Top level attributes: • type: Tlph/Vtlph • protocol: H320/H323/SIP • direction: Incoming/Outgoing • PartOf: Conference/Gate w ayCall Summary: • Returns information about disconne cted calls Examples: *l Call 1 (type=Vtlph, protocol=H323, direction=Outgoing, PartOf=Co[...]

  • Page 82

    TANDBERG MPS API User Guide 80 5.3 Event.xml – xevent AuthenticationFailure *e AuthenticationFailure: Service: / RemoteIPAddress: / Uptime: / *e/end CallFURErrorAlert *e CallFURErrorAlert: FURAlert: / Rate: / CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / *e/end CallMovedFromReception *e CallMovedFromReception: CallRef: / LogTag: / Con[...]

  • Page 83

    TANDBERG MPS API User Guide 81 Incoming: Audio: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / Video: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / *e/end CallSuccessful *e CallSuccessful: CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / ServiceType: / Protocol: / Direction: / CallRate: / RemoteNumber: / Encryp[...]

  • Page 84

    TANDBERG MPS API User Guide 82 *e/end H320Statis tics *e H320 Statist ics: CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / Duration: / FramingLoss: Last: / Total: / BondingReSync: Last: / Total: / *e/end SystemActiv ity *e SystemActivi ty : Service: / RemoteIPAddress: / Uptime: / Description: / *e/end[...]