Cisco TelePresence MCU Series API 2 · PDF file MCU 4200 Series MCU 4500 Series MCU MSE 8420 MCU MSE 8510 This is accomplished via messages sent using the XML-RPC protocol. XML-RPC

Cisco TelePresence MCU Series API 2.8

Product Programming Reference Guide

D14626.04

May 2011

API version history

Cisco TelePresence MCU API 2.8 Page 2 of 120

Contents

API version history ............................................................................................................... 5 Version 2.8 .............................................................................................................................................. 5 Version 2.7 .............................................................................................................................................. 8 Version 2.6 .............................................................................................................................................. 9

Introduction ......................................................................................................................... 11 HTTP and HTTPS ................................................................................................................................. 11 Clustering .............................................................................................................................................. 11 Consider API overhead when writing applications ................................................................................ 11

XML-RPC protocol overview .............................................................................................. 13 Message flow ........................................................................................................................................ 13 Authentication ....................................................................................................................................... 13 Example command message ................................................................................................................ 13 Unicode support .................................................................................................................................... 15

HTTP headers ................................................................................................................................ 15 XML header ................................................................................................................................... 15

Common message elements ................................................................................................................ 15 Authentication ................................................................................................................................ 15 Participant identification parameters .............................................................................................. 16 Enumerate functions ...................................................................................................................... 16 Filtering .......................................................................................................................................... 17

API reference ....................................................................................................................... 19 addressBookEntry.enumerate .............................................................................................................. 22 auditlog.delete ....................................................................................................................................... 26 auditlog.query ........................................................................................................................................ 27 autoAttendant.destroy ........................................................................................................................... 27 autoAttendant.enumerate ...................................................................................................................... 27 autoAttendant.status ............................................................................................................................. 28 cdrlog.delete .......................................................................................................................................... 28 cdrlog.enumerate .................................................................................................................................. 29 cdrlog.query .......................................................................................................................................... 30 conference.create ................................................................................................................................. 30

Deprecated parameters ................................................................................................................. 37 conference.destroy ................................................................................................................................ 37 conference.end ..................................................................................................................................... 37 conference.enumerate .......................................................................................................................... 38

conferences array .......................................................................................................................... 39 conference.floor.modify ......................................................................................................................... 44 conference.floor.query .......................................................................................................................... 44 conference.modify ................................................................................................................................. 46

Deprecated parameters ................................................................................................................. 50 conference.paneplacement.modify ....................................................................................................... 50 conference.paneplacement.query ......................................................................................................... 52 conference.resetCleanupTimeout ......................................................................................................... 53 conference.status .................................................................................................................................. 53 conference.streaming.modify ................................................................................................................ 53 conference.streaming.query.................................................................................................................. 54 conferenceme.query ............................................................................................................................. 55

API version history

Cisco TelePresence MCU API 2.8 Page 3 of 120

device.health.query ............................................................................................................................... 57 device.network.query ............................................................................................................................ 57

port data structures ...................................................................................................................... 58 dns array ....................................................................................................................................... 59

device.query .......................................................................................................................................... 61 device.restartlog.query .......................................................................................................................... 62 gatekeeper.query .................................................................................................................................. 62 gateway.enumerate ............................................................................................................................... 64 participant.add ....................................................................................................................................... 65

Deprecated parameters ................................................................................................................. 68 participant.connect ................................................................................................................................ 69 participant.diagnostics ........................................................................................................................... 69 participant.disconnect ........................................................................................................................... 73 participant.enumerate ........................................................................................................................... 74

participants array members ................................................................................................... 75 Deprecated parameters ................................................................................................................. 82

participant.fecc ...................................................................................................................................... 82 participant.message .................................