TCL / Zoom API / Get locked settings
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set queryParams [new_CkJsonObject]
CkJsonObject_UpdateString $queryParams "option" "quis officia in reprehenderit"
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_QuickRequestParams $http "GET" "https://api.zoom.us/v2/groups/:groupId/lock_settings" $queryParams]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $queryParams
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# 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
set Host_video [CkJsonObject_BoolOf $jResp "schedule_meeting.host_video"]
set Participant_video [CkJsonObject_BoolOf $jResp "schedule_meeting.participant_video"]
set Audio_type [CkJsonObject_BoolOf $jResp "schedule_meeting.audio_type"]
set Join_before_host [CkJsonObject_BoolOf $jResp "schedule_meeting.join_before_host"]
set Force_pmi_jbh_password [CkJsonObject_BoolOf $jResp "schedule_meeting.force_pmi_jbh_password"]
set Require_password_for_scheduling_new_meetings [CkJsonObject_BoolOf $jResp "schedule_meeting.require_password_for_scheduling_new_meetings"]
set Require_password_for_instant_meetings [CkJsonObject_BoolOf $jResp "schedule_meeting.require_password_for_instant_meetings"]
set Require_password_for_pmi_meetings [CkJsonObject_BoolOf $jResp "schedule_meeting.require_password_for_pmi_meetings"]
set Pstn_password_protected [CkJsonObject_BoolOf $jResp "schedule_meeting.pstn_password_protected"]
set Mute_upon_entry [CkJsonObject_BoolOf $jResp "schedule_meeting.mute_upon_entry"]
set Upcoming_meeting_reminder [CkJsonObject_BoolOf $jResp "schedule_meeting.upcoming_meeting_reminder"]
set E2e_encryption [CkJsonObject_BoolOf $jResp "in_meeting.e2e_encryption"]
set Chat [CkJsonObject_BoolOf $jResp "in_meeting.chat"]
set Private_chat [CkJsonObject_BoolOf $jResp "in_meeting.private_chat"]
set Auto_saving_chat [CkJsonObject_BoolOf $jResp "in_meeting.auto_saving_chat"]
set Entry_exit_chime [CkJsonObject_BoolOf $jResp "in_meeting.entry_exit_chime"]
set Feedback [CkJsonObject_BoolOf $jResp "in_meeting.feedback"]
set Post_meeting_feedback [CkJsonObject_BoolOf $jResp "in_meeting.post_meeting_feedback"]
set Co_host [CkJsonObject_BoolOf $jResp "in_meeting.co_host"]
set Polling [CkJsonObject_BoolOf $jResp "in_meeting.polling"]
set Attendee_on_hold [CkJsonObject_BoolOf $jResp "in_meeting.attendee_on_hold"]
set Show_meeting_control_toolbar [CkJsonObject_BoolOf $jResp "in_meeting.show_meeting_control_toolbar"]
set Allow_show_zoom_windows [CkJsonObject_BoolOf $jResp "in_meeting.allow_show_zoom_windows"]
set Annotation [CkJsonObject_BoolOf $jResp "in_meeting.annotation"]
set Whiteboard [CkJsonObject_BoolOf $jResp "in_meeting.whiteboard"]
set Remote_control [CkJsonObject_BoolOf $jResp "in_meeting.remote_control"]
set Non_verbal_feedback [CkJsonObject_BoolOf $jResp "in_meeting.non_verbal_feedback"]
set Breakout_room [CkJsonObject_BoolOf $jResp "in_meeting.breakout_room"]
set Remote_support [CkJsonObject_BoolOf $jResp "in_meeting.remote_support"]
set Closed_caption [CkJsonObject_BoolOf $jResp "in_meeting.closed_caption"]
set Far_end_camera_control [CkJsonObject_BoolOf $jResp "in_meeting.far_end_camera_control"]
set Group_hd [CkJsonObject_BoolOf $jResp "in_meeting.group_hd"]
set Virtual_background [CkJsonObject_BoolOf $jResp "in_meeting.virtual_background"]
set Alert_guest_join [CkJsonObject_BoolOf $jResp "in_meeting.alert_guest_join"]
set Auto_answer [CkJsonObject_BoolOf $jResp "in_meeting.auto_answer"]
set Sending_default_email_invites [CkJsonObject_BoolOf $jResp "in_meeting.sending_default_email_invites"]
set Use_html_format_email [CkJsonObject_BoolOf $jResp "in_meeting.use_html_format_email"]
set Stereo_audio [CkJsonObject_BoolOf $jResp "in_meeting.stereo_audio"]
set Original_audio [CkJsonObject_BoolOf $jResp "in_meeting.original_audio"]
set Screen_sharing [CkJsonObject_BoolOf $jResp "in_meeting.screen_sharing"]
set Waiting_room [CkJsonObject_BoolOf $jResp "in_meeting.waiting_room"]
set Show_browser_join_link [CkJsonObject_BoolOf $jResp "in_meeting.show_browser_join_link"]
set Show_a_join_from_your_browser_link [CkJsonObject_BoolOf $jResp "in_meeting.show_a_join_from_your_browser_link"]
set Allow_live_streaming [CkJsonObject_BoolOf $jResp "in_meeting.allow_live_streaming"]
set Webinar_live_streaming [CkJsonObject_BoolOf $jResp "in_meeting.webinar_live_streaming"]
set Webinar_chat [CkJsonObject_BoolOf $jResp "in_meeting.webinar_chat"]
set Webinar_question_answer [CkJsonObject_BoolOf $jResp "in_meeting.webinar_question_answer"]
set Save_caption [CkJsonObject_BoolOf $jResp "in_meeting.save_caption"]
set Slide_control [CkJsonObject_BoolOf $jResp "in_meeting.slide_control"]
set Meeting_survey [CkJsonObject_BoolOf $jResp "in_meeting.meeting_survey"]
set Webinar_polling [CkJsonObject_BoolOf $jResp "in_meeting.webinar_polling"]
set Webinar_survey [CkJsonObject_BoolOf $jResp "in_meeting.webinar_survey"]
set Cloud_recording_available_reminder [CkJsonObject_BoolOf $jResp "email_notification.cloud_recording_available_reminder"]
set Jbh_reminder [CkJsonObject_BoolOf $jResp "email_notification.jbh_reminder"]
set Cancel_meeting_reminder [CkJsonObject_BoolOf $jResp "email_notification.cancel_meeting_reminder"]
set Alternative_host_reminder [CkJsonObject_BoolOf $jResp "email_notification.alternative_host_reminder"]
set Schedule_for_reminder [CkJsonObject_BoolOf $jResp "email_notification.schedule_for_reminder"]
set Local_recording [CkJsonObject_BoolOf $jResp "recording.local_recording"]
set Cloud_recording [CkJsonObject_BoolOf $jResp "recording.cloud_recording"]
set Auto_recording [CkJsonObject_BoolOf $jResp "recording.auto_recording"]
set Cloud_recording_download [CkJsonObject_BoolOf $jResp "recording.cloud_recording_download"]
set Account_user_access_recording [CkJsonObject_BoolOf $jResp "recording.account_user_access_recording"]
set Host_delete_cloud_recording [CkJsonObject_BoolOf $jResp "recording.host_delete_cloud_recording"]
set Auto_delete_cmr [CkJsonObject_BoolOf $jResp "recording.auto_delete_cmr"]
set Third_party_audio [CkJsonObject_BoolOf $jResp "telephony.third_party_audio"]
set Blur_snapshot [CkJsonObject_BoolOf $jResp "other_options.blur_snapshot"]
set Toll_call [CkJsonObject_BoolOf $jResp "audio_conferencing.toll_call"]
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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": ""
}
]
}
