Get location settings

Get information on meeting or alert settings applied to Zoom Rooms located in a specific location. By default, only Meeting Settings are returned. To view only Alert Settings, specify alert as the value of the setting_type query parameter.

Prerequisites:

Zoom Room licenses

Owner or Admin privileges on the Zoom Account.
Scopes: room:read:admin
Rate Limit Label: Medium

{ "client_alert": { "detect_bluetooth_microphone_error_alert": true, "detect_bluetooth_speaker_error_alert": true, "detect_camera_error_alert": true, "detect_microphone_error_alert": true, "detect_speaker_error_alert": true }, "notification": { "audio_not_meet_usability_threshold": false, "battery_low_and_not_charging": false, "controller_scheduling_disconnected": false, "cpu_usage_high_detected": false, "mic_speaker_camera_disconnected": false, "network_unstable_detected": false, "sip_registration_failed": false, "zoom_room_display_disconnected": false, "zoom_room_offline": false } }

请求参数

Path 参数

locationId

string

必需

Unique identifier of the location type. This can be retrieved using the List Zoom Room Location API (Id property in the response).

Query 参数

setting_type

string

必需

The type of setting that you would like to retrieve.
alert: Alert Settings applied on the Zoom Rooms Account.
meeting: Meeting settings of the Zoom Rooms Account.
signage: Digital signage settings of the Zoom Rooms Account.

默认值:

meeting

返回响应

🟢200**HTTP Status Code:** `200` **OK** Zoom Room location settings returned successfully.

application/json

Body

可选

One of

object

meeting_security

object

可选

zoom_rooms

object

可选

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `200` Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. Access Restricted.

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `4801` Location not found: {locationId}