TANDBERG 3 Manual do Utilizador Página 1

Reference guide Codian Remote Management API Document version 3.0 September 2008

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 6 3. If there is an enumerateID, the client should call the enumerate method agai

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 7 Operator Description - Unary minus + Unary plus ! Logical negation ~ Bitwise

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 8 3 Messages supported by multiple product types The methods in this section are

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 9 Field Type Comments domainName (optional) String The domain name of this por

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 10 The "log" array consists of structures which contain the following fi

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 11 Response Type Comments currently configured SIP proxy. conferenceRegistration

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 12 Field Type Comments name String Endpoint name. address String IP address. e1

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 13 This method returns: Response Type Comments enumerateID (optional) String T

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 14 4 Conference related methods Methods in this section are only implemented on p

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 15 Parameter Type Comments reservedVideoPorts (optional) Integar repetition(opt

Copyright © TANDBERG 2008 TANDBERG Philip Pedersens vei 20 1366 Lysaker Norway Telephone: +47 67 125 125

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 16 Parameter Type Comments chairControl (optional) String The chair control se

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 17 Parameter Type Comments weekDays String terminationType String terminationDat

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 18 Valid expressions within the enumerate filter are as follows: Expression Type

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 19 Field Type Comments layout is enabled. newParticipantsCustomLayout Boolean

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 20 4.6 conference.streaming.query This returns some details on the current state

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 21 height (optional) Integer This method will return a fault code of "no su

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 22 4.9 conference.paneplacement.modify Modifies the pane placement configuration

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 23 Parameter Type Comments (optional) the only protocols that the API can curre

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 24 Parameter Type Comments form suitable for a widescreen (16:9) display. videoT

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 25 4.12 participant.modify Depending on the operationScope parameter below, this c

Copyright © TANDBERG 2008 Contents1 Introduction ...

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 26 Parameter Type Comments important (optional) Boolean This setting should no

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 27 Parameter Type Comments participantProtocol String participantType String new

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 28 Field Type Comments participantType String conferenceName String autoAttendan

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 29 Field Type Comments address String gatewayAddress String The address used to

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 30 Field Type Comments audioRxGainMillidB Integer Only present if the audioRxGai

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 31 Field Type Comments callIdentifier base64 The h323 id of this caller. borde

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 32 Parameter Type Comments verticalPosition (optional) String Specifies where t

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 33 This method returns: Response Type Comments enumerateID(optional) String T

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 34 5 IP VCR methods Methods in this section are present only where the product su

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 35 5.3 recording.delete This method deletes a recording from the IP VCR. Paramet

Copyright © TANDBERG 2008 6 ISDN Gateway methods ...

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 36 5.5 recording.stop This method stops a recording in progress on the IP VCR so

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 37 Field Type Comments pointToPointIncomingPrefix String pointToPointOutgoingPre

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 38 6 ISDN Gateway methods The following methods are present on ISDN gateway produ

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 39 6.2 calls.active.enumerate Returns a list of all currently active calls on the

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 40 The calls structure contains the following members: Field Type Comments uni

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 41 Response Type Comments the search order is low to high. directoryNumber Stri

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 42 7 IP Gateway methods The following methods are present on the IP GW 3500 Serie

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 43 8 Deprecated messages These messages were supported in version 1.0 of the MCU

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 44 Response Type Comments displayName String The name used by the endpoint to

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 45 Response Type Comments deferConnection Boolean displayName string The nam

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 1 1 Introduction This document contains the specification of the TANDBERG Codian

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 46 Response Type Comments participant - see appendix A. This parameter will be p

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 47 9 Related information sources 9.1 system.xml While not strictly part of the X

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 48 10 Required user privileges The following table summarises which users are per

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 49 11 Fault codes The MCU has a series of fault codes which are given when a faul

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 50 Fault Code Description correct type, but falls outside the valid values; for ex

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 51 12 Participant disconnect reasons These are the possible values of the “discon

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 52 13 References [1] XML-RPC, http://www.xmlrpc.com/ [2] RFC 2616, http://www.f

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 53 Appendix A - Conference layouts The participant.add and participant.modify meth

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 54 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 55 Appendix B - Linking conferences across MCUs For the purposes of this descripti

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 2 2 Protocol overview 2.1 Authentication In order to manage the device, the cont

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 56 <string>admin</string> </value>

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 57 B.3 Example message 3 - calling into "linked2" from "linked1&quo

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 58 B.4 Example message 4 - setting the new "linked2" participant to use

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 59 B.5 Message responses The response to each of the above method invocations shou

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 60 Appendix C - Revision Numbers Note: This feature is available from API version

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 61 There are two solutions to this problem; the first is the listAll parameter and

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 62 Appendix D - HTTP Keep-alives Note: This feature is available from API version

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 3 <member> <name>durationSeconds</name> <value> <int>

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 4 </member> <member> <name>faultString</n

Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 5 2.4.2 Participant identification parameters The following parameters appear in