autoit / 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.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oQueryParams = ObjCreate("Chilkat.JsonObject")
$oQueryParams.UpdateString("option","quis officia in reprehenderit")
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
Local $oResp = $oHttp.QuickRequestParams("GET","https://api.zoom.us/v2/groups/:groupId/lock_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)
; {
; "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
Local $bHost_video = $oJResp.BoolOf("schedule_meeting.host_video")
Local $bParticipant_video = $oJResp.BoolOf("schedule_meeting.participant_video")
Local $bAudio_type = $oJResp.BoolOf("schedule_meeting.audio_type")
Local $bJoin_before_host = $oJResp.BoolOf("schedule_meeting.join_before_host")
Local $bForce_pmi_jbh_password = $oJResp.BoolOf("schedule_meeting.force_pmi_jbh_password")
Local $bRequire_password_for_scheduling_new_meetings = $oJResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings")
Local $bRequire_password_for_instant_meetings = $oJResp.BoolOf("schedule_meeting.require_password_for_instant_meetings")
Local $bRequire_password_for_pmi_meetings = $oJResp.BoolOf("schedule_meeting.require_password_for_pmi_meetings")
Local $bPstn_password_protected = $oJResp.BoolOf("schedule_meeting.pstn_password_protected")
Local $bMute_upon_entry = $oJResp.BoolOf("schedule_meeting.mute_upon_entry")
Local $bUpcoming_meeting_reminder = $oJResp.BoolOf("schedule_meeting.upcoming_meeting_reminder")
Local $bE2e_encryption = $oJResp.BoolOf("in_meeting.e2e_encryption")
Local $bChat = $oJResp.BoolOf("in_meeting.chat")
Local $bPrivate_chat = $oJResp.BoolOf("in_meeting.private_chat")
Local $bAuto_saving_chat = $oJResp.BoolOf("in_meeting.auto_saving_chat")
Local $bEntry_exit_chime = $oJResp.BoolOf("in_meeting.entry_exit_chime")
Local $bFeedback = $oJResp.BoolOf("in_meeting.feedback")
Local $bPost_meeting_feedback = $oJResp.BoolOf("in_meeting.post_meeting_feedback")
Local $bCo_host = $oJResp.BoolOf("in_meeting.co_host")
Local $bPolling = $oJResp.BoolOf("in_meeting.polling")
Local $bAttendee_on_hold = $oJResp.BoolOf("in_meeting.attendee_on_hold")
Local $bShow_meeting_control_toolbar = $oJResp.BoolOf("in_meeting.show_meeting_control_toolbar")
Local $bAllow_show_zoom_windows = $oJResp.BoolOf("in_meeting.allow_show_zoom_windows")
Local $bAnnotation = $oJResp.BoolOf("in_meeting.annotation")
Local $bWhiteboard = $oJResp.BoolOf("in_meeting.whiteboard")
Local $bRemote_control = $oJResp.BoolOf("in_meeting.remote_control")
Local $bNon_verbal_feedback = $oJResp.BoolOf("in_meeting.non_verbal_feedback")
Local $bBreakout_room = $oJResp.BoolOf("in_meeting.breakout_room")
Local $bRemote_support = $oJResp.BoolOf("in_meeting.remote_support")
Local $bClosed_caption = $oJResp.BoolOf("in_meeting.closed_caption")
Local $bFar_end_camera_control = $oJResp.BoolOf("in_meeting.far_end_camera_control")
Local $bGroup_hd = $oJResp.BoolOf("in_meeting.group_hd")
Local $bVirtual_background = $oJResp.BoolOf("in_meeting.virtual_background")
Local $bAlert_guest_join = $oJResp.BoolOf("in_meeting.alert_guest_join")
Local $bAuto_answer = $oJResp.BoolOf("in_meeting.auto_answer")
Local $bSending_default_email_invites = $oJResp.BoolOf("in_meeting.sending_default_email_invites")
Local $bUse_html_format_email = $oJResp.BoolOf("in_meeting.use_html_format_email")
Local $bStereo_audio = $oJResp.BoolOf("in_meeting.stereo_audio")
Local $bOriginal_audio = $oJResp.BoolOf("in_meeting.original_audio")
Local $bScreen_sharing = $oJResp.BoolOf("in_meeting.screen_sharing")
Local $bWaiting_room = $oJResp.BoolOf("in_meeting.waiting_room")
Local $bShow_browser_join_link = $oJResp.BoolOf("in_meeting.show_browser_join_link")
Local $bShow_a_join_from_your_browser_link = $oJResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
Local $bAllow_live_streaming = $oJResp.BoolOf("in_meeting.allow_live_streaming")
Local $bWebinar_live_streaming = $oJResp.BoolOf("in_meeting.webinar_live_streaming")
Local $bWebinar_chat = $oJResp.BoolOf("in_meeting.webinar_chat")
Local $bWebinar_question_answer = $oJResp.BoolOf("in_meeting.webinar_question_answer")
Local $bSave_caption = $oJResp.BoolOf("in_meeting.save_caption")
Local $bSlide_control = $oJResp.BoolOf("in_meeting.slide_control")
Local $bMeeting_survey = $oJResp.BoolOf("in_meeting.meeting_survey")
Local $bWebinar_polling = $oJResp.BoolOf("in_meeting.webinar_polling")
Local $bWebinar_survey = $oJResp.BoolOf("in_meeting.webinar_survey")
Local $bCloud_recording_available_reminder = $oJResp.BoolOf("email_notification.cloud_recording_available_reminder")
Local $bJbh_reminder = $oJResp.BoolOf("email_notification.jbh_reminder")
Local $bCancel_meeting_reminder = $oJResp.BoolOf("email_notification.cancel_meeting_reminder")
Local $bAlternative_host_reminder = $oJResp.BoolOf("email_notification.alternative_host_reminder")
Local $bSchedule_for_reminder = $oJResp.BoolOf("email_notification.schedule_for_reminder")
Local $bLocal_recording = $oJResp.BoolOf("recording.local_recording")
Local $bCloud_recording = $oJResp.BoolOf("recording.cloud_recording")
Local $bAuto_recording = $oJResp.BoolOf("recording.auto_recording")
Local $bCloud_recording_download = $oJResp.BoolOf("recording.cloud_recording_download")
Local $bAccount_user_access_recording = $oJResp.BoolOf("recording.account_user_access_recording")
Local $bHost_delete_cloud_recording = $oJResp.BoolOf("recording.host_delete_cloud_recording")
Local $bAuto_delete_cmr = $oJResp.BoolOf("recording.auto_delete_cmr")
Local $bThird_party_audio = $oJResp.BoolOf("telephony.third_party_audio")
Local $bBlur_snapshot = $oJResp.BoolOf("other_options.blur_snapshot")
Local $bToll_call = $oJResp.BoolOf("audio_conferencing.toll_call")
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": ""
}
]
}
