Copyright © TANDBERG 2008
Contents
1 Introduction...................................................................................................................................... 1
1.1 HTTP and HTTPS............................................................................................................................................................1
1.2 XML-RPC...........................................................................................................................................................................1
2 Protocol overview............................................................................................................................. 2
2.1 Authentication...............................................................................................................................................................2
2.2 Message flow..................................................................................................................................................................2
2.3 Unicode support ...........................................................................................................................................................4
2.3.1 HTTP Headers...........................................................................................................................................................4
2.3.2 XML Header ..............................................................................................................................................................4
2.4 Common message elements....................................................................................................................................4
2.4.1 Authentication.........................................................................................................................................................4
2.4.2 Participant identification parameters .............................................................................................................5
2.4.3 Enumerate functions.............................................................................................................................................5
2.4.4 Filtering......................................................................................................................................................................6
3 Messages supported by multiple product types............................................................................ 8
3.1 device.query...................................................................................................................................................................8
3.2 device.network.query..................................................................................................................................................8
3.3 device.health.query .....................................................................................................................................................9
3.4 device.restartlog.query...............................................................................................................................................9
3.5 gatekeeper.query........................................................................................................................................................10
3.6 sip.query.........................................................................................................................................................................10
3.7 addressBookEntry.enumerate................................................................................................................................11
3.8 gateway.enumerate...................................................................................................................................................12
4 Conference related methods ......................................................................................................... 14
4.1 conference.create.......................................................................................................................................................14
4.2 conference.modify .....................................................................................................................................................16
4.3 conference.destroy ....................................................................................................................................................17
4.4 conference.end............................................................................................................................................................17
4.5 conference.enumerate .............................................................................................................................................17
4.6 conference.streaming.query ..................................................................................................................................20
4.7 conference.streaming.modify................................................................................................................................21
4.8 conference.paneplacement.query.......................................................................................................................21
4.9 conference.paneplacement.modify.....................................................................................................................22
4.10 participant.add ............................................................................................................................................................22
4.11 participant.remove.....................................................................................................................................................24
4.12 participant.modify......................................................................................................................................................25
4.13 participant.connect....................................................................................................................................................26
4.14 participant.disconnect..............................................................................................................................................26
4.15 participant.move.........................................................................................................................................................26
4.16 participant.enumerate..............................................................................................................................................27
4.17 participant.fecc............................................................................................................................................................31
4.18 participant.message ..................................................................................................................................................31
4.19 participant.diagnostics.............................................................................................................................................32
4.20 autoAttendant.enumerate......................................................................................................................................32
4.21 autoAttendant.destroy.............................................................................................................................................33
5 IP VCR methods............................................................................................................................... 34
5.1 recording.callout.........................................................................................................................................................34
5.2 recording.configure...................................................................................................................................................34
5.3 recording.delete..........................................................................................................................................................35
5.4 recording.enumerate ................................................................................................................................................35
5.5 recording.stop..............................................................................................................................................................36
5.6 folder.enumerate........................................................................................................................................................36