lianja / Zoom API / Get locked settings
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateString("option","quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/groups/:groupId/lock_settings",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loQueryParams
return
endif
loSbResponseBody = createobject("CkStringBuilder")
loResp.GetBodySb(loSbResponseBody)
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
? "Response Header:"
? loResp.Header
? "Failed."
release loResp
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
return
endif
release loResp
// 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
llHost_video = loJResp.BoolOf("schedule_meeting.host_video")
llParticipant_video = loJResp.BoolOf("schedule_meeting.participant_video")
llAudio_type = loJResp.BoolOf("schedule_meeting.audio_type")
llJoin_before_host = loJResp.BoolOf("schedule_meeting.join_before_host")
llForce_pmi_jbh_password = loJResp.BoolOf("schedule_meeting.force_pmi_jbh_password")
llRequire_password_for_scheduling_new_meetings = loJResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings")
llRequire_password_for_instant_meetings = loJResp.BoolOf("schedule_meeting.require_password_for_instant_meetings")
llRequire_password_for_pmi_meetings = loJResp.BoolOf("schedule_meeting.require_password_for_pmi_meetings")
llPstn_password_protected = loJResp.BoolOf("schedule_meeting.pstn_password_protected")
llMute_upon_entry = loJResp.BoolOf("schedule_meeting.mute_upon_entry")
llUpcoming_meeting_reminder = loJResp.BoolOf("schedule_meeting.upcoming_meeting_reminder")
llE2e_encryption = loJResp.BoolOf("in_meeting.e2e_encryption")
llChat = loJResp.BoolOf("in_meeting.chat")
llPrivate_chat = loJResp.BoolOf("in_meeting.private_chat")
llAuto_saving_chat = loJResp.BoolOf("in_meeting.auto_saving_chat")
llEntry_exit_chime = loJResp.BoolOf("in_meeting.entry_exit_chime")
llFeedback = loJResp.BoolOf("in_meeting.feedback")
llPost_meeting_feedback = loJResp.BoolOf("in_meeting.post_meeting_feedback")
llCo_host = loJResp.BoolOf("in_meeting.co_host")
llPolling = loJResp.BoolOf("in_meeting.polling")
llAttendee_on_hold = loJResp.BoolOf("in_meeting.attendee_on_hold")
llShow_meeting_control_toolbar = loJResp.BoolOf("in_meeting.show_meeting_control_toolbar")
llAllow_show_zoom_windows = loJResp.BoolOf("in_meeting.allow_show_zoom_windows")
llAnnotation = loJResp.BoolOf("in_meeting.annotation")
llWhiteboard = loJResp.BoolOf("in_meeting.whiteboard")
llRemote_control = loJResp.BoolOf("in_meeting.remote_control")
llNon_verbal_feedback = loJResp.BoolOf("in_meeting.non_verbal_feedback")
llBreakout_room = loJResp.BoolOf("in_meeting.breakout_room")
llRemote_support = loJResp.BoolOf("in_meeting.remote_support")
llClosed_caption = loJResp.BoolOf("in_meeting.closed_caption")
llFar_end_camera_control = loJResp.BoolOf("in_meeting.far_end_camera_control")
llGroup_hd = loJResp.BoolOf("in_meeting.group_hd")
llVirtual_background = loJResp.BoolOf("in_meeting.virtual_background")
llAlert_guest_join = loJResp.BoolOf("in_meeting.alert_guest_join")
llAuto_answer = loJResp.BoolOf("in_meeting.auto_answer")
llSending_default_email_invites = loJResp.BoolOf("in_meeting.sending_default_email_invites")
llUse_html_format_email = loJResp.BoolOf("in_meeting.use_html_format_email")
llStereo_audio = loJResp.BoolOf("in_meeting.stereo_audio")
llOriginal_audio = loJResp.BoolOf("in_meeting.original_audio")
llScreen_sharing = loJResp.BoolOf("in_meeting.screen_sharing")
llWaiting_room = loJResp.BoolOf("in_meeting.waiting_room")
llShow_browser_join_link = loJResp.BoolOf("in_meeting.show_browser_join_link")
llShow_a_join_from_your_browser_link = loJResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
llAllow_live_streaming = loJResp.BoolOf("in_meeting.allow_live_streaming")
llWebinar_live_streaming = loJResp.BoolOf("in_meeting.webinar_live_streaming")
llWebinar_chat = loJResp.BoolOf("in_meeting.webinar_chat")
llWebinar_question_answer = loJResp.BoolOf("in_meeting.webinar_question_answer")
llSave_caption = loJResp.BoolOf("in_meeting.save_caption")
llSlide_control = loJResp.BoolOf("in_meeting.slide_control")
llMeeting_survey = loJResp.BoolOf("in_meeting.meeting_survey")
llWebinar_polling = loJResp.BoolOf("in_meeting.webinar_polling")
llWebinar_survey = loJResp.BoolOf("in_meeting.webinar_survey")
llCloud_recording_available_reminder = loJResp.BoolOf("email_notification.cloud_recording_available_reminder")
llJbh_reminder = loJResp.BoolOf("email_notification.jbh_reminder")
llCancel_meeting_reminder = loJResp.BoolOf("email_notification.cancel_meeting_reminder")
llAlternative_host_reminder = loJResp.BoolOf("email_notification.alternative_host_reminder")
llSchedule_for_reminder = loJResp.BoolOf("email_notification.schedule_for_reminder")
llLocal_recording = loJResp.BoolOf("recording.local_recording")
llCloud_recording = loJResp.BoolOf("recording.cloud_recording")
llAuto_recording = loJResp.BoolOf("recording.auto_recording")
llCloud_recording_download = loJResp.BoolOf("recording.cloud_recording_download")
llAccount_user_access_recording = loJResp.BoolOf("recording.account_user_access_recording")
llHost_delete_cloud_recording = loJResp.BoolOf("recording.host_delete_cloud_recording")
llAuto_delete_cmr = loJResp.BoolOf("recording.auto_delete_cmr")
llThird_party_audio = loJResp.BoolOf("telephony.third_party_audio")
llBlur_snapshot = loJResp.BoolOf("other_options.blur_snapshot")
llToll_call = loJResp.BoolOf("audio_conferencing.toll_call")
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
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": ""
}
]
}
