Node.js / Zoom API / Get locked 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("option","quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>";
// resp: HttpResponse
var resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/groups/:groupId/lock_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)
// {
// "schedule_meeting": {
// "host_video": true,
// "participant_video": true,
// "audio_type": true,
// "join_before_host": true,
// "force_pmi_jbh_password": true,
// "require_password_for_scheduling_new_meetings": true,
// "require_password_for_instant_meetings": false,
// "require_password_for_pmi_meetings": true,
// "pstn_password_protected": true,
// "mute_upon_entry": true,
// "upcoming_meeting_reminder": true
// },
// "in_meeting": {
// "e2e_encryption": true,
// "chat": true,
// "private_chat": true,
// "auto_saving_chat": true,
// "entry_exit_chime": false,
// "feedback": true,
// "post_meeting_feedback": true,
// "co_host": true,
// "polling": true,
// "attendee_on_hold": true,
// "show_meeting_control_toolbar": true,
// "allow_show_zoom_windows": true,
// "annotation": true,
// "whiteboard": true,
// "remote_control": true,
// "non_verbal_feedback": true,
// "breakout_room": true,
// "remote_support": true,
// "closed_caption": true,
// "far_end_camera_control": true,
// "group_hd": true,
// "virtual_background": true,
// "alert_guest_join": true,
// "auto_answer": true,
// "sending_default_email_invites": true,
// "use_html_format_email": true,
// "stereo_audio": true,
// "original_audio": true,
// "screen_sharing": true,
// "waiting_room": true,
// "show_browser_join_link": true,
// "show_a_join_from_your_browser_link": true,
// "allow_live_streaming": true,
// "webinar_live_streaming": true,
// "webinar_chat": true,
// "webinar_question_answer": true,
// "save_caption": true,
// "slide_control": true,
// "meeting_survey": true,
// "webinar_polling": true,
// "webinar_survey": true
// },
// "email_notification": {
// "cloud_recording_available_reminder": true,
// "jbh_reminder": true,
// "cancel_meeting_reminder": true,
// "alternative_host_reminder": true,
// "schedule_for_reminder": true
// },
// "recording": {
// "local_recording": false,
// "cloud_recording": false,
// "auto_recording": false,
// "cloud_recording_download": false,
// "account_user_access_recording": false,
// "host_delete_cloud_recording": false,
// "auto_delete_cmr": false
// },
// "telephony": {
// "third_party_audio": false
// },
// "other_options": {
// "blur_snapshot": true
// },
// "audio_conferencing": {
// "toll_call": true
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var Host_video = jResp.BoolOf("schedule_meeting.host_video");
var Participant_video = jResp.BoolOf("schedule_meeting.participant_video");
var Audio_type = jResp.BoolOf("schedule_meeting.audio_type");
var Join_before_host = jResp.BoolOf("schedule_meeting.join_before_host");
var Force_pmi_jbh_password = jResp.BoolOf("schedule_meeting.force_pmi_jbh_password");
var Require_password_for_scheduling_new_meetings = jResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings");
var Require_password_for_instant_meetings = jResp.BoolOf("schedule_meeting.require_password_for_instant_meetings");
var Require_password_for_pmi_meetings = jResp.BoolOf("schedule_meeting.require_password_for_pmi_meetings");
var Pstn_password_protected = jResp.BoolOf("schedule_meeting.pstn_password_protected");
var Mute_upon_entry = jResp.BoolOf("schedule_meeting.mute_upon_entry");
var Upcoming_meeting_reminder = jResp.BoolOf("schedule_meeting.upcoming_meeting_reminder");
var E2e_encryption = jResp.BoolOf("in_meeting.e2e_encryption");
var Chat = jResp.BoolOf("in_meeting.chat");
var Private_chat = jResp.BoolOf("in_meeting.private_chat");
var Auto_saving_chat = jResp.BoolOf("in_meeting.auto_saving_chat");
var Entry_exit_chime = jResp.BoolOf("in_meeting.entry_exit_chime");
var Feedback = jResp.BoolOf("in_meeting.feedback");
var Post_meeting_feedback = jResp.BoolOf("in_meeting.post_meeting_feedback");
var Co_host = jResp.BoolOf("in_meeting.co_host");
var Polling = jResp.BoolOf("in_meeting.polling");
var Attendee_on_hold = jResp.BoolOf("in_meeting.attendee_on_hold");
var Show_meeting_control_toolbar = jResp.BoolOf("in_meeting.show_meeting_control_toolbar");
var Allow_show_zoom_windows = jResp.BoolOf("in_meeting.allow_show_zoom_windows");
var Annotation = jResp.BoolOf("in_meeting.annotation");
var Whiteboard = jResp.BoolOf("in_meeting.whiteboard");
var Remote_control = jResp.BoolOf("in_meeting.remote_control");
var Non_verbal_feedback = jResp.BoolOf("in_meeting.non_verbal_feedback");
var Breakout_room = jResp.BoolOf("in_meeting.breakout_room");
var Remote_support = jResp.BoolOf("in_meeting.remote_support");
var Closed_caption = jResp.BoolOf("in_meeting.closed_caption");
var Far_end_camera_control = jResp.BoolOf("in_meeting.far_end_camera_control");
var Group_hd = jResp.BoolOf("in_meeting.group_hd");
var Virtual_background = jResp.BoolOf("in_meeting.virtual_background");
var Alert_guest_join = jResp.BoolOf("in_meeting.alert_guest_join");
var Auto_answer = jResp.BoolOf("in_meeting.auto_answer");
var Sending_default_email_invites = jResp.BoolOf("in_meeting.sending_default_email_invites");
var Use_html_format_email = jResp.BoolOf("in_meeting.use_html_format_email");
var Stereo_audio = jResp.BoolOf("in_meeting.stereo_audio");
var Original_audio = jResp.BoolOf("in_meeting.original_audio");
var Screen_sharing = jResp.BoolOf("in_meeting.screen_sharing");
var Waiting_room = jResp.BoolOf("in_meeting.waiting_room");
var Show_browser_join_link = jResp.BoolOf("in_meeting.show_browser_join_link");
var Show_a_join_from_your_browser_link = jResp.BoolOf("in_meeting.show_a_join_from_your_browser_link");
var Allow_live_streaming = jResp.BoolOf("in_meeting.allow_live_streaming");
var Webinar_live_streaming = jResp.BoolOf("in_meeting.webinar_live_streaming");
var Webinar_chat = jResp.BoolOf("in_meeting.webinar_chat");
var Webinar_question_answer = jResp.BoolOf("in_meeting.webinar_question_answer");
var Save_caption = jResp.BoolOf("in_meeting.save_caption");
var Slide_control = jResp.BoolOf("in_meeting.slide_control");
var Meeting_survey = jResp.BoolOf("in_meeting.meeting_survey");
var Webinar_polling = jResp.BoolOf("in_meeting.webinar_polling");
var Webinar_survey = jResp.BoolOf("in_meeting.webinar_survey");
var Cloud_recording_available_reminder = jResp.BoolOf("email_notification.cloud_recording_available_reminder");
var Jbh_reminder = jResp.BoolOf("email_notification.jbh_reminder");
var Cancel_meeting_reminder = jResp.BoolOf("email_notification.cancel_meeting_reminder");
var Alternative_host_reminder = jResp.BoolOf("email_notification.alternative_host_reminder");
var Schedule_for_reminder = jResp.BoolOf("email_notification.schedule_for_reminder");
var Local_recording = jResp.BoolOf("recording.local_recording");
var Cloud_recording = jResp.BoolOf("recording.cloud_recording");
var Auto_recording = jResp.BoolOf("recording.auto_recording");
var Cloud_recording_download = jResp.BoolOf("recording.cloud_recording_download");
var Account_user_access_recording = jResp.BoolOf("recording.account_user_access_recording");
var Host_delete_cloud_recording = jResp.BoolOf("recording.host_delete_cloud_recording");
var Auto_delete_cmr = jResp.BoolOf("recording.auto_delete_cmr");
var Third_party_audio = jResp.BoolOf("telephony.third_party_audio");
var Blur_snapshot = jResp.BoolOf("other_options.blur_snapshot");
var Toll_call = jResp.BoolOf("audio_conferencing.toll_call");
}
chilkatExample();
Curl Command
curl -G -d "option=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/groups/:groupId/lock_settings
Postman Collection Item JSON
{
"name": "Get locked settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/lock_settings?option=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit",
"description": "Optional query parameters: \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account."
}
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) Id of the group."
}
]
},
"description": "Retrieve a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n\n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**Error Code:** `200`<br>\nOnly available for paid account.\n\n**Status Code:** `200`<br>\nLocked settings of group returned.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/lock_settings?option=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) Id of the group."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"schedule_meeting\": {\n \"host_video\": true,\n \"participant_video\": true,\n \"audio_type\": true,\n \"join_before_host\": true,\n \"force_pmi_jbh_password\": true,\n \"require_password_for_scheduling_new_meetings\": true,\n \"require_password_for_instant_meetings\": false,\n \"require_password_for_pmi_meetings\": true,\n \"pstn_password_protected\": true,\n \"mute_upon_entry\": true,\n \"upcoming_meeting_reminder\": true\n },\n \"in_meeting\": {\n \"e2e_encryption\": true,\n \"chat\": true,\n \"private_chat\": true,\n \"auto_saving_chat\": true,\n \"entry_exit_chime\": false,\n \"feedback\": true,\n \"post_meeting_feedback\": true,\n \"co_host\": true,\n \"polling\": true,\n \"attendee_on_hold\": true,\n \"show_meeting_control_toolbar\": true,\n \"allow_show_zoom_windows\": true,\n \"annotation\": true,\n \"whiteboard\": true,\n \"remote_control\": true,\n \"non_verbal_feedback\": true,\n \"breakout_room\": true,\n \"remote_support\": true,\n \"closed_caption\": true,\n \"far_end_camera_control\": true,\n \"group_hd\": true,\n \"virtual_background\": true,\n \"alert_guest_join\": true,\n \"auto_answer\": true,\n \"sending_default_email_invites\": true,\n \"use_html_format_email\": true,\n \"stereo_audio\": true,\n \"original_audio\": true,\n \"screen_sharing\": true,\n \"waiting_room\": true,\n \"show_browser_join_link\": true,\n \"show_a_join_from_your_browser_link\": true,\n \"allow_live_streaming\": true,\n \"webinar_live_streaming\": true,\n \"webinar_chat\": true,\n \"webinar_question_answer\": true,\n \"save_caption\": true,\n \"slide_control\": true,\n \"meeting_survey\": true,\n \"webinar_polling\": true,\n \"webinar_survey\": true\n },\n \"email_notification\": {\n \"cloud_recording_available_reminder\": true,\n \"jbh_reminder\": true,\n \"cancel_meeting_reminder\": true,\n \"alternative_host_reminder\": true,\n \"schedule_for_reminder\": true\n },\n \"recording\": {\n \"local_recording\": false,\n \"cloud_recording\": false,\n \"auto_recording\": false,\n \"cloud_recording_download\": false,\n \"account_user_access_recording\": false,\n \"host_delete_cloud_recording\": false,\n \"auto_delete_cmr\": false\n },\n \"telephony\": {\n \"third_party_audio\": false\n },\n \"other_options\": {\n \"blur_snapshot\": true\n },\n \"audio_conferencing\": {\n \"toll_call\": true\n }\n}"
},
{
"name": "**Status Code:** `404`<br>\nNot found.<br>\n**Error Code:** `4130`<br>\nGroup does not exist: {groupId}",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/lock_settings?option=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) Id of the group."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
