TANDBERG 3.0 manual

Reference guide

Codian Remote Management API

Document version 3.0

September 2008

Contents

Main Reference guide Codian Remote Management API Page Contents Page 1 Introduction 1.1 HTTP and HTTPS 1.2 XML-RPC 2 Protocol overview 2.1 Authentication 2.2 Message flow Copyright TANDBERG 2008 Reference Guide Version 3.0 rev 3.0 3 2.3 Unicode support 2.4 Common message elements Page Page Page 3 Messages supported by multiple product types 3.1 device.query 3.2 device.network.query 3.3 device.health.query 3.4 device.restartlog.query 3.5 gatekeeper.query 3.6 sip.query 3.7 addressBookEntry.enumerate 3.8 gateway.enumerate Page 4 Conference related methods 4.1 conference.create Page 4.2 conference.modify 4.3 conference.destroy 4.4 conference.end 4.5 conference.enumerate Page Page 4.6 conference.streaming.query 4.7 conference.streaming.modify 4.8 conference.paneplacement.query 4.9 conference.paneplacement.modify 4.10 participant.add Page 4.11 participant.remove 4.12 participant.modify 4.13 participant.connect 4.14 participant.disconnect 4.15 participant.move 4.16 participant.enumerate Page Page Page 4.17 participant.fecc 4.18 participant.message 4.19 participant.diagnostics 4.20 autoAttendant.enumerate 4.21 autoAttendant.destroy 5 IP VCR methods 5.1 recording.callout 5.2 recording.configure 5.3 recording.delete 5.4 recording.enumerate 5.5 recording.stop 5.6 folder.enumerate Page 6 ISDN Gateway methods 6.1 Common structures 6.2 calls.active.enumerate 6.3 calls.completed.enumerate 6.4 isdn.ports.query Page 7 IP Gateway methods 7.1 corpdirURI.query 7.2 corpdirURI.configure 8 Deprecated messages 8.1 system.query 8.2 conference.query 8.3 conference.participant.modify 8.4 conference.participant.remove 8.5 conference.participant.add 8.6 participant.enumerate Page Page 9 Related information sources 9.1 system.xml 10 Required user privileges 11 Faul t code s Page 12 Participant disconnect reasons 13 References Appendix A - Conference layouts Page Appendix B - Linking conferences across MCUs B.1 Example message 1 - creating conference "linked1" on "mcu1" Copyright TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 56 B.2 Example message 2 - creating conference "linked2" on "mcu2" Copyright TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 57 B.3 Example message 3 - calling into "linked2" from "linked1" Copyright TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 58 B.4 Example message 4 - setting the new "linked2" participant to use a full screen view layout Copyright TANDBERG 2008 Reference Guide Version 3.0 rev 1.0 59 B.5 Message responses Appendix C - Revision Numbers C.1 Discovering record removal C.2 Dead records Appendix D - HTTP Keep-alives