Enhanced API Connector Deployment and Functionality

The Enhanced API Connector is deployed into your network environment for signaling between your provisioned, Zoom-managed H.323/SIP video conferencing devices and Conference Room Connector (CRC). Device controls, feedback, calendar updates, and SIP proxy registration data are relayed through the Enhanced API Connector, and it is a necessary component for managing H.323/SIP devices in the Zoom platform and utilizing additional CRC features.

This section will explain the deployment process and functionality of the Enhanced API Connector.

View, manage, and deploy Enhanced API Connectors in the Zoom web portal

Zoom account owners, administrators, and users with Conference Room Connector (CRC) permissions can view, manage, and deploy Enhanced API Connectors in the Zoom web portal by navigating to the Cisco/Polycom Rooms section of the admin menu and selecting the API Connectors button.

The API Connectors section will list all deployed Enhanced API Connectors for your Zoom account and their information including connector ID, description, status, connector version, and private key. Select the + Add API Connector button to deploy a new Enhanced API Connector.

Select the Edit button within each listed API connector for auto upgrade settings, a list of H.323/SIP devices currently managed by the API connector, and debug log-level settings.

Select the ellipses (...) to refresh the API connector, delete the connector, or refresh the private key.

Deploy one Enhanced API Connector to support up to 200 H.323/SIP video conferencing devices in your network environment

Please see our Deploying the enhanced Zoom Connector support article for instructions on deploying or re-installing an Enhanced API Connector from the Zoom web portal. Enhanced API Connectors are typically installed on servers or virtual machines within an organization’s network.

Note

The Enhanced API Connector can be deployed using Docker. See our Docker deployment guide.

Virtual machine requirements for an Enhanced API Connector

• A Windows PC, server, or virtual machine (for installing and running the Zoom API Connector software locally)

• 2 core processor

• 8 GB of RAM

• 20 GB of storage

Deploy multiple Enhanced API Connectors for environments with over 200 devices or for zone management or High Availability mode

Deploying multiple Enhanced API Connectors is recommended for environments that surpass the 200-device management limit of a single API connector or for managing groups of H.323/SIP video conferencing devices across different zones. Additionally, deploying multiple Enhanced API Connectors in High Availability mode supports redundancy with two API connectors working together to maintain consistency for your managed H.323/SIP devices.

See our Using Enhanced API Connectors in High Availability for instructions for the deployment of the Enhanced API Connector for High Availability mode.

The Enhanced API Connector resides in your network and relays control signaling between your H.323/SIP video conferencing devices and Conference Room Connector

The Enhanced API connector will communicate with your on-premises H.323/SIP video conferencing devices through control communication channels established within the device settings which may include HTTPS, WebSocket, SSH, or Telnet. The Enhanced API connector will relay video conferencing device settings and device control signals and feedback to the Conference Room Connector infrastructure over TCP port 443. Calendar push data will also be delivered to Cisco video conferencing devices over TCP 443.