Manuale d’uso / di manutenzione del prodotto MPS API Interface D13639 del fabbricante TANDBERG
Vai alla pagina of 84
TANDBERG MPS API User Guide TANDBERG D13639 Rev 07 March 2008.
TANDBERG MPS API User Guide ii Table of Contents User Guide ..................................................................................................................... ............ 1 1 The TAND BERG API ......................................
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.
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, “/”.
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" sta.
TANDBERG MPS API User Guide 4 <StopBits item="1">1</StopBits> <Mode item="1">Auto</Mode> </SerialPort> </Configuration>.
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.
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.
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.
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.
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.
TANDBERG MPS API User Guide 10 <RemoteIPAddress item="1" /> <LocalIPAddress item="1">10.47.8.41:2326</LocalIPAddress> <Encryption item="1" status=&qu.
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 .
TANDBERG MPS API User Guide 12 <CallRate item="1" required="False" valueSpaceRef="/ValueSpace/Bandwidth"/> <Restrict item="1" required="False".
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"> <.
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).
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.
TANDBERG MPS API User Guide 16 <SerialPort> <BaudRate>2400</BaudRate> </SerialPort> <Conference> <H263>Off</H263> <Downspeed>Off</Downspeed> </Conference> </Configuration> --- <Command> <Dial> <Number>10.
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.
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.
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.
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 (stat.
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.
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.
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.
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.
TANDBERG MPS API User Guide 25 Example 2.9 User wants to set IP assignment: xconfiguration ip assignment: static or xconfiguration ip/assignment: static.
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.
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.
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.
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.
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.
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.
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.
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 Vid.
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.
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.
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.
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.
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.
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..
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.
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.
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.
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.
TANDBERG MPS API User Guide 44 SingleNumberDialIn SingleNumberDialIn Activ e: <On/Off> SingleNumberDialIn Numbers ISDN: <S: 0, 60> SingleNumberDialIn Numbers IP: <S: 0, 60> SingleNum.
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.
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.
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.
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.
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.
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.
TANDBERG MPS API User Guide 51 • EntryExitTones: <On/Off> • LegacyLevel: <0..15> • TelephoneFilter: <On/Off> • FloorToFull: <On/Off> • BandwidthThreshold: <64/128/.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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 ER.
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.
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.
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.
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.
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 • Duo.
TANDBERG MPS API User Guide 67 FarTlphEchoSupression: Normal NetErrorHandling: None IPLRRobustMode: Auto FURBlockSites: Auto FURFilterInterval: 3 HDEnabled: Off VoiceSwitchTimeout: 2 OptimalVideoQuali.
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: StandAlon.
TANDBERG MPS API User Guide 69 PhoneIndication: On SpeakerIndication: On VideoText: On VideoTextTimeout: 5 ChairControl: Off LectureMode: Off Protect: Off VideoCodingMode: Transcoding SecondaryRate: O.
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 .
TANDBERG MPS API User Guide 71 Example *s MediaBoard 1: TemperatureCelcius: 30 TemperatureFahrenheit: 86 Description: "" IP: Address: "10.
TANDBERG MPS API User Guide 72 SerialNumber: "44a00003" MainBoard: "113637 MCP 820 System Controller" BootSoftware: "PPCBUG" Used: Total: Conference: 2 Telephony: 0 Video.
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=Id.
TANDBERG MPS API User Guide 74 CauseLocation: 2 ChannelCause: 17 ConnectionTime: 0 Channels 26 (type=BChannel, status=Disconnected): CallingNumber: "061336971" CauseLocation: 2 ChannelCause:.
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.
TANDBERG MPS API User Guide 76 URI: "" Registration 21 (status=Inactive): URI: "" Registration 22 (status=Inactive): URI: "" Registration 23 (status=Inactive): URI: ".
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.
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: / .
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/.
TANDBERG MPS API User Guide 80 5.3 Event.xml – xevent AuthenticationFailure *e AuthenticationFailure: Service: / RemoteIPAddress: / Uptime: / *e/end CallFURErrorAlert *e CallFURErrorAlert: FURAlert:.
TANDBERG MPS API User Guide 81 Incoming: Audio: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / Video: TotalPackets: / PacketLoss: / PacketsDropped: / MaxJitter: / *e/end CallSuccessful *.
TANDBERG MPS API User Guide 82 *e/end H320Statis tics *e H320 Statist ics: CallRef: / LogTag: / ConferenceRef: / ConferenceLogTag: / Duration: / FramingLoss: Last: / Total: / BondingReSync: Last: / To.
Un punto importante, dopo l’acquisto del dispositivo (o anche prima di acquisto) è quello di leggere il manuale. Dobbiamo farlo per diversi motivi semplici:
Se non hai ancora comprato il TANDBERG MPS API Interface D13639 è un buon momento per familiarizzare con i dati di base del prodotto. Prime consultare le pagine iniziali del manuale d’uso, che si trova al di sopra. Dovresti trovare lì i dati tecnici più importanti del TANDBERG MPS API Interface D13639 - in questo modo è possibile verificare se l’apparecchio soddisfa le tue esigenze. Esplorando le pagine segenti del manuali d’uso TANDBERG MPS API Interface D13639 imparerai tutte le caratteristiche del prodotto e le informazioni sul suo funzionamento. Le informazioni sul TANDBERG MPS API Interface D13639 ti aiuteranno sicuramente a prendere una decisione relativa all’acquisto.
In una situazione in cui hai già il TANDBERG MPS API Interface D13639, ma non hai ancora letto il manuale d’uso, dovresti farlo per le ragioni sopra descritte. Saprai quindi se hai correttamente usato le funzioni disponibili, e se hai commesso errori che possono ridurre la durata di vita del TANDBERG MPS API Interface D13639.
Tuttavia, uno dei ruoli più importanti per l’utente svolti dal manuale d’uso è quello di aiutare a risolvere i problemi con il TANDBERG MPS API Interface D13639. Quasi sempre, ci troverai Troubleshooting, cioè i guasti più frequenti e malfunzionamenti del dispositivo TANDBERG MPS API Interface D13639 insieme con le istruzioni su come risolverli. Anche se non si riesci a risolvere il problema, il manuale d’uso ti mostrerà il percorso di ulteriori procedimenti – il contatto con il centro servizio clienti o il servizio più vicino.
