Page 3 - Contents
Copyright © TANDBERG 2008 Contents 1 Introduction ...................................................................................................................................... 1 1.1 HTTP and HTTPS .................................................................................................
Page 5 - Introduction; API Version; HTTP and HTTPS
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 1 1 Introduction This document contains the specification of the TANDBERG Codian Remote Management API, by which it is possible to control several Codian products. This is accomplished via messages sent using the XML-RPC protocol. XML-RPC...
Page 6 - Protocol overview; Authentication
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 controlling application must authenticate itself as a user with relevant privileges. Accordingly, each message contains a user name and password; see section 2.4....
Page 8 - Unicode support; HTTP Headers; Common message elements
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 4 </member> <member> <name>faultString</name> <value> <string>duplicate conference name</string> </value> </member> </struct> </value> </fault> </methodResponse>...
Page 9 - Participant identification parameters; Enumerate functions
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 5 2.4.2 Participant identification parameters The following parameters appear in the majority of conference control messages, and identify a specific participant on which operations are to be performed. The use of “MCU” below refers to an...
Page 10 - Filtering
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 again, with any parameters that are required or desired, and an enumerateID parameter containing the ID returned by the device from the previous call. This shou...
Page 12 - Messages supported by multiple product types
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 common to many devices, including video conferencing servers, IP VCR products, ISDN GW products, and IP GW products. Not all methods are supported by all pro...
Page 15 - addressBookEntry.enumerate
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 11 Response Type Comments currently configured SIP proxy. conferenceRegistration String This value is only present if the device being queried is an MCU. It will be enabled if the MCU is configured to register conferences’ numeric IDs wit...
Page 18 - Conference related methods; Parameter
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 14 4 Conference related methods Methods in this section are only implemented on products, such as the Codian MCU 4200 series, which act as a video conferencing server. Throughout this section, the term MCU refers to any such device. 4.1 c...
Page 21 - conference.enumerate
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 17 Parameter Type Comments weekDays String terminationType String terminationDate dateTime.iso8601 numberOfRepeats Integer h239Important Boolean Optional. Sets the h239 channel to be important. locked Boolean Optional. Locks or unlocks th...
Page 30 - participant.disconnect
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 26 Parameter Type Comments important (optional) Boolean This setting should not be present if operationScope is "configuredState". Specifies whether this participant is important. audioTxMuted Boolean This setting should not be pr...
Page 31 - participant.enumerate
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 27 Parameter Type Comments participantProtocol String participantType String newConferenceName String The name of the conference to move the participant to. This will only move an active participant. Even if this participant is preconfigu...
Page 37 - autoAttendant.destroy
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 33 This method returns: Response Type Comments enumerateID(optional) String The value which should be used in the next call to get the next set of data. If this is omitted, then no further data is available from the MCU. autoAttendants ar...
Page 38 - IP VCR methods
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 supports video recording and playback, such as the Codian IP VCR 2200 Series. Throughout this section, any such product is referred to as an IP VCR. 5.1 record...
Page 42 - ISDN Gateway methods; Common structures; Participant records
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 38 6 ISDN Gateway methods The following methods are present on ISDN gateway products, such as the ISDN GW 3220. 6.1 Common structures Participant records Several functions return participant records, which have the following fields: Field...
Page 46 - IP Gateway methods; corpdirURI.configure
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 Series and MSE IP GW 8350 blade. 7.1 corpdirURI.query There are no parameters passed with this method call. The method response returns the following: Parameter T...
Page 47 - Deprecated messages
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 4200 Series Management API, but have since been superseded. 8.1 system.query This method is deprecated in favour of “device.query” and “conference.enumerate”...
Page 51 - Related information sources; Field
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 XML-RPC API, some information can be retrieved from the system.xml file. This can be downloaded via HTTP as the file system.xml in the root of the unit, i.e. h...
Page 52 - Required user privileges; Method
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 48 10 Required user privileges The following table summarises which users are permitted to perform which remote management operations. Method Valid users device.query Any user with administrator privileges. device.network.query Any user w...
Page 53 - Fault codes
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 fault occurs during the processing of an XML-RPC request. While individual method descriptions above give some indication of which faults may occur, below is a d...
Page 54 - Operation failed
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 50 Fault Code Description correct type, but falls outside the valid values; for example an integer is too high or a string value for a protocol contains an invalid protocol. The parameter in question is given in the fault string in the fo...
Page 55 - Participant disconnect reasons; Value
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 51 12 Participant disconnect reasons These are the possible values of the “disconnectReason” field in participant information responses: Value Description Unspecified unspecifiedError remoteTeardown localTeardown noAnswer Moved Rejected r...
Page 56 - References
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.faqs.org/rfcs/rfc2616.html
Page 57 - Appendix A - Conference layouts; default; conferenceCustom
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 53 Appendix A - Conference layouts The participant.add and participant.modify methods allow a particular layout to be specified for video sent to that participant via the “cpLayout” parameter. The “cpLayout” string parameter can take the ...
Page 59 - Appendix B - Linking conferences across MCUs; example message 1; Example
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 55 Appendix B - Linking conferences across MCUs For the purposes of this description, two conferences are said to be "linked" if there is a bi-directional H.323 connection between them and each MCU is sending a video channel to th...
Page 63 - Message responses
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 should be the same normal success indication: <?xml version="1.0"?> <methodResponse> <params> <param> <value> <struct&g...
Page 64 - Appendix C - Revision Numbers; Note; Discovering record removal
Copyright © TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 60 Appendix C - Revision Numbers Note : This feature is available from API version 2.4 onwards. An application can determine the API version supported by a device from the apiVersion value returned in the response to a device.query reques...
Page 65 - Dead records
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 the second is described in the next section. A client may periodically include the listAll Boolean parameter set to true to indicate that the MCU should re...
