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"
CkJsonObject_UpdateString $queryParams "custom_query_fields" "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/accounts/:accountId/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": false,
# "enforce_login": false,
# "enforce_login_with_domains": false,
# "enforce_login_domains": "ut Excepteur aute",
# "not_store_meeting_topic": false,
# "require_password_for_scheduling_new_meetings": true,
# "require_password_for_instant_meetings": false,
# "require_password_for_pmi_meetings": false,
# "use_pmi_for_scheduled_meetings": true,
# "use_pmi_for_instant_meetings": false,
# "meeting_authentication": false,
# "embed_password_in_join_link": false
# },
# "in_meeting": {
# "e2e_encryption": true,
# "chat": true,
# "private_chat": false,
# "auto_saving_chat": false,
# "entry_exit_chime": "in ut",
# "feedback": true,
# "post_meeting_feedback": true,
# "co_host": true,
# "polling": true,
# "attendee_on_hold": false,
# "show_meeting_control_toolbar": true,
# "allow_show_zoom_windows": false,
# "annotation": true,
# "whiteboard": false,
# "remote_control": false,
# "webinar_question_answer": true,
# "anonymous_question_answer": true,
# "breakout_room": false,
# "closed_caption": false,
# "far_end_camera_control": false,
# "group_hd": true,
# "virtual_background": false,
# "alert_guest_join": true,
# "auto_answer": true,
# "sending_default_email_invites": true,
# "use_html_format_email": false,
# "dscp_marking": true,
# "stereo_audio": false,
# "original_audio": false,
# "screen_sharing": true,
# "custom_data_center_regions": true,
# "meeting_reactions": false,
# "file_transfer": false,
# "request_permission_to_unmute": false,
# "allow_live_streaming": true,
# "attention_mode_focus_mode": false,
# "webinar_live_streaming": false,
# "webinar_chat": true,
# "save_caption": false,
# "slide_control": true,
# "meeting_survey": false,
# "webinar_polling": true,
# "webinar_survey": false
# },
# "email_notification": {
# "cloud_recording_available_reminder": true,
# "jbh_reminder": false,
# "cancel_meeting_reminder": false,
# "alternative_host_reminder": true,
# "schedule_for_reminder": true
# },
# "recording": {
# "local_recording": false,
# "cloud_recording": false,
# "auto_recording": "est moll",
# "cloud_recording_download": false,
# "account_user_access_recording": false,
# "host_delete_cloud_recording": true,
# "auto_delete_cmr": true,
# "recording_authentication": "ut ipsum labore pari",
# "prevent_host_access_recording": true,
# "ip_address_access_control": {
# "enable": true,
# "ip_addresses_or_ranges": "ea"
# }
# },
# "telephony": {
# "third_party_audio": true,
# "telephony_regions": true
# },
# "tsp": {
# "call_out": false,
# "show_international_numbers_link": true
# },
# "other_options": {
# "blur_snapshot": true
# },
# "audio_conferencing": {
# "toll_free_and_fee_based_toll_call": false
# }
# }
# 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 Enforce_login [CkJsonObject_BoolOf $jResp "schedule_meeting.enforce_login"]
set Enforce_login_with_domains [CkJsonObject_BoolOf $jResp "schedule_meeting.enforce_login_with_domains"]
set Enforce_login_domains [CkJsonObject_stringOf $jResp "schedule_meeting.enforce_login_domains"]
set Not_store_meeting_topic [CkJsonObject_BoolOf $jResp "schedule_meeting.not_store_meeting_topic"]
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 Use_pmi_for_scheduled_meetings [CkJsonObject_BoolOf $jResp "schedule_meeting.use_pmi_for_scheduled_meetings"]
set Use_pmi_for_instant_meetings [CkJsonObject_BoolOf $jResp "schedule_meeting.use_pmi_for_instant_meetings"]
set Meeting_authentication [CkJsonObject_BoolOf $jResp "schedule_meeting.meeting_authentication"]
set Embed_password_in_join_link [CkJsonObject_BoolOf $jResp "schedule_meeting.embed_password_in_join_link"]
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_stringOf $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 Webinar_question_answer [CkJsonObject_BoolOf $jResp "in_meeting.webinar_question_answer"]
set Anonymous_question_answer [CkJsonObject_BoolOf $jResp "in_meeting.anonymous_question_answer"]
set Breakout_room [CkJsonObject_BoolOf $jResp "in_meeting.breakout_room"]
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 Dscp_marking [CkJsonObject_BoolOf $jResp "in_meeting.dscp_marking"]
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 Custom_data_center_regions [CkJsonObject_BoolOf $jResp "in_meeting.custom_data_center_regions"]
set Meeting_reactions [CkJsonObject_BoolOf $jResp "in_meeting.meeting_reactions"]
set File_transfer [CkJsonObject_BoolOf $jResp "in_meeting.file_transfer"]
set Request_permission_to_unmute [CkJsonObject_BoolOf $jResp "in_meeting.request_permission_to_unmute"]
set Allow_live_streaming [CkJsonObject_BoolOf $jResp "in_meeting.allow_live_streaming"]
set Attention_mode_focus_mode [CkJsonObject_BoolOf $jResp "in_meeting.attention_mode_focus_mode"]
set Webinar_live_streaming [CkJsonObject_BoolOf $jResp "in_meeting.webinar_live_streaming"]
set Webinar_chat [CkJsonObject_BoolOf $jResp "in_meeting.webinar_chat"]
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_stringOf $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 Recording_authentication [CkJsonObject_stringOf $jResp "recording.recording_authentication"]
set Prevent_host_access_recording [CkJsonObject_BoolOf $jResp "recording.prevent_host_access_recording"]
set Enable [CkJsonObject_BoolOf $jResp "recording.ip_address_access_control.enable"]
set Ip_addresses_or_ranges [CkJsonObject_stringOf $jResp "recording.ip_address_access_control.ip_addresses_or_ranges"]
set Third_party_audio [CkJsonObject_BoolOf $jResp "telephony.third_party_audio"]
set Telephony_regions [CkJsonObject_BoolOf $jResp "telephony.telephony_regions"]
set Call_out [CkJsonObject_BoolOf $jResp "tsp.call_out"]
set Show_international_numbers_link [CkJsonObject_BoolOf $jResp "tsp.show_international_numbers_link"]
set Blur_snapshot [CkJsonObject_BoolOf $jResp "other_options.blur_snapshot"]
set Toll_free_and_fee_based_toll_call [CkJsonObject_BoolOf $jResp "audio_conferencing.toll_free_and_fee_based_toll_call"]
delete_CkHttp $http
delete_CkJsonObject $queryParams
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -G -d "option=quis%20officia%20in%20reprehenderit"
-d "custom_query_fields=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/lock_settings
Postman Collection Item JSON
{
"name": "Get locked settings",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/lock_settings?option=quis officia in reprehenderit&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"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."
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit",
"description": "Provide the name of the field by which you would like to filter the response. For example, if you provide \"host_video\" as the value of this field, you will get a response similar to the following:<br>\n{\n \"schedule_meeting\": {\n \"host_video\": false\n }\n}\n<br>You can provide multiple values by separating them with commas(example: \"host_video,participant_video”)."
}
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide \"me\" as the value of this field. <br> To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field."
}
]
},
"description": "[Account Locked Settings](https://support.zoom.us/hc/en-us/articles/115005269866) allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users.\nUse this API to retrieve an account's locked settings. \n\n**Note:** This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled. <br><br>\n**Prerequisites:**\n* Pro or a higher paid account. <br>\n\n**Scope**: `account:read:admin`.\n<br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`<br>\n\n\n\n\n\n**Scope:** account:read:admin"
},
"response": [
{
"name": "**Error Code:** `200`<br>\nOnly available for paid account:$accountId.\n\n**HTTP Status Code:** `200`<br>\nLocked settings for the Account returned.\n\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/lock_settings?option=quis officia in reprehenderit&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit"
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide \"me\" as the value of this field. <br> To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field."
}
]
}
},
"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\": false,\n \"enforce_login\": false,\n \"enforce_login_with_domains\": false,\n \"enforce_login_domains\": \"ut Excepteur aute\",\n \"not_store_meeting_topic\": false,\n \"require_password_for_scheduling_new_meetings\": true,\n \"require_password_for_instant_meetings\": false,\n \"require_password_for_pmi_meetings\": false,\n \"use_pmi_for_scheduled_meetings\": true,\n \"use_pmi_for_instant_meetings\": false,\n \"meeting_authentication\": false,\n \"embed_password_in_join_link\": false\n },\n \"in_meeting\": {\n \"e2e_encryption\": true,\n \"chat\": true,\n \"private_chat\": false,\n \"auto_saving_chat\": false,\n \"entry_exit_chime\": \"in ut\",\n \"feedback\": true,\n \"post_meeting_feedback\": true,\n \"co_host\": true,\n \"polling\": true,\n \"attendee_on_hold\": false,\n \"show_meeting_control_toolbar\": true,\n \"allow_show_zoom_windows\": false,\n \"annotation\": true,\n \"whiteboard\": false,\n \"remote_control\": false,\n \"webinar_question_answer\": true,\n \"anonymous_question_answer\": true,\n \"breakout_room\": false,\n \"closed_caption\": false,\n \"far_end_camera_control\": false,\n \"group_hd\": true,\n \"virtual_background\": false,\n \"alert_guest_join\": true,\n \"auto_answer\": true,\n \"sending_default_email_invites\": true,\n \"use_html_format_email\": false,\n \"dscp_marking\": true,\n \"stereo_audio\": false,\n \"original_audio\": false,\n \"screen_sharing\": true,\n \"custom_data_center_regions\": true,\n \"meeting_reactions\": false,\n \"file_transfer\": false,\n \"request_permission_to_unmute\": false,\n \"allow_live_streaming\": true,\n \"attention_mode_focus_mode\": false,\n \"webinar_live_streaming\": false,\n \"webinar_chat\": true,\n \"save_caption\": false,\n \"slide_control\": true,\n \"meeting_survey\": false,\n \"webinar_polling\": true,\n \"webinar_survey\": false\n },\n \"email_notification\": {\n \"cloud_recording_available_reminder\": true,\n \"jbh_reminder\": false,\n \"cancel_meeting_reminder\": false,\n \"alternative_host_reminder\": true,\n \"schedule_for_reminder\": true\n },\n \"recording\": {\n \"local_recording\": false,\n \"cloud_recording\": false,\n \"auto_recording\": \"est moll\",\n \"cloud_recording_download\": false,\n \"account_user_access_recording\": false,\n \"host_delete_cloud_recording\": true,\n \"auto_delete_cmr\": true,\n \"recording_authentication\": \"ut ipsum labore pari\",\n \"prevent_host_access_recording\": true,\n \"ip_address_access_control\": {\n \"enable\": true,\n \"ip_addresses_or_ranges\": \"ea\"\n }\n },\n \"telephony\": {\n \"third_party_audio\": true,\n \"telephony_regions\": true\n },\n \"tsp\": {\n \"call_out\": false,\n \"show_international_numbers_link\": true\n },\n \"other_options\": {\n \"blur_snapshot\": true\n },\n \"audio_conferencing\": {\n \"toll_free_and_fee_based_toll_call\": false\n }\n}"
},
{
"name": "**HTTP Status Code:** `400`<br>\n**Error Code:** `2001`<br>\nAccount does not exist: $subAccountId.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/lock_settings?option=quis officia in reprehenderit&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit"
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide \"me\" as the value of this field. <br> To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
