ZR-CSAPI: A Zoom Room API for Automation Controllers

 

The Zoom Rooms Control System API (ZR-CSAPI) is a CLI-based API that allows an external automation controller to fully control a Zoom Room via an SSH connection. The ZR-CSAPI is intended for Audio/Video integrators who install custom conference room solutions.

The ZR-CSAPI Command Overview provides the high level syntax of the CLI.

The ZR-CSAPI Command Reference lists all available commands.

Highlights of the API:

  • The ZR-CSAPI is a Command Line Interface (CLI) with a syntax that is similar to other popular video codecs.
  • The ZR-CSAPI exposes the CLI via SSH.
  • The upcoming release of the Zoom Room will have the ZR-CSAPI feature built-in; there is nothing extra to install.
  • It will ship for both the Mac and Windows Zoom rooms.
  • The Zoom Room downloads list of contacts and lists of scheduled meetings from the Zoom Web Portal, then exposes that information via the ZR-CSAPI CLI; the automation controller does not need to connect with a corporate directory to download the information.
  • All events that change the state of the Zoom Room are reported as asynchronous notifications to the automation controller.

Availability

The ZR-CSAPI will ship with the next version of the Zoom Room. However, integrators can request early access to the ZR-CSAPI by sending email to zrcsapi@zoom.us. The ZR-CSAPI is currently available for beta testing on Mac Zoom Rooms; a beta version for Win Zoom Rooms will roll out shortly.