Chilkat Online Tools

unicodeC / Zoom API / Get Zoom Room account settings

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkJsonObjectW queryParams;
    HCkHttpResponseW resp;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    BOOL Detect_microphone_error_alert;
    BOOL Detect_bluetooth_microphone_error_alert;
    BOOL Detect_speaker_error_alert;
    BOOL Detect_bluetooth_speaker_error_alert;
    BOOL Detect_camera_error_alert;
    BOOL Audio_not_meet_usability_threshold;
    BOOL Battery_low_and_not_charging;
    BOOL Controller_scheduling_disconnected;
    BOOL Cpu_usage_high_detected;
    BOOL Network_unstable_detected;
    BOOL Zoom_room_offline;
    BOOL Sip_registration_failed;
    BOOL Mic_speaker_camera_disconnected;
    BOOL Zoom_room_display_disconnected;

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global Unlock Sample for sample code.

    http = CkHttpW_Create();

    queryParams = CkJsonObjectW_Create();
    CkJsonObjectW_UpdateString(queryParams,L"setting_type",L"meeting");

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");

    resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.zoom.us/v2/rooms/account_settings",queryParams);
    if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        return;
    }

    sbResponseBody = CkStringBuilderW_Create();
    CkHttpResponseW_GetBodySb(resp,sbResponseBody);

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpResponseW_getStatusCode(resp);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpResponseW_header(resp));
        wprintf(L"Failed.\n");
        CkHttpResponseW_Dispose(resp);
        CkHttpW_Dispose(http);
        CkJsonObjectW_Dispose(queryParams);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

    CkHttpResponseW_Dispose(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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    Detect_microphone_error_alert = CkJsonObjectW_BoolOf(jResp,L"client_alert.detect_microphone_error_alert");
    Detect_bluetooth_microphone_error_alert = CkJsonObjectW_BoolOf(jResp,L"client_alert.detect_bluetooth_microphone_error_alert");
    Detect_speaker_error_alert = CkJsonObjectW_BoolOf(jResp,L"client_alert.detect_speaker_error_alert");
    Detect_bluetooth_speaker_error_alert = CkJsonObjectW_BoolOf(jResp,L"client_alert.detect_bluetooth_speaker_error_alert");
    Detect_camera_error_alert = CkJsonObjectW_BoolOf(jResp,L"client_alert.detect_camera_error_alert");
    Audio_not_meet_usability_threshold = CkJsonObjectW_BoolOf(jResp,L"notification.audio_not_meet_usability_threshold");
    Battery_low_and_not_charging = CkJsonObjectW_BoolOf(jResp,L"notification.battery_low_and_not_charging");
    Controller_scheduling_disconnected = CkJsonObjectW_BoolOf(jResp,L"notification.controller_scheduling_disconnected");
    Cpu_usage_high_detected = CkJsonObjectW_BoolOf(jResp,L"notification.cpu_usage_high_detected");
    Network_unstable_detected = CkJsonObjectW_BoolOf(jResp,L"notification.network_unstable_detected");
    Zoom_room_offline = CkJsonObjectW_BoolOf(jResp,L"notification.zoom_room_offline");
    Sip_registration_failed = CkJsonObjectW_BoolOf(jResp,L"notification.sip_registration_failed");
    Mic_speaker_camera_disconnected = CkJsonObjectW_BoolOf(jResp,L"notification.mic_speaker_camera_disconnected");
    Zoom_room_display_disconnected = CkJsonObjectW_BoolOf(jResp,L"notification.zoom_room_display_disconnected");


    CkHttpW_Dispose(http);
    CkJsonObjectW_Dispose(queryParams);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(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": ""
    }
  ]
}