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")
loQueryParams.UpdateString("custom_query_fields","quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/accounts/:accountId/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": 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
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")
llEnforce_login = loJResp.BoolOf("schedule_meeting.enforce_login")
llEnforce_login_with_domains = loJResp.BoolOf("schedule_meeting.enforce_login_with_domains")
lcEnforce_login_domains = loJResp.StringOf("schedule_meeting.enforce_login_domains")
llNot_store_meeting_topic = loJResp.BoolOf("schedule_meeting.not_store_meeting_topic")
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")
llUse_pmi_for_scheduled_meetings = loJResp.BoolOf("schedule_meeting.use_pmi_for_scheduled_meetings")
llUse_pmi_for_instant_meetings = loJResp.BoolOf("schedule_meeting.use_pmi_for_instant_meetings")
llMeeting_authentication = loJResp.BoolOf("schedule_meeting.meeting_authentication")
llEmbed_password_in_join_link = loJResp.BoolOf("schedule_meeting.embed_password_in_join_link")
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")
lcEntry_exit_chime = loJResp.StringOf("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")
llWebinar_question_answer = loJResp.BoolOf("in_meeting.webinar_question_answer")
llAnonymous_question_answer = loJResp.BoolOf("in_meeting.anonymous_question_answer")
llBreakout_room = loJResp.BoolOf("in_meeting.breakout_room")
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")
llDscp_marking = loJResp.BoolOf("in_meeting.dscp_marking")
llStereo_audio = loJResp.BoolOf("in_meeting.stereo_audio")
llOriginal_audio = loJResp.BoolOf("in_meeting.original_audio")
llScreen_sharing = loJResp.BoolOf("in_meeting.screen_sharing")
llCustom_data_center_regions = loJResp.BoolOf("in_meeting.custom_data_center_regions")
llMeeting_reactions = loJResp.BoolOf("in_meeting.meeting_reactions")
llFile_transfer = loJResp.BoolOf("in_meeting.file_transfer")
llRequest_permission_to_unmute = loJResp.BoolOf("in_meeting.request_permission_to_unmute")
llAllow_live_streaming = loJResp.BoolOf("in_meeting.allow_live_streaming")
llAttention_mode_focus_mode = loJResp.BoolOf("in_meeting.attention_mode_focus_mode")
llWebinar_live_streaming = loJResp.BoolOf("in_meeting.webinar_live_streaming")
llWebinar_chat = loJResp.BoolOf("in_meeting.webinar_chat")
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")
lcAuto_recording = loJResp.StringOf("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")
lcRecording_authentication = loJResp.StringOf("recording.recording_authentication")
llPrevent_host_access_recording = loJResp.BoolOf("recording.prevent_host_access_recording")
llEnable = loJResp.BoolOf("recording.ip_address_access_control.enable")
lcIp_addresses_or_ranges = loJResp.StringOf("recording.ip_address_access_control.ip_addresses_or_ranges")
llThird_party_audio = loJResp.BoolOf("telephony.third_party_audio")
llTelephony_regions = loJResp.BoolOf("telephony.telephony_regions")
llCall_out = loJResp.BoolOf("tsp.call_out")
llShow_international_numbers_link = loJResp.BoolOf("tsp.show_international_numbers_link")
llBlur_snapshot = loJResp.BoolOf("other_options.blur_snapshot")
llToll_free_and_fee_based_toll_call = loJResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call")
release loHttp
release loQueryParams
release loSbResponseBody
release loJResp
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": ""
}
]
}
