Zoom

Links

    Zoom API

    Getting access, Developing, Testing

    Back to Zoom

    Get Issues Of Zoom Rooms

    Use this API to return information about the Zoom Rooms in an account with issues, such as disconnected hardware or bandwidth issues. You can specify a monthly date range for the Dashboard data using the from and to query parameters. The month should fall within the last six months.

    Scopes: dashboard_home:read:admin
    Rate Limit Label: Heavy

    Prerequisites:

    • A Business or a higher plan.
    • A Zoom Room must be enabled in the account.

    Input

    type: object properties: parameters: type: object properties: zoomroomId: type: string example: azGzXIVUTWOdEQB79aNHkA description: The Zoom room ID. from: format: date type: string example: '2022-01-01' description: >- Start date in 'yyyy-mm-dd' format. The date range defined by the "from" and "to" parameters should only be one month as the report includes only one month worth of data at once. to: format: date type: string example: '2022-01-28' description: End date. page_size: default: 30 maximum: 300 type: integer example: 30 description: The number of records returned within a single API call. next_page_token: type: string example: IAfJX3jsOLW7w3dokmFl84zOa0MAVGyMEB2 description: >- Use the next page token to paginate through large result sets. A next page token is returned whenever the set of available results exceeds the current page size. This token's expiration period is 15 minutes. required: - zoomroomId - from - to title: Parameters

    Output

    type: object properties: from: description: Start date for this report format: date type: string example: '2022-02-01' to: description: End date for this report format: date type: string example: '2022-02-28' next_page_token: description: >- The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. type: string example: Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3 page_count: description: The number of pages returned for the request made. type: integer example: 1 page_size: default: 30 description: The number of records returned within a single API call. maximum: 300 type: integer example: 30 total_records: description: The number of all records available across pages. type: integer example: 1 issue_details: type: array items: type: object properties: issue: description: >- Zoom Room Issue Detail.<br> The value of the this field could be one of the following:<br> * `Room Controller disconnected`<br> * `Room Controller connected` * `Selected camera has disconnected` * `Selected camera is reconnected` * `Selected microphone has disconnected` * `Selected microphone is reconnected` * `Selected speaker has disconnected` * `Selected speaker is reconnected` * `Zoom room is offline` * `Zoom room is online` * `High CPU usage is detected` * `Low bandwidth network is detected` * `{name} battery is low` * `{name} battery is normal` * `{name} disconnected` * `{name} connected` * `{name} is not charging` Possible values for {name}: <br> * Zoom Rooms Computer * Controller * Scheduling Display type: string example: Untrusted certificate is detected time: description: Time at which the issue was encountered. format: date-time type: string example: '2022-02-27T08:37:05Z'