Node.js / Zoom API / Get Zoom Room settings
Back to Collection Items
var os = require('os');
if (os.platform() == 'win32') {
if (os.arch() == 'ia32') {
var chilkat = require('@chilkat/ck-node21-win-ia32');
} else {
var chilkat = require('@chilkat/ck-node21-win64');
}
} else if (os.platform() == 'linux') {
if (os.arch() == 'arm') {
var chilkat = require('@chilkat/ck-node21-arm');
} else if (os.arch() == 'x86') {
var chilkat = require('@chilkat/ck-node21-linux32');
} else {
var chilkat = require('@chilkat/ck-node21-linux64');
}
} else if (os.platform() == 'darwin') {
if (os.arch() == 'arm64') {
var chilkat = require('@chilkat/ck-node21-mac-m1');
} else {
var chilkat = require('@chilkat/ck-node21-macosx');
}
}
function chilkatExample() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
var http = new chilkat.Http();
var success;
var queryParams = new chilkat.JsonObject();
queryParams.UpdateString("setting_type","meeting");
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/rooms/:roomId/settings",queryParams);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "zoom_rooms": {
// "upcoming_meeting_alert": true,
// "show_alert_before_meeting": false,
// "start_airplay_manually": true,
// "weekly_system_restart": false,
// "display_meeting_list": false,
// "display_top_banner": false,
// "display_feedback_survey": true,
// "auto_direct_sharing": false,
// "transform_meeting_to_private": false,
// "hide_id_for_private_meeting": false,
// "auto_start_scheduled_meeting": true,
// "auto_stop_scheduled_meeting": true,
// "hide_share_instruction": true,
// "audio_device_daily_auto_test": true,
// "support_join_3rd_party_meeting": true,
// "encrypt_shared_screen_content": false,
// "allow_multiple_content_sharing": true,
// "show_non_video_participants": false,
// "show_call_history_in_room": true,
// "show_contact_list_on_controller": true,
// "count_attendees_number_in_room": true,
// "send_whiteboard_to_internal_contact_only": true
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var Upcoming_meeting_alert = jResp.BoolOf("zoom_rooms.upcoming_meeting_alert");
var Show_alert_before_meeting = jResp.BoolOf("zoom_rooms.show_alert_before_meeting");
var Start_airplay_manually = jResp.BoolOf("zoom_rooms.start_airplay_manually");
var Weekly_system_restart = jResp.BoolOf("zoom_rooms.weekly_system_restart");
var Display_meeting_list = jResp.BoolOf("zoom_rooms.display_meeting_list");
var Display_top_banner = jResp.BoolOf("zoom_rooms.display_top_banner");
var Display_feedback_survey = jResp.BoolOf("zoom_rooms.display_feedback_survey");
var Auto_direct_sharing = jResp.BoolOf("zoom_rooms.auto_direct_sharing");
var Transform_meeting_to_private = jResp.BoolOf("zoom_rooms.transform_meeting_to_private");
var Hide_id_for_private_meeting = jResp.BoolOf("zoom_rooms.hide_id_for_private_meeting");
var Auto_start_scheduled_meeting = jResp.BoolOf("zoom_rooms.auto_start_scheduled_meeting");
var Auto_stop_scheduled_meeting = jResp.BoolOf("zoom_rooms.auto_stop_scheduled_meeting");
var Hide_share_instruction = jResp.BoolOf("zoom_rooms.hide_share_instruction");
var Audio_device_daily_auto_test = jResp.BoolOf("zoom_rooms.audio_device_daily_auto_test");
var Support_join_3rd_party_meeting = jResp.BoolOf("zoom_rooms.support_join_3rd_party_meeting");
var Encrypt_shared_screen_content = jResp.BoolOf("zoom_rooms.encrypt_shared_screen_content");
var Allow_multiple_content_sharing = jResp.BoolOf("zoom_rooms.allow_multiple_content_sharing");
var Show_non_video_participants = jResp.BoolOf("zoom_rooms.show_non_video_participants");
var Show_call_history_in_room = jResp.BoolOf("zoom_rooms.show_call_history_in_room");
var Show_contact_list_on_controller = jResp.BoolOf("zoom_rooms.show_contact_list_on_controller");
var Count_attendees_number_in_room = jResp.BoolOf("zoom_rooms.count_attendees_number_in_room");
var Send_whiteboard_to_internal_contact_only = jResp.BoolOf("zoom_rooms.send_whiteboard_to_internal_contact_only");
}
chilkatExample();
Curl Command
curl -G -d "setting_type=meeting"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/rooms/:roomId/settings
Postman Collection Item JSON
{
"name": "Get Zoom Room settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"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."
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
},
"description": "Get information on meeting or alert settings applied to a specific Zoom Room. By default, only **Meeting Settings** are returned. To view only **Alert Settings**, specify `alert` as the value of the `setting_type` query parameter.<br>\n**Prerequisites:**<br>\n* Zoom Room licenses\n* Owner or Admin privileges on the Zoom Account.<br>\n**Scopes:** `room:read:admin`\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br> "
},
"response": [
{
"name": "**HTTP Status Code:** `200` **OK**<br>\nZoom Room settings returned successfully.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"zoom_rooms\": {\n \"upcoming_meeting_alert\": true,\n \"show_alert_before_meeting\": false,\n \"start_airplay_manually\": true,\n \"weekly_system_restart\": false,\n \"display_meeting_list\": false,\n \"display_top_banner\": false,\n \"display_feedback_survey\": true,\n \"auto_direct_sharing\": false,\n \"transform_meeting_to_private\": false,\n \"hide_id_for_private_meeting\": false,\n \"auto_start_scheduled_meeting\": true,\n \"auto_stop_scheduled_meeting\": true,\n \"hide_share_instruction\": true,\n \"audio_device_daily_auto_test\": true,\n \"support_join_3rd_party_meeting\": true,\n \"encrypt_shared_screen_content\": false,\n \"allow_multiple_content_sharing\": true,\n \"show_non_video_participants\": false,\n \"show_call_history_in_room\": true,\n \"show_contact_list_on_controller\": true,\n \"count_attendees_number_in_room\": true,\n \"send_whiteboard_to_internal_contact_only\": true\n }\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n\n**Error Code:** `200`<br>\nZoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAccess restricted.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br>\n\n**Error Code:** `1012`<br>\nRoom not found:{roomId}.\n\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/rooms/:roomId/settings?setting_type=meeting",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms",
":roomId",
"settings"
],
"query": [
{
"key": "setting_type",
"value": "meeting"
}
],
"variable": [
{
"key": "roomId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique identifier of the Zoom Room."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
