PowerBuilder / Zoom API / Get locked settings
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
integer li_Host_video
integer li_Participant_video
integer li_Audio_type
integer li_Join_before_host
integer li_Enforce_login
integer li_Enforce_login_with_domains
string ls_Enforce_login_domains
integer li_Not_store_meeting_topic
integer li_Require_password_for_scheduling_new_meetings
integer li_Require_password_for_instant_meetings
integer li_Require_password_for_pmi_meetings
integer li_Use_pmi_for_scheduled_meetings
integer li_Use_pmi_for_instant_meetings
integer li_Meeting_authentication
integer li_Embed_password_in_join_link
integer li_E2e_encryption
integer li_Chat
integer li_Private_chat
integer li_Auto_saving_chat
string ls_Entry_exit_chime
integer li_Feedback
integer li_Post_meeting_feedback
integer li_Co_host
integer li_Polling
integer li_Attendee_on_hold
integer li_Show_meeting_control_toolbar
integer li_Allow_show_zoom_windows
integer li_Annotation
integer li_Whiteboard
integer li_Remote_control
integer li_Webinar_question_answer
integer li_Anonymous_question_answer
integer li_Breakout_room
integer li_Closed_caption
integer li_Far_end_camera_control
integer li_Group_hd
integer li_Virtual_background
integer li_Alert_guest_join
integer li_Auto_answer
integer li_Sending_default_email_invites
integer li_Use_html_format_email
integer li_Dscp_marking
integer li_Stereo_audio
integer li_Original_audio
integer li_Screen_sharing
integer li_Custom_data_center_regions
integer li_Meeting_reactions
integer li_File_transfer
integer li_Request_permission_to_unmute
integer li_Allow_live_streaming
integer li_Attention_mode_focus_mode
integer li_Webinar_live_streaming
integer li_Webinar_chat
integer li_Save_caption
integer li_Slide_control
integer li_Meeting_survey
integer li_Webinar_polling
integer li_Webinar_survey
integer li_Cloud_recording_available_reminder
integer li_Jbh_reminder
integer li_Cancel_meeting_reminder
integer li_Alternative_host_reminder
integer li_Schedule_for_reminder
integer li_Local_recording
integer li_Cloud_recording
string ls_Auto_recording
integer li_Cloud_recording_download
integer li_Account_user_access_recording
integer li_Host_delete_cloud_recording
integer li_Auto_delete_cmr
string ls_Recording_authentication
integer li_Prevent_host_access_recording
integer li_Enable
string ls_Ip_addresses_or_ranges
integer li_Third_party_audio
integer li_Telephony_regions
integer li_Call_out
integer li_Show_international_numbers_link
integer li_Blur_snapshot
integer li_Toll_free_and_fee_based_toll_call
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_QueryParams.UpdateString("option","quis officia in reprehenderit")
loo_QueryParams.UpdateString("custom_query_fields","quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.zoom.us/v2/accounts/:accountId/lock_settings",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat_9_5_0.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
li_rc = loo_JResp.ConnectToNewObject("Chilkat_9_5_0.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_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
li_Host_video = loo_JResp.BoolOf("schedule_meeting.host_video")
li_Participant_video = loo_JResp.BoolOf("schedule_meeting.participant_video")
li_Audio_type = loo_JResp.BoolOf("schedule_meeting.audio_type")
li_Join_before_host = loo_JResp.BoolOf("schedule_meeting.join_before_host")
li_Enforce_login = loo_JResp.BoolOf("schedule_meeting.enforce_login")
li_Enforce_login_with_domains = loo_JResp.BoolOf("schedule_meeting.enforce_login_with_domains")
ls_Enforce_login_domains = loo_JResp.StringOf("schedule_meeting.enforce_login_domains")
li_Not_store_meeting_topic = loo_JResp.BoolOf("schedule_meeting.not_store_meeting_topic")
li_Require_password_for_scheduling_new_meetings = loo_JResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings")
li_Require_password_for_instant_meetings = loo_JResp.BoolOf("schedule_meeting.require_password_for_instant_meetings")
li_Require_password_for_pmi_meetings = loo_JResp.BoolOf("schedule_meeting.require_password_for_pmi_meetings")
li_Use_pmi_for_scheduled_meetings = loo_JResp.BoolOf("schedule_meeting.use_pmi_for_scheduled_meetings")
li_Use_pmi_for_instant_meetings = loo_JResp.BoolOf("schedule_meeting.use_pmi_for_instant_meetings")
li_Meeting_authentication = loo_JResp.BoolOf("schedule_meeting.meeting_authentication")
li_Embed_password_in_join_link = loo_JResp.BoolOf("schedule_meeting.embed_password_in_join_link")
li_E2e_encryption = loo_JResp.BoolOf("in_meeting.e2e_encryption")
li_Chat = loo_JResp.BoolOf("in_meeting.chat")
li_Private_chat = loo_JResp.BoolOf("in_meeting.private_chat")
li_Auto_saving_chat = loo_JResp.BoolOf("in_meeting.auto_saving_chat")
ls_Entry_exit_chime = loo_JResp.StringOf("in_meeting.entry_exit_chime")
li_Feedback = loo_JResp.BoolOf("in_meeting.feedback")
li_Post_meeting_feedback = loo_JResp.BoolOf("in_meeting.post_meeting_feedback")
li_Co_host = loo_JResp.BoolOf("in_meeting.co_host")
li_Polling = loo_JResp.BoolOf("in_meeting.polling")
li_Attendee_on_hold = loo_JResp.BoolOf("in_meeting.attendee_on_hold")
li_Show_meeting_control_toolbar = loo_JResp.BoolOf("in_meeting.show_meeting_control_toolbar")
li_Allow_show_zoom_windows = loo_JResp.BoolOf("in_meeting.allow_show_zoom_windows")
li_Annotation = loo_JResp.BoolOf("in_meeting.annotation")
li_Whiteboard = loo_JResp.BoolOf("in_meeting.whiteboard")
li_Remote_control = loo_JResp.BoolOf("in_meeting.remote_control")
li_Webinar_question_answer = loo_JResp.BoolOf("in_meeting.webinar_question_answer")
li_Anonymous_question_answer = loo_JResp.BoolOf("in_meeting.anonymous_question_answer")
li_Breakout_room = loo_JResp.BoolOf("in_meeting.breakout_room")
li_Closed_caption = loo_JResp.BoolOf("in_meeting.closed_caption")
li_Far_end_camera_control = loo_JResp.BoolOf("in_meeting.far_end_camera_control")
li_Group_hd = loo_JResp.BoolOf("in_meeting.group_hd")
li_Virtual_background = loo_JResp.BoolOf("in_meeting.virtual_background")
li_Alert_guest_join = loo_JResp.BoolOf("in_meeting.alert_guest_join")
li_Auto_answer = loo_JResp.BoolOf("in_meeting.auto_answer")
li_Sending_default_email_invites = loo_JResp.BoolOf("in_meeting.sending_default_email_invites")
li_Use_html_format_email = loo_JResp.BoolOf("in_meeting.use_html_format_email")
li_Dscp_marking = loo_JResp.BoolOf("in_meeting.dscp_marking")
li_Stereo_audio = loo_JResp.BoolOf("in_meeting.stereo_audio")
li_Original_audio = loo_JResp.BoolOf("in_meeting.original_audio")
li_Screen_sharing = loo_JResp.BoolOf("in_meeting.screen_sharing")
li_Custom_data_center_regions = loo_JResp.BoolOf("in_meeting.custom_data_center_regions")
li_Meeting_reactions = loo_JResp.BoolOf("in_meeting.meeting_reactions")
li_File_transfer = loo_JResp.BoolOf("in_meeting.file_transfer")
li_Request_permission_to_unmute = loo_JResp.BoolOf("in_meeting.request_permission_to_unmute")
li_Allow_live_streaming = loo_JResp.BoolOf("in_meeting.allow_live_streaming")
li_Attention_mode_focus_mode = loo_JResp.BoolOf("in_meeting.attention_mode_focus_mode")
li_Webinar_live_streaming = loo_JResp.BoolOf("in_meeting.webinar_live_streaming")
li_Webinar_chat = loo_JResp.BoolOf("in_meeting.webinar_chat")
li_Save_caption = loo_JResp.BoolOf("in_meeting.save_caption")
li_Slide_control = loo_JResp.BoolOf("in_meeting.slide_control")
li_Meeting_survey = loo_JResp.BoolOf("in_meeting.meeting_survey")
li_Webinar_polling = loo_JResp.BoolOf("in_meeting.webinar_polling")
li_Webinar_survey = loo_JResp.BoolOf("in_meeting.webinar_survey")
li_Cloud_recording_available_reminder = loo_JResp.BoolOf("email_notification.cloud_recording_available_reminder")
li_Jbh_reminder = loo_JResp.BoolOf("email_notification.jbh_reminder")
li_Cancel_meeting_reminder = loo_JResp.BoolOf("email_notification.cancel_meeting_reminder")
li_Alternative_host_reminder = loo_JResp.BoolOf("email_notification.alternative_host_reminder")
li_Schedule_for_reminder = loo_JResp.BoolOf("email_notification.schedule_for_reminder")
li_Local_recording = loo_JResp.BoolOf("recording.local_recording")
li_Cloud_recording = loo_JResp.BoolOf("recording.cloud_recording")
ls_Auto_recording = loo_JResp.StringOf("recording.auto_recording")
li_Cloud_recording_download = loo_JResp.BoolOf("recording.cloud_recording_download")
li_Account_user_access_recording = loo_JResp.BoolOf("recording.account_user_access_recording")
li_Host_delete_cloud_recording = loo_JResp.BoolOf("recording.host_delete_cloud_recording")
li_Auto_delete_cmr = loo_JResp.BoolOf("recording.auto_delete_cmr")
ls_Recording_authentication = loo_JResp.StringOf("recording.recording_authentication")
li_Prevent_host_access_recording = loo_JResp.BoolOf("recording.prevent_host_access_recording")
li_Enable = loo_JResp.BoolOf("recording.ip_address_access_control.enable")
ls_Ip_addresses_or_ranges = loo_JResp.StringOf("recording.ip_address_access_control.ip_addresses_or_ranges")
li_Third_party_audio = loo_JResp.BoolOf("telephony.third_party_audio")
li_Telephony_regions = loo_JResp.BoolOf("telephony.telephony_regions")
li_Call_out = loo_JResp.BoolOf("tsp.call_out")
li_Show_international_numbers_link = loo_JResp.BoolOf("tsp.show_international_numbers_link")
li_Blur_snapshot = loo_JResp.BoolOf("other_options.blur_snapshot")
li_Toll_free_and_fee_based_toll_call = loo_JResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call")
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_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": ""
}
]
}
