TCL / Zoom API / Get Zoom Room account settings
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "setting_type" "meeting"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.zoom.us/v2/rooms/account_settings" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Detect_microphone_error_alert [CkJsonObject_BoolOf $jResp "client_alert.detect_microphone_error_alert"]
set Detect_bluetooth_microphone_error_alert [CkJsonObject_BoolOf $jResp "client_alert.detect_bluetooth_microphone_error_alert"]
set Detect_speaker_error_alert [CkJsonObject_BoolOf $jResp "client_alert.detect_speaker_error_alert"]
set Detect_bluetooth_speaker_error_alert [CkJsonObject_BoolOf $jResp "client_alert.detect_bluetooth_speaker_error_alert"]
set Detect_camera_error_alert [CkJsonObject_BoolOf $jResp "client_alert.detect_camera_error_alert"]
set Audio_not_meet_usability_threshold [CkJsonObject_BoolOf $jResp "notification.audio_not_meet_usability_threshold"]
set Battery_low_and_not_charging [CkJsonObject_BoolOf $jResp "notification.battery_low_and_not_charging"]
set Controller_scheduling_disconnected [CkJsonObject_BoolOf $jResp "notification.controller_scheduling_disconnected"]
set Cpu_usage_high_detected [CkJsonObject_BoolOf $jResp "notification.cpu_usage_high_detected"]
set Network_unstable_detected [CkJsonObject_BoolOf $jResp "notification.network_unstable_detected"]
set Zoom_room_offline [CkJsonObject_BoolOf $jResp "notification.zoom_room_offline"]
set Sip_registration_failed [CkJsonObject_BoolOf $jResp "notification.sip_registration_failed"]
set Mic_speaker_camera_disconnected [CkJsonObject_BoolOf $jResp "notification.mic_speaker_camera_disconnected"]
set Zoom_room_display_disconnected [CkJsonObject_BoolOf $jResp "notification.zoom_room_display_disconnected"]
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}