autoit / Zoom API / Get Zoom Room account settings
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("setting_type","meeting")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/rooms/account_settings",$oQueryParams)
If ($oHttp.LastMethodSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oResp.Header & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; 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
Local $bDetect_microphone_error_alert = $oJResp.BoolOf("client_alert.detect_microphone_error_alert")
Local $bDetect_bluetooth_microphone_error_alert = $oJResp.BoolOf("client_alert.detect_bluetooth_microphone_error_alert")
Local $bDetect_speaker_error_alert = $oJResp.BoolOf("client_alert.detect_speaker_error_alert")
Local $bDetect_bluetooth_speaker_error_alert = $oJResp.BoolOf("client_alert.detect_bluetooth_speaker_error_alert")
Local $bDetect_camera_error_alert = $oJResp.BoolOf("client_alert.detect_camera_error_alert")
Local $bAudio_not_meet_usability_threshold = $oJResp.BoolOf("notification.audio_not_meet_usability_threshold")
Local $bBattery_low_and_not_charging = $oJResp.BoolOf("notification.battery_low_and_not_charging")
Local $bController_scheduling_disconnected = $oJResp.BoolOf("notification.controller_scheduling_disconnected")
Local $bCpu_usage_high_detected = $oJResp.BoolOf("notification.cpu_usage_high_detected")
Local $bNetwork_unstable_detected = $oJResp.BoolOf("notification.network_unstable_detected")
Local $bZoom_room_offline = $oJResp.BoolOf("notification.zoom_room_offline")
Local $bSip_registration_failed = $oJResp.BoolOf("notification.sip_registration_failed")
Local $bMic_speaker_camera_disconnected = $oJResp.BoolOf("notification.mic_speaker_camera_disconnected")
Local $bZoom_room_display_disconnected = $oJResp.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": ""
}
]
}
