Swift / Zoom API / Get locked settings
Back to Collection Items
func chilkatTest() {
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
let http = CkoHttp()
var success: Bool
let queryParams = CkoJsonObject()
queryParams.UpdateString("option", value: "quis officia in reprehenderit")
queryParams.UpdateString("custom_query_fields", value: "quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = "<access_token>"
var resp: CkoHttpResponse? = http.QuickRequestParams("GET", url: "https://api.zoom.us/v2/accounts/:accountId/lock_settings", json: queryParams)
if http.LastMethodSuccess == false {
print("\(http.LastErrorText)")
return
}
let sbResponseBody = CkoStringBuilder()
resp!.GetBodySb(sbResponseBody)
let jResp = CkoJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = false
print("Response Body:")
print("\(jResp.Emit())")
var respStatusCode: Int = resp!.StatusCode.intValue
print("Response Status Code = \(respStatusCode)")
if respStatusCode >= 400 {
print("Response Header:")
print("\(resp!.Header)")
print("Failed.")
resp = nil
return
}
resp = nil
// 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
var Host_video: Bool = jResp.BoolOf("schedule_meeting.host_video")
var Participant_video: Bool = jResp.BoolOf("schedule_meeting.participant_video")
var Audio_type: Bool = jResp.BoolOf("schedule_meeting.audio_type")
var Join_before_host: Bool = jResp.BoolOf("schedule_meeting.join_before_host")
var Enforce_login: Bool = jResp.BoolOf("schedule_meeting.enforce_login")
var Enforce_login_with_domains: Bool = jResp.BoolOf("schedule_meeting.enforce_login_with_domains")
var Enforce_login_domains: String? = jResp.StringOf("schedule_meeting.enforce_login_domains")
var Not_store_meeting_topic: Bool = jResp.BoolOf("schedule_meeting.not_store_meeting_topic")
var Require_password_for_scheduling_new_meetings: Bool = jResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings")
var Require_password_for_instant_meetings: Bool = jResp.BoolOf("schedule_meeting.require_password_for_instant_meetings")
var Require_password_for_pmi_meetings: Bool = jResp.BoolOf("schedule_meeting.require_password_for_pmi_meetings")
var Use_pmi_for_scheduled_meetings: Bool = jResp.BoolOf("schedule_meeting.use_pmi_for_scheduled_meetings")
var Use_pmi_for_instant_meetings: Bool = jResp.BoolOf("schedule_meeting.use_pmi_for_instant_meetings")
var Meeting_authentication: Bool = jResp.BoolOf("schedule_meeting.meeting_authentication")
var Embed_password_in_join_link: Bool = jResp.BoolOf("schedule_meeting.embed_password_in_join_link")
var E2e_encryption: Bool = jResp.BoolOf("in_meeting.e2e_encryption")
var Chat: Bool = jResp.BoolOf("in_meeting.chat")
var Private_chat: Bool = jResp.BoolOf("in_meeting.private_chat")
var Auto_saving_chat: Bool = jResp.BoolOf("in_meeting.auto_saving_chat")
var Entry_exit_chime: String? = jResp.StringOf("in_meeting.entry_exit_chime")
var Feedback: Bool = jResp.BoolOf("in_meeting.feedback")
var Post_meeting_feedback: Bool = jResp.BoolOf("in_meeting.post_meeting_feedback")
var Co_host: Bool = jResp.BoolOf("in_meeting.co_host")
var Polling: Bool = jResp.BoolOf("in_meeting.polling")
var Attendee_on_hold: Bool = jResp.BoolOf("in_meeting.attendee_on_hold")
var Show_meeting_control_toolbar: Bool = jResp.BoolOf("in_meeting.show_meeting_control_toolbar")
var Allow_show_zoom_windows: Bool = jResp.BoolOf("in_meeting.allow_show_zoom_windows")
var Annotation: Bool = jResp.BoolOf("in_meeting.annotation")
var Whiteboard: Bool = jResp.BoolOf("in_meeting.whiteboard")
var Remote_control: Bool = jResp.BoolOf("in_meeting.remote_control")
var Webinar_question_answer: Bool = jResp.BoolOf("in_meeting.webinar_question_answer")
var Anonymous_question_answer: Bool = jResp.BoolOf("in_meeting.anonymous_question_answer")
var Breakout_room: Bool = jResp.BoolOf("in_meeting.breakout_room")
var Closed_caption: Bool = jResp.BoolOf("in_meeting.closed_caption")
var Far_end_camera_control: Bool = jResp.BoolOf("in_meeting.far_end_camera_control")
var Group_hd: Bool = jResp.BoolOf("in_meeting.group_hd")
var Virtual_background: Bool = jResp.BoolOf("in_meeting.virtual_background")
var Alert_guest_join: Bool = jResp.BoolOf("in_meeting.alert_guest_join")
var Auto_answer: Bool = jResp.BoolOf("in_meeting.auto_answer")
var Sending_default_email_invites: Bool = jResp.BoolOf("in_meeting.sending_default_email_invites")
var Use_html_format_email: Bool = jResp.BoolOf("in_meeting.use_html_format_email")
var Dscp_marking: Bool = jResp.BoolOf("in_meeting.dscp_marking")
var Stereo_audio: Bool = jResp.BoolOf("in_meeting.stereo_audio")
var Original_audio: Bool = jResp.BoolOf("in_meeting.original_audio")
var Screen_sharing: Bool = jResp.BoolOf("in_meeting.screen_sharing")
var Custom_data_center_regions: Bool = jResp.BoolOf("in_meeting.custom_data_center_regions")
var Meeting_reactions: Bool = jResp.BoolOf("in_meeting.meeting_reactions")
var File_transfer: Bool = jResp.BoolOf("in_meeting.file_transfer")
var Request_permission_to_unmute: Bool = jResp.BoolOf("in_meeting.request_permission_to_unmute")
var Allow_live_streaming: Bool = jResp.BoolOf("in_meeting.allow_live_streaming")
var Attention_mode_focus_mode: Bool = jResp.BoolOf("in_meeting.attention_mode_focus_mode")
var Webinar_live_streaming: Bool = jResp.BoolOf("in_meeting.webinar_live_streaming")
var Webinar_chat: Bool = jResp.BoolOf("in_meeting.webinar_chat")
var Save_caption: Bool = jResp.BoolOf("in_meeting.save_caption")
var Slide_control: Bool = jResp.BoolOf("in_meeting.slide_control")
var Meeting_survey: Bool = jResp.BoolOf("in_meeting.meeting_survey")
var Webinar_polling: Bool = jResp.BoolOf("in_meeting.webinar_polling")
var Webinar_survey: Bool = jResp.BoolOf("in_meeting.webinar_survey")
var Cloud_recording_available_reminder: Bool = jResp.BoolOf("email_notification.cloud_recording_available_reminder")
var Jbh_reminder: Bool = jResp.BoolOf("email_notification.jbh_reminder")
var Cancel_meeting_reminder: Bool = jResp.BoolOf("email_notification.cancel_meeting_reminder")
var Alternative_host_reminder: Bool = jResp.BoolOf("email_notification.alternative_host_reminder")
var Schedule_for_reminder: Bool = jResp.BoolOf("email_notification.schedule_for_reminder")
var Local_recording: Bool = jResp.BoolOf("recording.local_recording")
var Cloud_recording: Bool = jResp.BoolOf("recording.cloud_recording")
var Auto_recording: String? = jResp.StringOf("recording.auto_recording")
var Cloud_recording_download: Bool = jResp.BoolOf("recording.cloud_recording_download")
var Account_user_access_recording: Bool = jResp.BoolOf("recording.account_user_access_recording")
var Host_delete_cloud_recording: Bool = jResp.BoolOf("recording.host_delete_cloud_recording")
var Auto_delete_cmr: Bool = jResp.BoolOf("recording.auto_delete_cmr")
var Recording_authentication: String? = jResp.StringOf("recording.recording_authentication")
var Prevent_host_access_recording: Bool = jResp.BoolOf("recording.prevent_host_access_recording")
var Enable: Bool = jResp.BoolOf("recording.ip_address_access_control.enable")
var Ip_addresses_or_ranges: String? = jResp.StringOf("recording.ip_address_access_control.ip_addresses_or_ranges")
var Third_party_audio: Bool = jResp.BoolOf("telephony.third_party_audio")
var Telephony_regions: Bool = jResp.BoolOf("telephony.telephony_regions")
var Call_out: Bool = jResp.BoolOf("tsp.call_out")
var Show_international_numbers_link: Bool = jResp.BoolOf("tsp.show_international_numbers_link")
var Blur_snapshot: Bool = jResp.BoolOf("other_options.blur_snapshot")
var Toll_free_and_fee_based_toll_call: Bool = jResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call")
}
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": ""
}
]
}
