zStatus

zStatus provides access to read-only status information. These values can change based on external events. When a value changes, the CLI will issue an asynchronous notification.

The status parameters are arranged in a path hierarchy, and you can access the hierarchy at various points. In some cases, you cannot go all the way down to a leaf in the hierarchy; you can specify a path down to an intermediate node, and you get all values at that point, and lower, in the hierarchy.

zStatus Call Status

Get current call status

Schema

zstatus call status
*s Call Status: <NOT_IN_MEETING | CONNECTING_MEETING | IN_MEETING | LOGGED_OUT |UNKNOWN> // The state of the call
** end
OK

Example

zstatus call status
*s Call Status: IN_MEETING
** end
OK

zStatus Audio Input Line

Get info on an audio input

Schema

zStatus Audio Input Line
*s Audio Input Line n id: <string> // Id of the device
*s Audio Input Line n Name: <string> // Name of the device
*s Audio Input Line n Alias: <string> // Alias of the device
*s Audio Input Line n Selected: <on/off> // Whether the device is selected
*s Audio Input Line n manuallySelected: <on/off> // Whether device is manually selected
*s Audio Input Line n combinedDevice: <on/off> //Whether device is actually multiple devices
*s Audio Input Line n numberOfCombinedDevices: <int> //Number of combined devices
*s Audio Input Line n ptzComId: <int> // PanTiltZoom Comm ID if applicable
...
** end
OK

Example

zStatus Audio Input Line
*s Audio Input Line 1 id: HD Pro Webcam C920
*s Audio Input Line 1 Name: HD Pro Webcam C920
*s Audio Input Line 1 Alias: 
*s Audio Input Line 1 Selected: on
*s Audio Input Line 1 manuallySelected: on
*s Audio Input Line 1 combinedDevice: off
*s Audio Input Line 1 numberOfCombinedDevices: 0
*s Audio Input Line 1 ptzComId: -1
** end
OK

zStatus Audio Output Line

Get info on an audio Output

Schema

zStatus Audio Output Line
*s Audio Output Line n id: <string> // Id of the device
*s Audio Output Line n Name: <string> // Name of the device
*s Audio Output Line n Alias: <string> // Alias of the device
*s Audio Output Line n Selected: <on/off> // Whether the device is selected
*s Audio Output Line n manuallySelected: <on/off> // Whether device is manually selected
*s Audio Output Line n combinedDevice: <on/off> //Whether device is actually multiple devices
*s Audio Output Line n numberOfCombinedDevices: <int> //Number of combined devices
*s Audio Output Line n ptzComId: <int> // PanTiltZoom Comm ID if applicable
...
** end
OK

Example

zStatus Audio Output Line
*s Audio Output Line 1 id: Built-in Output
*s Audio Output Line 1 Name: Built-in Output (Internal Speakers)
*s Audio Output Line 1 Alias: 
*s Audio Output Line 1 Selected: on
*s Audio Output Line 1 manuallySelected: on
*s Audio Output Line 1 combinedDevice: off
*s Audio Output Line 1 numberOfCombinedDevices: 0
*s Audio Output Line 1 ptzComId: -1
** end
OK

zStatus Video Camera Line

Get info on Camera input

Schema

zStatus Video Camera Line
*s Video Camera Line n id: <string> // Id of the device
*s Video Camera Line n Name: <string> // Name of the device
*s Video Camera Line n Alias: <string> // Alias of the device
*s Video Camera Line n Selected: <on/off> // Whether the device is selected
*s Video Camera Line n manuallySelected: <on/off> // Whether device is manually selected
*s Video Camera Line n combinedDevice: <on/off> //Whether device is actually multiple devices
*s Video Camera Line n numberOfCombinedDevices: <int> //Number of combined devices
*s Video Camera Line n ptzComId: <int> // PanTiltZoom Comm ID if applicable
...
** end
OK

Example

zStatus Video Camera Line
*s Video Camera Line 1 id: 0x14100000046d082d
*s Video Camera Line 1 Name: HD Pro Webcam C920
*s Video Camera Line 1 Alias: usb:046D:082D
*s Video Camera Line 1 Selected: off
*s Video Camera Line 1 manuallySelected: off
*s Video Camera Line 1 combinedDevice: off
*s Video Camera Line 1 numberOfCombinedDevices: 0
*s Video Camera Line 1 ptzComId: -1
*s Video Camera Line 2 id: 0x14a00000095d9204
*s Video Camera Line 2 Name: Polycom EagleEye IV USB Camera
*s Video Camera Line 2 Alias: usb:095D:9204
*s Video Camera Line 2 Selected: on
*s Video Camera Line 2 manuallySelected: on
*s Video Camera Line 2 combinedDevice: off
*s Video Camera Line 2 numberOfCombinedDevices: 0
*s Video Camera Line 2 ptzComId: -1
** end
OK

zStatus Video Optimizable

Whether screen sharing is optimizable for video playback. If so, then you can issue the command zConfiguration Call Sharing optimize_video_sharing

Schema

zStatus Video Optimizable
*s Video Optimizable: <on/off> // Set to On if it is possible to invoke the **zConfiguration Call Sharing optimize_video_sharing** command. 
** end
OK

Example

zStatus Video Optimizable
*s Video Optimizable: on
** end
OK

zStatus SystemUnit

Get System information

Schema

zStatus SystemUnit
*s SystemUnit login_type: <google | work_email> // Users log into the Zoom room using either a Google email or a work email.
*s SystemUnit email: <string> // The auto-generated email assigned to this Zoom Room: It defines a virtual "Zoom user" for this Zoom Room. This virtual user is listed in the account user list on the Web Portal.
*s SystemUnit meeting_number: <string> // The Zoom Room PMI meeting number. It is an int, but this value is a string because in the future it may be a vanity number.
*s SystemUnit platform: <string> // Zoom Room platform type
*s SystemUnit room_version: <string> // Zoom Room release version
*s SystemUnit room_info room_name: <string> // Room name
*s SystemUnit room_info account_email: <string> // The email of the Zoom user who is administrating this Zoom Room. This is the email that is used to log into the Zoom Room.
*s SystemUnit room_info is_auto_answer_enabled: <on/off> // Whether auto answer is available on this Zoom Room
*s SystemUnit room_info is_auto_answer_selected: <on/off> // Whether auto answer is turned on for this Zoom Room
*s SystemUnit room_info display_version: <string> //Displays version number
** end
OK

Example

zStatus SystemUnit
*s SystemUnit login_type: work_email
*s SystemUnit email: scott.firestone_U-ygqt3HStSmbY1JfYW-OA@parasync.com
*s SystemUnit meeting_number: 5526136251
*s SystemUnit platform: Mac OS X, 10.13.6
*s SystemUnit room_version: 4.1.33237.0924
*s SystemUnit room_info room_name: ZR-ScottFirestone2
*s SystemUnit room_info account_email: room@kanovia.com
*s SystemUnit room_info is_auto_answer_enabled: on
*s SystemUnit room_info is_auto_answer_selected: off
*s SystemUnit room_info display_version: 4.2.0 (416.1123)
** end
OK

zStatus Capabilities

Get System Capabilities

Schema

zStatus Capabilities 	
zStatus Capabilities is_Airhost_Disabled: <on/off>
zStatus Capabilities can_Dtmf_For_Invite_By_Phone <on/off>
zStatus Capabilities pstn_Call_In_Local_Presentation <on/off>
zStatus Capabilities can_Ringing_In_Pstn_Call <on/off>
zStatus Capabilities supports_Sip_Call_out <on/off> // The ZR allows SIP callout. The Zoom Room must be configured to have the SIP Phone Integration add-on license.
zStatus Capabilities aec_Setting_Stored_In_ZR <on/off>
zStatus Capabilities supports_Web_Settings_Push <on/off>
zStatus Capabilities support_Pin_And_Spotlight <on/off> // Whether the zoom Room can Pin other participants. When a user is pinned, that user will always appear full-screen on the Zoom Room (does not affect remote endpoints), and always show up in one of the connected monitors, even if speaker selection mode is turned on. For spotlight: applies to meetings with 3 or more participants only. The host, and all remote participants, will see that person full screen: speaker selection mode, and pin mode, is overridden on all endpoints. The spotlighted person is effectively pinned on all endpoints.
zStatus Capabilities can_Mute_On_Entry <on/off> // Whether this ZR is capable of muting all participants when they enter the meeting.
zStatus Capabilities support_Claim_Host <on/off> // Whether the Zoom Room can be instructed to take over the host privilege for a meeting.
zStatus Capabilities support_Out_Room_Display <on/off> // Whether the Zoom Room can host a scheduling display, typically mounted outside the conference room.
zStatus Capabilities can_Switch_To_Specific_Camera <on/off>
zStatus Capabilities supports_Software_Audio_Processing: <on/off> // Whether the Zoom Room supports SAP.
zStatus Capabilities supports_Hdmi_Cec_Control: <on/off> // Whether the ZR can send a CeC command via HDMI to wake up a video monitor.
zStatus Capabilities supports_Highly_Reverberant_Room <on/off> // Whether the Zoom Room can be configured to compensate for high reverb within a conference room.
zStatus Capabilities supports_Share_For_Floating_And_Content_only: <on/off> // Whether the zoom Room allows the shared content to be switch to a video thumbnail in active speaker mode.
*s Capabilities supports_Loading_Contacts_Dynamically: <on/off> // Whether the Zoom Room supports loading Phonebook contacts in a scalable manner, to accommodate a very large directory.
*s Capabilities supports_ShareCamera: <on/off> // Whether it is possible to share an HDMI capture signal
*s Capabilities supports_Audio_Checkup: <on/off> // Whether audio troubleshooting mode is supported: Not implemented in the ZR-CSAPI.
*s Capabilities supports_Loading_Participants_Dynamically: <on/off> // Whether the Zoom Room supports loading meeting participants in a scalable manner, to acccommodate large webinars of > 1000 participants
*s Capabilities supports_CheckIn: <on/off> // whether or not the Zoom Room can be configured to require users to check in to avoid having a meeting cancelled. Not supported in the ZR-CSAPI.
*s Capabilities supports_Expel_User_Permanently: <on/off> // Whether Expelled users are removed from meetings permanently, until the meeting is ended for all.
*s Capabilities supports_Multi_Share: <on/off> //Whether multi_share is supported
*s Capabilities supports_Mic_Record_Test: <on/off> //Whether recording mic test is supported
*s Capabilities supports_Encrypted_Connection: <on/off> //Whether encrypted connection is supported
*s Capabilities supports_H323_DTMF: <on/off> //Whether H323 DTMF is supported
*s Capabilities supports_Cloud_PBX: <on/off> //Whether cloud PBX is supported
** end
OK

Example

zStatus Capabilities
*s Capabilities is_Airhost_Disabled: off
*s Capabilities can_Dtmf_For_Invite_By_Phone: on
*s Capabilities pstn_Call_In_Local_resentation: on
*s Capabilities can_Ringing_In_Pstn_Call: on
*s Capabilities supports_Sip_Call_out: on
*s Capabilities aec_Setting_Stored_In_ZR: on
*s Capabilities supports_Web_Settings_Push: on
*s Capabilities support_Pin_And_Spotlight: on
*s Capabilities can_Mute_On_Entry: on
*s Capabilities support_Claim_Host: on
*s Capabilities support_Out_Room_Display: on
*s Capabilities can_Switch_To_Specific_Camera: on
*s Capabilities supports_Software_Audio_Processing: on
*s Capabilities supports_Hdmi_Cec_Control: on
*s Capabilities supports_Highly_Reverberant_Room: on
*s Capabilities supports_Share_For_Floating_And_Content_Only: on
*s Capabilities supports_Loading_Contacts_Dynamically: on
*s Capabilities supports_ShareCamera: on
*s Capabilities supports_Audio_Checkup: on
*s Capabilities supports_Loading_Participants_Dynamically: on
*s Capabilities supports_CheckIn: on
*s Capabilities supports_Expel_User_Permanently: on
*s Capabilities supports_Multi_Share: on
*s Capabilities supports_Mic_Record_Test: on
*s Capabilities supports_Encrypted_Connection: on
*s Capabilities supports_H323_DTMF: on
*s Capabilities supports_Cloud_PBX: off
** end
OK

zStatus Sharing

Get status of sharing

Schema:

zStatus Sharing
*s Sharing wifiName: <string> // If the ZR uses a WiFi access point, then the name of that WiFi hot spot appears here. It will be blank if the ZR has a wired connection.  You need to display that WiFi access point name to the user, so the user can connect the laptop to that WiFi network. If the ZR is on a wired connection, this entry will be empty.
*s Sharing serverName: <string> // Name of Zoom Room.
*s Sharing password: <string> // The airplay password, for sharing your iOS device. It is not the sharing key or the meeting password.
*s Sharing isAirHostClientConnected: <on/off> // Used in the notification. When this entry is set to true, you know that you are now in a sharing meeting, and you can remove the airplay instructions.
*s Sharing isBlackMagicConnected: <on/off> // Set to on if a compatible HDMI capture device is connected via USB to the Zoom Room. We support Magewell and INOGENI.
*s Sharing isBlackMagicDataAvailable: <on/off> // Set to on, if the user has connected an HDMI cable from a laptop to the HDMI capture card, and the HDMI capture card sees HDMI video coming from the Laptop.
*s Sharing isSharingBlackMagic: <on/off> // Whether HDMI is currently actively sharing.
*s Sharing directPresentationPairingCode: <string> // This is the paring code that is broadcast via an ultrasonic signal from the ZRC. It is different than the user-supplied paring code. The ZRC uses a Zoom-proprietary method of advertizing the ultrasonic pairing code, so it's not possible to advertize it using commonly available libraries.
*s Sharing directPresentationSharingKey: <string> // The alpha-only sharing key that users type into a laptop client to share with the Zoom Room.
*s Sharing isDirectPresentationConnected: <on/off> // The laptop has connected to the ZR, either via HDMI, or via network sharing.
*s Sharing dispState: <None | Laptop | IOS> // Gets the instructions the ZR is displaying on the monitor
** end
OK

Example:

zStatus Sharing
*s Sharing wifiName: 
*s Sharing serverName: ZR-ScottFirestone2
*s Sharing password: 4621
*s Sharing isAirHostClientConnected: off
*s Sharing isBlackMagicConnected: off
*s Sharing isBlackMagicDataAvailable: off
*s Sharing isSharingBlackMagic: off
*s Sharing directPresentationPairingCode: 450031
*s Sharing directPresentationSharingKey: JTEXBA
*s Sharing isDirectPresentationConnected: off
*s Sharing dispState: None
** end
OK

zStatus CameraShare - In-Meeting

Gets status of camera sharing

Bug: It seems pan_Tilt_Speed is always 0

Schema:

zStatus CameraShare
*s zStatus CameraShare is_Sharing: <bool> // Whether the camera is currently being shared
*s zStatus CameraShare id: <string> // If sharing, the id for the camera that is sharing
*s zStatus CameraShare can_Control_Camera: <bool> // Whether it is possible to use the PTZ controls to control the camera.
*s zStatus CameraShare is_Mirrored: <bool> // Whether the camera is currently mirrored.
*s CameraShare pan_Tilt_Speed: <int> // Movement speed of camera when sharing
** end
OK

Example:

zStatus CameraShare
*s CameraShare is_Sharing: off
*s CameraShare id: 
*s CameraShare can_Control_Camera: off
*s CameraShare is_Mirrored: off
*s CameraShare pan_Tilt_Speed: 0
** end
OK

zStatus Call Layout - In-Meeting

Video layout Capabilities and status. Lists which video layout state transitions are allowed at this moment. The logic in the ZR to determine what layouts are allowed is complex. The possible allowed layouts depend on:

  • The number of monitors attached (1, 2, 3).
  • The Web portal settings for this Zoom Room under the Display Settings tab.
  • Whether sharing is active.
  • Whether the Zoom Room camera video is muted or unmuted.

Known Bug: This command does not currently display whether you can switch to strip view (thumbnail view on iPad ZRC), to do this, use zStatus NumberOfScreens, strip view can be used if number of screens is 1.

Schema:

zStatus Call Layout
*s Layout can_Switch_Wall_View: <on/off> // On if it is possible to invoke zConfiguration Call Layout Style: Gallery, to switch to the Gallery mode, showing video participants in tiled windows: The Zoom Room shows up to a 5x5 array of tiled windows per page.
*s Layout can_Adjust_Floating_Video: <on/off> // On if it is possible to change the position and size of the thumbnail shown in Speaker view, by invoking zConfiguration Call Layout Position/Size.
*s Layout can_Switch_Floating_Share_Content: <on/off> // on if it is possible to invoke zConfiguration Call Layout ShareThumb: on, to put the sharing content into a small video thumbnail.
*s Layout can_Switch_Share_On_All_Screens: <on/off> // Set to On if it is possible to invoke zConfiguration Call Layout Style: ShareAll, to switch to the ShareAll mode, where the content sharing is shown full screen on all monitors.
*s Layout can_Switch_Speaker_View: <on/off> // Set to On if it is possible to switch to Speaker view by invoking zConfiguration Call Layout Style: Speaker. The active speaker is shown full screen, and other video streams, like self-view, are shown in thumbnails.

These are valid only if the Layout Style is currently Gallery or Strip:

*s Layout is_supported: <on/off> //Set to On if it is possible to change the parameters 
*s Layout is_In_First_Page: <on/off> // Set to On if the ZR is showing the first page of possibly multiple pages of videos. The UI can show left/right arrow button to flip between pages: When On, gray out the left arrow button.
*s Layout is_In_Last_Page: <on/off> // Set to On if the ZR is showing the last page of possibly multiple pages of videos. On the UI, gray out the right arrow button.
*s Layout video_Type: <Gallery | Strip> // Indicates which mode applies: Strip or Gallery.
*s Layout video_Count_In_Current_Page: <int> // For the filmstrip only, specifies the number of thumbnails shown.

Example:

zStatus Call Layout
*s Layout can_Switch_Wall_View: off
*s Layout can_Adjust_Floating_Video: off
*s Layout can_Switch_Floating_Share_Content: off
*s Layout can_Switch_Share_On_All_Screens: off
*s Layout can_Switch_Speaker_View: off
*s Layout is_supported: on
*s Layout is_In_First_Page: on
*s Layout is_In_Last_Page: on
*s Layout video_Type: Strip
*s Layout video_Count_In_Current_Page: 0
** end
OK

zStatus Call ClosedCaption Available - In-Meeting

Gets whether closed captioning is currently available. This can either be queried, or it will return an asynchronous notification when availability changes.

Schema:

zStatus Call ClosedCaption Available

Example (Querying):

zStatus Call ClosedCaption Available
*s Call ClosedCaption Available: off
** end
OK

Example (Asynchronous):

*s Call ClosedCaption Available: off
** end

zStatus NumberOfScreens

Get number of screens attached to the Zoom Room. Can be queried or asynchronous when number of screen changes.

Schema

zstatus NumberOfScreens
*s NumberOfScreens: <int> //Total number of Screens
*s NumberOfCECScreens: <int> //Number of CEC connected screens
** end
OK

Example (Querying):

zstatus NumberOfScreens
*s NumberOfScreens: 3
*s NumberOfCECScreens: 0
** end
OK

Example (Asynchronous):

zstatus NumberOfScreens
*s NumberOfScreens: 3
*s NumberOfCECScreens: 0
** end