Polycom RealPresence Platform API
DEVELOPER GUIDEAPI Version 3.6.0 SEPTEMBER 2018 3725 77702 001KPolycom RealPresence Platform APIPolycom, Inc.1
Copyright 2018, Polycom, Inc. All rights reserved. No part of this document may be reproduced, translated intoanother language or format, or transmitted in any form or by any means, electronic or mechanical, for any purpose,without the express written permission of Polycom, Inc.6001 America Center DriveSan Jose, CA 95002USAPolycom , the Polycom logo and the names and marks associated with Polycom products are trademarks and/orservice marks of Polycom, Inc. and are registered and/or common law marks in the United States and various othercountries. All other trademarks are property of their respective owners. No portion hereof may be reproduced ortransmitted in any form or by any means, for any purpose other than the recipient's personal use, without the expresswritten permission of Polycom.End User License Agreement By installing, copying, or otherwise using this product, you acknowledge that youhave read, understand and agree to be bound by the terms and conditions of the End User License Agreement forthis product.Patent Information The accompanying product may be protected by one or more U.S. and foreign patents and/orpending patent applications held by Polycom, Inc.Open Source Software Used in this Product This product may contain open source software. You may receivethe open source software from Polycom up to three (3) years after the distribution date of the applicable productor software at a charge not greater than the cost to Polycom of shipping or distributing the software to you. Toreceive software information, as well as the open source software code used in this product, contact Polycom byemail at OpenSourceVideo@polycom.com.Disclaimer While Polycom uses reasonable efforts to include accurate and up-to-date information in this document,Polycom makes no warranties or representations as to its accuracy. Polycom assumes no liability or responsibility forany typographical or other errors or omissions in the content of this document.Limitation of Liability Polycom and/or its respective suppliers make no representations about the suitability of theinformation contained in this document for any purpose. Information is provided “as is” without warranty of any kindand is subject to change without notice. The entire risk arising out of its use remains with the recipient. In no eventshall Polycom and/or its respective suppliers be liable for any direct, consequential, incidental, special, punitive orother damages whatsoever (including without limitation, damages for loss of business profits, business interruption,or loss of business information), even if Polycom has been advised of the possibility of such damages.Customer Feedback We are striving to improve our documentation quality and we appreciate your feedback. Emailyour opinions and comments to DocumentationFeedback@polycom.com.Visit the Polycom Support Center for End User License Agreements, software downloads, product documents,product licenses, troubleshooting tips, service requests, and more.Polycom, Inc.2
ContentsContents .3Before You Begin .8Scope of This Guide . 8Audience, Purpose and Required Skills . 8Get Help . 8API Terminology Used . 8Supported RealPresence Platform API Version. 8Related Documentation . 9RealPresence Resource Manager and DMA System Documentation . 9RealPresence Platform API History .10Associated API and Product Versions . 10RealPresence Platform API History. 11RealPresence Platform API Version 3.6.0 . 11plcm-ep-registration . 12plcm-rest-login-details . 12plcm-acl . 12plcm-active-call . 12plcm-backup . 12plcm-port-range-settings . 13plcm-power-management . 13plcm-registration-policy-debug-request . 13plcm-registration-policy-v2. 13plcm-call . 14plcm-security-settings . 14plcm-gatekeeper-config-v2 . 14plcm-gatekeeper-config . 14plcm-troubleshooting-utilities . 15plcm-registration-summary . 15RealPresence Platform API Version 3.5.0 . 15Changes affecting multiple resources . 15plcm-acl . 15plcm-active-call . 16plcm-alerting-config . 16plcm-alert . 16plcm-backup . 16plcm-billing. 16plcm-caa-tenant . 16plcm-common . 17Polycom, Inc.3
plcm-conference-factory . 17plcm-conference-room . 17plcm-conference-settings . 17plcm-conference . 17plcm-conference-template . 18plcm-config . 18plcm-device. 19plcm-dial-plan . 19plcm-dma-supercluster . 20plcm-enterprise-directory-cache . 21plcm-enterprise-directory-reports. 21plcm-enterprise-directory. 21plcm-enterprise-group . 21plcm-eula . 21plcm-ext-sip-peer . 22plcm-hunt-group . 22plcm-license . 22plcm-ext-sip-peer . 22plcm-login-policy . 22plcm-login-sessions. 23plcm-mcu-pool-order . 23plcm-mcu . 23plcm-network . 23plcm-pkix . 23plcm-registration-policy . 23plcm-remote-backup . 24plcm-reports. 24plcm-rprm-integration . 25plcm-security-settings . 25plcm-signaling-config . 25plcm-snmp-config. 26plcm-software-upgrade. 26plcm-task . 26plcm-territory . 26plcm-troubleshooting-utilities . 27plcm-user-domain . 27plcm-user . 27plcm-user-domain . 28RealPresence Platform API Version 3.4.0 . 28plcm-mcu . 28plcm-conference-room . 28RealPresence Platform API Version 3.2.1 . 28plcm-conference . 28plcm-provision. 28plcm-network-device . 29Polycom, Inc.4
plcm-enterprise-directory. 29RealPresence Platform API Version 2.7.1 . 29RealPresence Platform API Version 2.6.2 . 30RealPresence Platform API Version 2.6.1 . 31RealPresence Platform API Version 2.6.0 . 31RealPresence Platform API Version 2.5.5 . 32RealPresence Platform API Version 2.5.4 . 32RealPresence Platform API Version 2.5.3 . 32RealPresence Platform API Version 2.5.2 . 33RealPresence Platform API Version 2.4.3 . 35RealPresence Platform API Version 2.4.2 . 35RealPresence Platform API Version 2.2.0 . 36RealPresence Platform API Version 2.0.1 . 36RealPresence Platform API Version 1.7.7 . 36RealPresence Platform API Version 1.7.6 . 37RealPresence Platform API Version 1.7.5 . 37RealPresence Platform API Version 1.7.4 . 37RealPresence Platform API Version 1.7.2 . 37RealPresence Platform API Version 1.7.1 . 37Getting Started .40Understanding Basic Concepts . 40Resources and HTTP Methods. 40Recommended HTTP GET Optimization (Conditional GET) . 40Recommended HTTP PUT Request Concurrency Control (Conditional PUT) . 41Updating resources . 41Simple User Resource Example . 42Get Method . 42POST Method . 44DELETE Method . 45Resource Descriptions . 45Links and Navigation . 47The title attribute . 48Example . 48The type Attribute. 48Example (using XML subtype) . 48Example (using JSON subtype). 48The rel Attribute . 48Example . 48The href Attribute .
API Services describes functional areas exposed by the API. Audience, Purpose and Required Skills This guide is written for application developers. It assumes that you are a developer, and have a basic understanding of: How applications are developed in your environment. Functional understanding of the HTTP, JSON, and XML. Familiarity with Representational State Transfer (REST) architecture .
Polycom RealPresence Resource Manager 10.0.1 10.0.1 10.0.1 Polycom RealPresence Collaboration Server 8.6.7 8.6.7 8.6.7 Polycom RealPresence Distributed Media ApplicationTM (DMA ) 6.4.1 6.4.1 6.4.1 Polycom RealPresence Access Director 4.2.3 4.2.3 4.2.4_230053 Polycom RealPresenc
Polycom RealPresence Group Series Polycom announces the new release of Polycom RealPresence Group Series system. This document provides the latest information on the following Polycom software: Version 6.2.0.1 of the Polycom RealPresence Group Series system software Version 2.1.0.5 of the Polycom EagleEye Director II camera software
Polycom Touch Control User Guide, and Polycom RealPresence Group Series with RealPresence Touch User Guide, which describe how to perform video conferencing tasks Setup sheets for your hardware Release notes Polycom RealPresence Group Series Integrator Reference Guide, which provides cable information and API command descriptions Polycom .
Polycom, Inc. 10 Before You Begin This Polycom RealPresence Trio Solution for Skype for Business User Guide contains overview information for the Polycom RealPresence Trio 8800 audio conferencing system and the Polycom RealPresence Trio Visual content
This guide is for users who want to perform basic to intermediate tasks on the Polycom RealPresence Group Series system with Zoom Connector for Polycom . Please read the RealPresence Group Series documentation before you operate the system. The following related documents for RealPresence Group Series systems are available from Polycom
Polycom RealPresence Web Suite Administrator Guide. for information on upgrading and migrating settings from your previous installation. Note: Get the latest product information from Polycom Support. To view the latest Polycom product documentation, visit the Polycom RealPresence Web Suite Support page on Polycom Support.
In Polycom Immersive Telepresence Series suites, the video is delivered using two, three, or four independent Polycom HDX codecs. In Polycom RealPr esence Immersive Studio, RealPresence Immersive Studio Flex, and Polycom RealPresence OTX Studio rooms, the video is delivered using three Polycom RealPresence Group Series codecs.
The API commands in this guide are applicable to the Polycom RealPresence Group 300, Polycom RealPresence Group 500, and Polycom RealPresence Group 700 systems.
