Python / Zoom API / Get Zoom Room account settings
Back to Collection Items
import sys
import chilkat2
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat2.Http()
queryParams = chilkat2.JsonObject()
queryParams.UpdateString("setting_type","meeting")
# Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/rooms/account_settings",queryParams)
if (http.LastMethodSuccess == False):
print(http.LastErrorText)
sys.exit()
sbResponseBody = chilkat2.StringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat2.JsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False
print("Response Body:")
print(jResp.Emit())
respStatusCode = resp.StatusCode
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.Header)
print("Failed.")
sys.exit()
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "client_alert": {
# "detect_microphone_error_alert": true,
# "detect_bluetooth_microphone_error_alert": true,
# "detect_speaker_error_alert": true,
# "detect_bluetooth_speaker_error_alert": true,
# "detect_camera_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,
# "network_unstable_detected": false,
# "zoom_room_offline": false,
# "sip_registration_failed": false,
# "mic_speaker_camera_disconnected": false,
# "zoom_room_display_disconnected": false
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Detect_microphone_error_alert = jResp.BoolOf("client_alert.detect_microphone_error_alert")
Detect_bluetooth_microphone_error_alert = jResp.BoolOf("client_alert.detect_bluetooth_microphone_error_alert")
Detect_speaker_error_alert = jResp.BoolOf("client_alert.detect_speaker_error_alert")
Detect_bluetooth_speaker_error_alert = jResp.BoolOf("client_alert.detect_bluetooth_speaker_error_alert")
Detect_camera_error_alert = jResp.BoolOf("client_alert.detect_camera_error_alert")
Audio_not_meet_usability_threshold = jResp.BoolOf("notification.audio_not_meet_usability_threshold")
Battery_low_and_not_charging = jResp.BoolOf("notification.battery_low_and_not_charging")
Controller_scheduling_disconnected = jResp.BoolOf("notification.controller_scheduling_disconnected")
Cpu_usage_high_detected = jResp.BoolOf("notification.cpu_usage_high_detected")
Network_unstable_detected = jResp.BoolOf("notification.network_unstable_detected")
Zoom_room_offline = jResp.BoolOf("notification.zoom_room_offline")
Sip_registration_failed = jResp.BoolOf("notification.sip_registration_failed")
Mic_speaker_camera_disconnected = jResp.BoolOf("notification.mic_speaker_camera_disconnected")
Zoom_room_display_disconnected = jResp.BoolOf("notification.zoom_room_display_disconnected")
Curl Command
curl -G -d "setting_type=meeting"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/account_settings
Postman Collection Item JSON
{
"name": "Get Zoom Room account settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/rooms/account_settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"account_settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting",
"description": "(Required) The type of setting that you would like to retrieve.<br> `alert`: Alert Settings applied on the Zoom Rooms Account.<br>\n`meeting`: Meeting settings of the Zoom Rooms Account. <br>\n`signage`: View digital signage settings of the Zoom Rooms Account."
}
]
},
"description": "Get details on Account Settings of a Zoom Room. With this API, you can view either the **Account Meeting Settings** or the **Alert Settings** (Client Alert Settings and Notfication Settings) of the Zoom Rooms account. By default, only **Account Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.<br><br>\n**Prerequisites:**<br>\n* Zoom Room licenses\n* Owner or Admin privileges on the Zoom Account.<br>\n**Scopes:** `room:read:admin`<br><br> \n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nZR Account Settings returned successfully.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/account_settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"account_settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"client_alert\": {\n \"detect_microphone_error_alert\": true,\n \"detect_bluetooth_microphone_error_alert\": true,\n \"detect_speaker_error_alert\": true,\n \"detect_bluetooth_speaker_error_alert\": true,\n \"detect_camera_error_alert\": true\n },\n \"notification\": {\n \"audio_not_meet_usability_threshold\": false,\n \"battery_low_and_not_charging\": false,\n \"controller_scheduling_disconnected\": false,\n \"cpu_usage_high_detected\": false,\n \"network_unstable_detected\": false,\n \"zoom_room_offline\": false,\n \"sip_registration_failed\": false,\n \"mic_speaker_camera_disconnected\": false,\n \"zoom_room_display_disconnected\": false\n }\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/account_settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
"account_settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
