Provisioning a room system (enhanced)

Note: Starting January 18, 2021, new accounts provisioned with Cloud Room Connector licenses will automatically have access to the new enhanced API Room Connector for SIP/H.323 devices. If you were provisioned a Cloud Room Connector (CRC) license, prior to January 18, 2021, please use our Room Management instructions for the standard API Room Connector.

If you have an existing H.323/SIP room system in place, you can integrate the system with Zoom. This lets you start a scheduled Zoom meeting directly from your existing hardware. You can also start an instant meeting if the room is configured with a Personal Meeting ID, or use the room to join Zoom meetings that are not on the calendar.

This article covers:

• How to install the API Connector
• How to add an SIP/H.323 Room
• How to manage an API Connector
  • Manging an individual API Connector's settings
  • Manging the API Connector's account level settings

Prerequisites for provisioning a SIP/H.323 device as a managed room

• A Pro, Business, Enterprise, or Education account
• Owner, Admin, or “H.323/SIP room connector” Role based privileges
• A Zoom account with a Cloud Room Connector license
• A supported codec device

VM requirements

• 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

Note: The above device requirements, support up to 200 endpoints

How to install the API Connector

1. Sign in to the Zoom web portal.
2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
3. Click the API Connectors tab.
4. Click Add API Connector.
5. Fill out the following fields:
   • API Description: The name/description of the API connector
   • Private Networks: The private network ranges of devices, the API connector can provision.
     Note: If creating more then one API Connector, you can not use overlapping IP ranges.
6. (Optional): Click Save & Create Another to create another API Connector
7. Click Finish when done.
8. Click Install, to download the ZoomAPIConnector.msi installer.
9. Run the installer.
10. At the Customize this installation window, enter the following information:
    • Connector ID: Copy the Connector ID from the API Connector page, and paste it into the Connector ID field in the installer.
    • Private Key: Click the private key field on the API Connector page to copy it. Paste it into the Private Key field of the installer.
11. Complete the installation wizard.

Once completed, refresh the API Connector page, if the Connector does not show as Online, check that the ZoomAPIConnectorNws service is running on the Windows machine.

Note: You must keep the Zoom API Connector software running on a Windows Server or a Virtual Machine that is always available and connected to the internet after installing.

How to add a SIP/H.323 room

1. Sign in to the Zoom web portal.
2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
3. Click the Rooms tab.
4. Click Add Room.
5. Enter the following information
   • Manage Type:
     • Full management
       Full management allows Zoom to provision configuration settings (Room name, time zone, etc.) and displays room status in the customer portal. This mode is only available for supported devices.
     • SIP proxy
       SIP proxy management does not provision any settings to the device, nor is the status of the device available. In this management mode, Zoom generates authentication credentials for registering the device with the Zoom SIP proxy. These SIP proxy credentials will need to be manually configured within the device’s settings.
   • Room Name: Name of the Room System.
   • Room Template: Select a template configured with pre-specified settings, that will be applied once the device has been provisioned. If not applying a template, leave as none.
   • Device Type: Select the series of devices, your endpoint is a part of.
     Note: Select Generic SIP/H.323 Room if this is for non-managed rooms using SIP proxy.
   • Serial Number: Serial number of the hardware.
   • IP Address: The IP address that is set for the Room system.
   • Device Username: Admin username for the device.
   • Device Password: Admin password for the device.
6. (Optional): Click Save & Create Another to create another Room.
7. Click Finish when done.

How to manage an API Connector

Once a room connector has been deployed, each room connector can be managed individually or have certain settings set at the account level. 

Managing an individual API Connector's settings

To manage an API Connectors settings:

1. Sign in to the Zoom web portal.
2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
3. Click the API Connectors tab.
4. Next to the desired Connector, click Edit.
   The following settings will be available:
   • API Description: The name/description of the API Connector
   • Private Networks: The private network ranges of devices, the API Connector can provision.
   • Managed Rooms: Select which currently deployed rooms are managed by the API Connector.
   • Connector Log: If disabled, the room connector will only store necessary logging information. Full logging can be enabled for the room connector, which will then log and store all room connecter activities for troubleshooting purposes.
     Note: This is disabled by default to minimize the storage space used by the logging service.

Managing the API Connector's account level settings

To manage the account-level settings for the API Connectors:

1. Sign in to the Zoom web portal.
2. In the navigation panel, click Room Management, then click Cisco/Polycom Rooms.
3. Click Account Settings. 
   The following settings will be available: 
   • Firmware Warning: When enabled, if the room system's firmware is out of date, there will be an option to update the firmware from the room management UI.
   • Search Enhance(Beta): When enabled, an advance search option will appear on the Rooms tab, allowing admins to search for rooms by name or IP address. Advanced sorting features are also available, including:
     
     • Connection State
     • Provision State
     • SIP State
     • Call State
     • Device Type
     • Device Management
   • Connector Log: If disabled, the room connector will only store necessary logging information, which minimizes storage use for log files. Full logging can be enabled for the room connector, which will then log and store all room connecter activities for troubleshooting purposes.
     Note: This is disabled by default to minimize the storage space used by the logging service.