mcp_config_zoom_room_operation_management.json•10.1 kB
{
"server": {
"url": "https://api.zoom.us/v2"
},
"authentication": [
{
"schema_parameters": {
"in": "header"
},
"type": "apiKey",
"value": "API_KEY"
}
],
"operations": [
{
"description": "Get information about the issues that occured on the Top 25 **Zoom Rooms with issues** in an acount. \u003cbr\u003e 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. **Scope:** `dashboard_home:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`\u003cbr\u003e **Prerequisites:** \u003cbr\u003e * Business or a higher plan. * Zoom Room must be enabled in the account.",
"name": "dashboard_issue_detail_zoom_room"
},
{
"description": "List information on all Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_zr:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Resource-intensive`\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Zoom Rooms set up.",
"name": "dashboard_zoom_rooms"
},
{
"description": "The Zoom Rooms dashboard metrics lets you know the type of configuration a Zoom room has and details on the meetings held in that room. Use this API to retrieve information on a specific room.\u003cbr\u003e\u003cbr\u003e **Scopes:** `dashboard_zr:read:admin`\u003cbr\u003e \u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`**Prerequisites:**\u003cbr\u003e * Business, Education or API Plan with Zoom Rooms set up.",
"name": "dashboard_zoom_room"
},
{
"description": "Use this API to [add a Zoom Room](https://support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "add_a_room"
},
{
"description": "Update information on the account profile of a Zoom Room. This information can only by accessed either by the Zoom Room Account Owner or a user with Zoom Rooms admin permission. To update information on an individual Room Profile, use [Update Zoom Room Profile API](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms/updatezrprofile) instead. **Prerequisites:**\u003cbr\u003e * Zoom account owner or Zoom Rooms admin permissions\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_z_r_acc_profile"
},
{
"description": "Update account settings applied for Zoom Rooms in a Zoom account. With this API, you can update either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms account by specifying the required setting type in the `setting_type` parameter. To update only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter and to update only **Account Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_zoom_room_acc_settings"
},
{
"description": "Update the [location hierarchial structure(s)](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) applied on the Zoom Rooms in an account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Rooms version 4.0 or higher * Account owner or admin permissions\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_zoom_rooms_location_structure"
},
{
"description": "Each location type of the [Zoom Rooms location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) has a profile page that includes information such as name of the location, address, support email, etc. Use this API to update information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located. **Prerequisite:**\u003cbr\u003e * Account owner or admin permission * Zoom Rooms version 4.0 or higher\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_z_r_location_profile"
},
{
"description": "The Zoom Rooms check-in feature helps maximize your room utilization. Use this API to either **check in** and confirm that you are utilizing the room reservation or to **check out** of the room so that the room gets released from the scheduled meeting and will be made available for others to use. Learn more from the [Using the Zoom Rooms check-in feature](https://support.zoom.us/hc/en-us/articles/360001147163-Using-the-Zoom-Rooms-check-in-feature) guide. **Prerequisites:** * [Zoom Rooms](https://support.zoom.us/hc/en-us/articles/207483343-Getting-started-with-Zoom-Rooms#:~:text=Zoom%20Rooms%20is%20a%20software,or%20from%20their%20mobile%20device) must have been set up for use for the account and must be online. * You must have access to the Calendar Integration APIs (either Microsoft Exchange or Google Calendar APIs) to get calendar information associated with the Room. **Scope:** `room:write:admin`",
"name": "check_in_rooms"
},
{
"description": "[Remove](https://support.zoom.us/hc/en-us/articles/360033432032-Zoom-Room-Device-Profiles#h_e55b2092-c418-4b02-819f-44de51448900) a specific Zoom Room profile from a Zoom account.\u003cbr\u003e\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`",
"name": "delete_a_zoom_room"
},
{
"description": "Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to get detailed information on a specific Zoom Room in a Zoom account. **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "get_z_r_profile"
},
{
"description": "Update basic information on a specific Zoom Room in a Zoom account.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e **Scopes**: `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_room_profile"
},
{
"description": "List information about the devices that are being used for a specific [Zoom Room](https://support.zoom.us/hc/en-us/articles/207483343-Getting-Started-with-Zoom-Rooms) in an account. **Prerequisites:**\u003cbr\u003e * Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.\u003cbr\u003e * Account owner or admin permissions. **Scopes**: `room:read:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "list_z_r_devices"
},
{
"description": "[Upgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software#h_1751c48a-644e-4a60-b96a-31ec77c616e6) or [downgrade](https://support.zoom.us/hc/en-us/articles/204675449-Upgrade-or-Downgrade-Zoom-Rooms-Software#h_d97349d6-9253-484c-af80-350475026524) the version of Zoom Rooms App installed in your Mac or Windows device. **Prerequisites:**\u003cbr\u003e * Pro or a higher account with Zoom Rooms. * Zoom Rooms software must be installed either on a Mac or a Windows device. This API does not support other devices.",
"name": "change_zoom_rooms_app_version"
},
{
"description": "Get information on meeting or alert settings applied to a specific Zoom Room. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:read:admin` **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\u003cbr\u003e",
"name": "get_z_r_settings"
},
{
"description": "Update either meeting or alert settings applied to a specific Zoom Room. To update **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter. To update **Meeting Settings**, specify `meeting` as the value of the `setting_type` query parameter.\u003cbr\u003e **Prerequisites:**\u003cbr\u003e * Zoom Room licenses * Owner or Admin privileges on the Zoom Account.\u003cbr\u003e **Scopes:** `room:write:admin`\u003cbr\u003e **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`",
"name": "update_z_r_settings"
}
]
}