Swift / Zoom API / Get 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: "meeting_security")
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/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": "boolean",
// "participant_video": "boolean",
// "audio_type": "string",
// "join_before_host": "boolean",
// "use_pmi_for_scheduled_meetings": "boolean",
// "use_pmi_for_instant_meetings": "boolean",
// "enforce_login": "boolean",
// "enforce_login_with_domains": "boolean",
// "enforce_login_domains": "string",
// "not_store_meeting_topic": "boolean",
// "force_pmi_jbh_password": "boolean",
// "require_password_for_scheduling_new_meetings": "boolean",
// "require_password_for_scheduled_meetings": "boolean",
// "require_password_for_instant_meetings": "boolean",
// "require_password_for_pmi_meetings": "string"
// },
// "in_meeting": {
// "e2e_encryption": "boolean",
// "chat": "boolean",
// "allow_participants_chat_with": 2,
// "allow_users_save_chats": 2,
// "private_chat": "boolean",
// "auto_saving_chat": "boolean",
// "entry_exit_chime": "string",
// "record_play_own_voice": "boolean",
// "feedback": "boolean",
// "post_meeting_feedback": "boolean",
// "co_host": "boolean",
// "polling": "boolean",
// "attendee_on_hold": "boolean",
// "show_meeting_control_toolbar": "boolean",
// "allow_show_zoom_windows": "boolean",
// "annotation": "boolean",
// "whiteboard": "boolean",
// "webinar_question_answer": "boolean",
// "anonymous_question_answer": "boolean",
// "breakout_room": "boolean",
// "breakout_room_schedule": true,
// "closed_caption": "boolean",
// "far_end_camera_control": "boolean",
// "group_hd": "boolean",
// "virtual_background": "boolean",
// "watermark": "boolean",
// "watermark_by_default": "boolean",
// "audio_watermark_by_default": "boolean",
// "alert_guest_join": "boolean",
// "auto_answer": "boolean",
// "p2p_connetion": "boolean",
// "p2p_ports": "boolean",
// "ports_range": "string",
// "sending_default_email_invites": "boolean",
// "use_html_format_email": "boolean",
// "dscp_marking": "boolean",
// "dscp_audio": "integer",
// "dscp_video": "integer",
// "stereo_audio": "boolean",
// "original_audio": "boolean",
// "screen_sharing": "boolean",
// "remote_control": "boolean",
// "attention_mode_focus_mode": true,
// "allow_host_to_enable_focus_mode": false,
// "show_a_join_from_your_browser_link": true,
// "join_from_mobile": true,
// "join_from_desktop": true,
// "allow_live_streaming": true,
// "live_streaming_facebook": true,
// "workplace_by_facebook": true,
// "live_streaming_youtube": true,
// "custom_live_streaming_service": true,
// "custom_service_instructions": "specific instructions",
// "webinar_live_streaming": {
// "enable": true,
// "live_streaming_service": [
// "facebook",
// "workplace_by_facebook",
// "youtube",
// "custom_live_streaming_service"
// ],
// "custom_service_instructions": "specific instructions",
// "live_streaming_reminder": true
// },
// "webinar_chat": {
// "enable": true,
// "allow_panelists_chat_with": 1,
// "allow_attendees_chat_with": 1,
// "default_attendees_chat_with": 1,
// "allow_panelists_send_direct_message": true,
// "allow_users_save_chats": 1,
// "allow_auto_save_local_chat_file": true
// },
// "closed_captioning": {
// "enable": true,
// "third_party_captioning_service": false,
// "auto_transcribing": true,
// "view_full_transcript": true,
// "save_caption": true
// },
// "slide_control": true,
// "meeting_survey": true,
// "webinar_polling": {
// "enable": true,
// "advanced_polls": true
// },
// "webinar_survey": true
// },
// "email_notification": {
// "cloud_recording_available_reminder": "boolean",
// "recording_available_reminder_schedulers": true,
// "recording_available_reminder_alternative_hosts": true,
// "jbh_reminder": "boolean",
// "cancel_meeting_reminder": "boolean",
// "low_host_count_reminder": "boolean",
// "alternative_host_reminder": "boolean",
// "schedule_for_reminder": "boolean"
// },
// "zoom_rooms": {
// "upcoming_meeting_alert": "boolean",
// "start_airplay_manually": "boolean",
// "weekly_system_restart": "boolean",
// "list_meetings_with_calendar": "boolean",
// "zr_post_meeting_feedback": "boolean",
// "ultrasonic": "boolean",
// "force_private_meeting": "boolean",
// "hide_host_information": "boolean",
// "cmr_for_instant_meeting": "boolean",
// "auto_start_stop_scheduled_meetings": "boolean"
// },
// "security": {
// "admin_change_name_pic": "boolean",
// "import_photos_from_devices": "boolean",
// "hide_billing_info": "boolean"
// },
// "recording": {
// "local_recording": "boolean",
// "cloud_recording": "boolean",
// "record_speaker_view": "boolean",
// "record_gallery_view": "boolean",
// "record_audio_file": "boolean",
// "save_chat_text": "boolean",
// "show_timestamp": "boolean",
// "recording_audio_transcript": "boolean",
// "auto_recording": "string",
// "cloud_recording_download": "boolean",
// "cloud_recording_download_host": "boolean",
// "account_user_access_recording": "boolean",
// "auto_delete_cmr": "boolean",
// "auto_delete_cmr_days": "integer"
// },
// "telephony": {
// "third_party_audio": "boolean",
// "audio_conference_info": "string"
// },
// "tsp": {
// "call_out": "boolean",
// "call_out_countries": [
// "string"
// ],
// "show_international_numbers_link": "boolean",
// "display_toll_free_numbers": "boolean"
// },
// "integration": {
// "google_calendar": "boolean",
// "google_drive": "boolean",
// "dropbox": "boolean",
// "box": "boolean",
// "microsoft_one_drive": "boolean",
// "kubi": "boolean"
// },
// "feature": {
// "meeting_capacity": "integer"
// },
// "other_options": {
// "allow_auto_active_users": true,
// "blur_snapshot": true,
// "display_meetings_scheduled_for_others": false,
// "use_cdn": "default",
// "allow_users_contact_support_via_chat": true,
// "meeting_qos_and_mos": 0,
// "show_one_user_meeting_on_dashboard": true,
// "allow_users_enter_and_share_pronouns": true
// },
// "audio_conferencing": {
// "toll_free_and_fee_based_toll_call": {
// "enable": true,
// "numbers": [
// {
// "code": "1",
// "country_code": "US",
// "country_name": "United States",
// "number": "+1 5550100",
// "display_number": "+1 5550100(Atlanta)"
// },
// {
// "code": "1",
// "country_code": "US",
// "country_name": "United States",
// "number": "+1 5550101",
// "display_number": "+1 5550101(SanJose)"
// }
// ],
// "allow_webinar_attendees_dial": true
// }
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var strVal: String?
var code: String?
var country_code: String?
var country_name: String?
var v_number: String?
var display_number: String?
var Host_video: String? = jResp.StringOf("schedule_meeting.host_video")
var Participant_video: String? = jResp.StringOf("schedule_meeting.participant_video")
var Audio_type: String? = jResp.StringOf("schedule_meeting.audio_type")
var Join_before_host: String? = jResp.StringOf("schedule_meeting.join_before_host")
var Use_pmi_for_scheduled_meetings: String? = jResp.StringOf("schedule_meeting.use_pmi_for_scheduled_meetings")
var Use_pmi_for_instant_meetings: String? = jResp.StringOf("schedule_meeting.use_pmi_for_instant_meetings")
var Enforce_login: String? = jResp.StringOf("schedule_meeting.enforce_login")
var Enforce_login_with_domains: String? = jResp.StringOf("schedule_meeting.enforce_login_with_domains")
var Enforce_login_domains: String? = jResp.StringOf("schedule_meeting.enforce_login_domains")
var Not_store_meeting_topic: String? = jResp.StringOf("schedule_meeting.not_store_meeting_topic")
var Force_pmi_jbh_password: String? = jResp.StringOf("schedule_meeting.force_pmi_jbh_password")
var Require_password_for_scheduling_new_meetings: String? = jResp.StringOf("schedule_meeting.require_password_for_scheduling_new_meetings")
var Require_password_for_scheduled_meetings: String? = jResp.StringOf("schedule_meeting.require_password_for_scheduled_meetings")
var Require_password_for_instant_meetings: String? = jResp.StringOf("schedule_meeting.require_password_for_instant_meetings")
var Require_password_for_pmi_meetings: String? = jResp.StringOf("schedule_meeting.require_password_for_pmi_meetings")
var E2e_encryption: String? = jResp.StringOf("in_meeting.e2e_encryption")
var Chat: String? = jResp.StringOf("in_meeting.chat")
var Allow_participants_chat_with: Int = jResp.IntOf("in_meeting.allow_participants_chat_with").intValue
var Allow_users_save_chats: Int = jResp.IntOf("in_meeting.allow_users_save_chats").intValue
var Private_chat: String? = jResp.StringOf("in_meeting.private_chat")
var Auto_saving_chat: String? = jResp.StringOf("in_meeting.auto_saving_chat")
var Entry_exit_chime: String? = jResp.StringOf("in_meeting.entry_exit_chime")
var Record_play_own_voice: String? = jResp.StringOf("in_meeting.record_play_own_voice")
var Feedback: String? = jResp.StringOf("in_meeting.feedback")
var Post_meeting_feedback: String? = jResp.StringOf("in_meeting.post_meeting_feedback")
var Co_host: String? = jResp.StringOf("in_meeting.co_host")
var Polling: String? = jResp.StringOf("in_meeting.polling")
var Attendee_on_hold: String? = jResp.StringOf("in_meeting.attendee_on_hold")
var Show_meeting_control_toolbar: String? = jResp.StringOf("in_meeting.show_meeting_control_toolbar")
var Allow_show_zoom_windows: String? = jResp.StringOf("in_meeting.allow_show_zoom_windows")
var Annotation: String? = jResp.StringOf("in_meeting.annotation")
var Whiteboard: String? = jResp.StringOf("in_meeting.whiteboard")
var Webinar_question_answer: String? = jResp.StringOf("in_meeting.webinar_question_answer")
var Anonymous_question_answer: String? = jResp.StringOf("in_meeting.anonymous_question_answer")
var Breakout_room: String? = jResp.StringOf("in_meeting.breakout_room")
var Breakout_room_schedule: Bool = jResp.BoolOf("in_meeting.breakout_room_schedule")
var Closed_caption: String? = jResp.StringOf("in_meeting.closed_caption")
var Far_end_camera_control: String? = jResp.StringOf("in_meeting.far_end_camera_control")
var Group_hd: String? = jResp.StringOf("in_meeting.group_hd")
var Virtual_background: String? = jResp.StringOf("in_meeting.virtual_background")
var Watermark: String? = jResp.StringOf("in_meeting.watermark")
var Watermark_by_default: String? = jResp.StringOf("in_meeting.watermark_by_default")
var Audio_watermark_by_default: String? = jResp.StringOf("in_meeting.audio_watermark_by_default")
var Alert_guest_join: String? = jResp.StringOf("in_meeting.alert_guest_join")
var Auto_answer: String? = jResp.StringOf("in_meeting.auto_answer")
var P2p_connetion: String? = jResp.StringOf("in_meeting.p2p_connetion")
var P2p_ports: String? = jResp.StringOf("in_meeting.p2p_ports")
var Ports_range: String? = jResp.StringOf("in_meeting.ports_range")
var Sending_default_email_invites: String? = jResp.StringOf("in_meeting.sending_default_email_invites")
var Use_html_format_email: String? = jResp.StringOf("in_meeting.use_html_format_email")
var Dscp_marking: String? = jResp.StringOf("in_meeting.dscp_marking")
var Dscp_audio: String? = jResp.StringOf("in_meeting.dscp_audio")
var Dscp_video: String? = jResp.StringOf("in_meeting.dscp_video")
var Stereo_audio: String? = jResp.StringOf("in_meeting.stereo_audio")
var Original_audio: String? = jResp.StringOf("in_meeting.original_audio")
var Screen_sharing: String? = jResp.StringOf("in_meeting.screen_sharing")
var Remote_control: String? = jResp.StringOf("in_meeting.remote_control")
var Attention_mode_focus_mode: Bool = jResp.BoolOf("in_meeting.attention_mode_focus_mode")
var Allow_host_to_enable_focus_mode: Bool = jResp.BoolOf("in_meeting.allow_host_to_enable_focus_mode")
var Show_a_join_from_your_browser_link: Bool = jResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
var Join_from_mobile: Bool = jResp.BoolOf("in_meeting.join_from_mobile")
var Join_from_desktop: Bool = jResp.BoolOf("in_meeting.join_from_desktop")
var Allow_live_streaming: Bool = jResp.BoolOf("in_meeting.allow_live_streaming")
var Live_streaming_facebook: Bool = jResp.BoolOf("in_meeting.live_streaming_facebook")
var Workplace_by_facebook: Bool = jResp.BoolOf("in_meeting.workplace_by_facebook")
var Live_streaming_youtube: Bool = jResp.BoolOf("in_meeting.live_streaming_youtube")
var Custom_live_streaming_service: Bool = jResp.BoolOf("in_meeting.custom_live_streaming_service")
var Custom_service_instructions: String? = jResp.StringOf("in_meeting.custom_service_instructions")
var Enable: Bool = jResp.BoolOf("in_meeting.webinar_live_streaming.enable")
var Webinar_live_streamingCustom_service_instructions: String? = jResp.StringOf("in_meeting.webinar_live_streaming.custom_service_instructions")
var Live_streaming_reminder: Bool = jResp.BoolOf("in_meeting.webinar_live_streaming.live_streaming_reminder")
var Webinar_chatEnable: Bool = jResp.BoolOf("in_meeting.webinar_chat.enable")
var Allow_panelists_chat_with: Int = jResp.IntOf("in_meeting.webinar_chat.allow_panelists_chat_with").intValue
var Allow_attendees_chat_with: Int = jResp.IntOf("in_meeting.webinar_chat.allow_attendees_chat_with").intValue
var Default_attendees_chat_with: Int = jResp.IntOf("in_meeting.webinar_chat.default_attendees_chat_with").intValue
var Allow_panelists_send_direct_message: Bool = jResp.BoolOf("in_meeting.webinar_chat.allow_panelists_send_direct_message")
var Webinar_chatAllow_users_save_chats: Int = jResp.IntOf("in_meeting.webinar_chat.allow_users_save_chats").intValue
var Allow_auto_save_local_chat_file: Bool = jResp.BoolOf("in_meeting.webinar_chat.allow_auto_save_local_chat_file")
var Closed_captioningEnable: Bool = jResp.BoolOf("in_meeting.closed_captioning.enable")
var Third_party_captioning_service: Bool = jResp.BoolOf("in_meeting.closed_captioning.third_party_captioning_service")
var Auto_transcribing: Bool = jResp.BoolOf("in_meeting.closed_captioning.auto_transcribing")
var View_full_transcript: Bool = jResp.BoolOf("in_meeting.closed_captioning.view_full_transcript")
var Save_caption: Bool = jResp.BoolOf("in_meeting.closed_captioning.save_caption")
var Slide_control: Bool = jResp.BoolOf("in_meeting.slide_control")
var Meeting_survey: Bool = jResp.BoolOf("in_meeting.meeting_survey")
var Webinar_pollingEnable: Bool = jResp.BoolOf("in_meeting.webinar_polling.enable")
var Advanced_polls: Bool = jResp.BoolOf("in_meeting.webinar_polling.advanced_polls")
var Webinar_survey: Bool = jResp.BoolOf("in_meeting.webinar_survey")
var Cloud_recording_available_reminder: String? = jResp.StringOf("email_notification.cloud_recording_available_reminder")
var Recording_available_reminder_schedulers: Bool = jResp.BoolOf("email_notification.recording_available_reminder_schedulers")
var Recording_available_reminder_alternative_hosts: Bool = jResp.BoolOf("email_notification.recording_available_reminder_alternative_hosts")
var Jbh_reminder: String? = jResp.StringOf("email_notification.jbh_reminder")
var Cancel_meeting_reminder: String? = jResp.StringOf("email_notification.cancel_meeting_reminder")
var Low_host_count_reminder: String? = jResp.StringOf("email_notification.low_host_count_reminder")
var Alternative_host_reminder: String? = jResp.StringOf("email_notification.alternative_host_reminder")
var Schedule_for_reminder: String? = jResp.StringOf("email_notification.schedule_for_reminder")
var Upcoming_meeting_alert: String? = jResp.StringOf("zoom_rooms.upcoming_meeting_alert")
var Start_airplay_manually: String? = jResp.StringOf("zoom_rooms.start_airplay_manually")
var Weekly_system_restart: String? = jResp.StringOf("zoom_rooms.weekly_system_restart")
var List_meetings_with_calendar: String? = jResp.StringOf("zoom_rooms.list_meetings_with_calendar")
var Zr_post_meeting_feedback: String? = jResp.StringOf("zoom_rooms.zr_post_meeting_feedback")
var Ultrasonic: String? = jResp.StringOf("zoom_rooms.ultrasonic")
var Force_private_meeting: String? = jResp.StringOf("zoom_rooms.force_private_meeting")
var Hide_host_information: String? = jResp.StringOf("zoom_rooms.hide_host_information")
var Cmr_for_instant_meeting: String? = jResp.StringOf("zoom_rooms.cmr_for_instant_meeting")
var Auto_start_stop_scheduled_meetings: String? = jResp.StringOf("zoom_rooms.auto_start_stop_scheduled_meetings")
var Admin_change_name_pic: String? = jResp.StringOf("security.admin_change_name_pic")
var Import_photos_from_devices: String? = jResp.StringOf("security.import_photos_from_devices")
var Hide_billing_info: String? = jResp.StringOf("security.hide_billing_info")
var Local_recording: String? = jResp.StringOf("recording.local_recording")
var Cloud_recording: String? = jResp.StringOf("recording.cloud_recording")
var Record_speaker_view: String? = jResp.StringOf("recording.record_speaker_view")
var Record_gallery_view: String? = jResp.StringOf("recording.record_gallery_view")
var Record_audio_file: String? = jResp.StringOf("recording.record_audio_file")
var Save_chat_text: String? = jResp.StringOf("recording.save_chat_text")
var Show_timestamp: String? = jResp.StringOf("recording.show_timestamp")
var Recording_audio_transcript: String? = jResp.StringOf("recording.recording_audio_transcript")
var Auto_recording: String? = jResp.StringOf("recording.auto_recording")
var Cloud_recording_download: String? = jResp.StringOf("recording.cloud_recording_download")
var Cloud_recording_download_host: String? = jResp.StringOf("recording.cloud_recording_download_host")
var Account_user_access_recording: String? = jResp.StringOf("recording.account_user_access_recording")
var Auto_delete_cmr: String? = jResp.StringOf("recording.auto_delete_cmr")
var Auto_delete_cmr_days: String? = jResp.StringOf("recording.auto_delete_cmr_days")
var Third_party_audio: String? = jResp.StringOf("telephony.third_party_audio")
var Audio_conference_info: String? = jResp.StringOf("telephony.audio_conference_info")
var Call_out: String? = jResp.StringOf("tsp.call_out")
var Show_international_numbers_link: String? = jResp.StringOf("tsp.show_international_numbers_link")
var Display_toll_free_numbers: String? = jResp.StringOf("tsp.display_toll_free_numbers")
var Google_calendar: String? = jResp.StringOf("integration.google_calendar")
var Google_drive: String? = jResp.StringOf("integration.google_drive")
var Dropbox: String? = jResp.StringOf("integration.dropbox")
var Box: String? = jResp.StringOf("integration.box")
var Microsoft_one_drive: String? = jResp.StringOf("integration.microsoft_one_drive")
var Kubi: String? = jResp.StringOf("integration.kubi")
var Meeting_capacity: String? = jResp.StringOf("feature.meeting_capacity")
var Allow_auto_active_users: Bool = jResp.BoolOf("other_options.allow_auto_active_users")
var Blur_snapshot: Bool = jResp.BoolOf("other_options.blur_snapshot")
var Display_meetings_scheduled_for_others: Bool = jResp.BoolOf("other_options.display_meetings_scheduled_for_others")
var Use_cdn: String? = jResp.StringOf("other_options.use_cdn")
var Allow_users_contact_support_via_chat: Bool = jResp.BoolOf("other_options.allow_users_contact_support_via_chat")
var Meeting_qos_and_mos: Int = jResp.IntOf("other_options.meeting_qos_and_mos").intValue
var Show_one_user_meeting_on_dashboard: Bool = jResp.BoolOf("other_options.show_one_user_meeting_on_dashboard")
var Allow_users_enter_and_share_pronouns: Bool = jResp.BoolOf("other_options.allow_users_enter_and_share_pronouns")
var Toll_free_and_fee_based_toll_callEnable: Bool = jResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.enable")
var Allow_webinar_attendees_dial: Bool = jResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.allow_webinar_attendees_dial")
var i: Int = 0
var count_i: Int = jResp.SizeOfArray("in_meeting.webinar_live_streaming.live_streaming_service").intValue
while i < count_i {
jResp.I = i
strVal = jResp.StringOf("in_meeting.webinar_live_streaming.live_streaming_service[i]")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("tsp.call_out_countries").intValue
while i < count_i {
jResp.I = i
strVal = jResp.StringOf("tsp.call_out_countries[i]")
i = i + 1
}
i = 0
count_i = jResp.SizeOfArray("audio_conferencing.toll_free_and_fee_based_toll_call.numbers").intValue
while i < count_i {
jResp.I = i
code = jResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].code")
country_code = jResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_code")
country_name = jResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_name")
v_number = jResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].number")
display_number = jResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].display_number")
i = i + 1
}
}
Curl Command
curl -G -d "option=meeting_security"
-d "custom_query_fields=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/accounts/:accountId/settings
Postman Collection Item JSON
{
"name": "Get settings",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/settings?option=meeting_security&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_security",
"description": "Optional query parameters: \n* `meeting_authentication` — Use this query parameter to view the [meeting authentication settings](https://support.zoom.us/hc/en-us/articles/360037117472-Authentication-Profiles-for-Meetings-and-Webinars) applied to the user's account. \n* `recording_authentication` — Use this query parameter to view the [recording authentication settings](https://support.zoom.us/hc/en-us/articles/360037756671-Authentication-Profiles-for-Cloud-Recordings) applied to the user's account. \n* `security` — Use this query parameter to view the account's security settings. For example, password requirements for user login or two-factor authentication. \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": "The name of the field by which to filter the response. For example, if you provide the `host_video` value for this field, you will get a response similar to the following:\n\n`{ \"schedule_meeting\": { \"host_video\": false } }` \n\nTo use multiple values, comma-separate each value. For example: `host_video,participant_video`"
}
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) The account's ID."
}
]
},
"description": "Use this API to get an account's settings information.\n\nTo get the settings of a master account, use `me` as the value for the `accountId` path parameter.\n\n**Scopes:** `account:read:admin`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`\n\n**Prerequisites**: \n* The account must be a paid account"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br> Account settings returned.<br>**Error Code:** `200`<br>\nOnly available for Paid account.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/accounts/:accountId/settings?option=meeting_security&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_security"
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) The account's ID."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"schedule_meeting\": {\n \"host_video\": \"boolean\",\n \"participant_video\": \"boolean\",\n \"audio_type\": \"string\",\n \"join_before_host\": \"boolean\",\n \"use_pmi_for_scheduled_meetings\": \"boolean\",\n \"use_pmi_for_instant_meetings\": \"boolean\",\n \"enforce_login\": \"boolean\",\n \"enforce_login_with_domains\": \"boolean\",\n \"enforce_login_domains\": \"string\",\n \"not_store_meeting_topic\": \"boolean\",\n \"force_pmi_jbh_password\": \"boolean\",\n \"require_password_for_scheduling_new_meetings\": \"boolean\",\n \"require_password_for_scheduled_meetings\": \"boolean\",\n \"require_password_for_instant_meetings\": \"boolean\",\n \"require_password_for_pmi_meetings\": \"string\"\n },\n \"in_meeting\": {\n \"e2e_encryption\": \"boolean\",\n \"chat\": \"boolean\",\n \"allow_participants_chat_with\": 2,\n \"allow_users_save_chats\": 2,\n \"private_chat\": \"boolean\",\n \"auto_saving_chat\": \"boolean\",\n \"entry_exit_chime\": \"string\",\n \"record_play_own_voice\": \"boolean\",\n \"feedback\": \"boolean\",\n \"post_meeting_feedback\": \"boolean\",\n \"co_host\": \"boolean\",\n \"polling\": \"boolean\",\n \"attendee_on_hold\": \"boolean\",\n \"show_meeting_control_toolbar\": \"boolean\",\n \"allow_show_zoom_windows\": \"boolean\",\n \"annotation\": \"boolean\",\n \"whiteboard\": \"boolean\",\n \"webinar_question_answer\": \"boolean\",\n \"anonymous_question_answer\": \"boolean\",\n \"breakout_room\": \"boolean\",\n \"breakout_room_schedule\": true,\n \"closed_caption\": \"boolean\",\n \"far_end_camera_control\": \"boolean\",\n \"group_hd\": \"boolean\",\n \"virtual_background\": \"boolean\",\n \"watermark\": \"boolean\",\n \"watermark_by_default\": \"boolean\",\n \"audio_watermark_by_default\": \"boolean\",\n \"alert_guest_join\": \"boolean\",\n \"auto_answer\": \"boolean\",\n \"p2p_connetion\": \"boolean\",\n \"p2p_ports\": \"boolean\",\n \"ports_range\": \"string\",\n \"sending_default_email_invites\": \"boolean\",\n \"use_html_format_email\": \"boolean\",\n \"dscp_marking\": \"boolean\",\n \"dscp_audio\": \"integer\",\n \"dscp_video\": \"integer\",\n \"stereo_audio\": \"boolean\",\n \"original_audio\": \"boolean\",\n \"screen_sharing\": \"boolean\",\n \"remote_control\": \"boolean\",\n \"attention_mode_focus_mode\": true,\n \"allow_host_to_enable_focus_mode\": false,\n \"show_a_join_from_your_browser_link\": true,\n \"join_from_mobile\": true,\n \"join_from_desktop\": true,\n \"allow_live_streaming\": true,\n \"live_streaming_facebook\": true,\n \"workplace_by_facebook\": true,\n \"live_streaming_youtube\": true,\n \"custom_live_streaming_service\": true,\n \"custom_service_instructions\": \"specific instructions\",\n \"webinar_live_streaming\": {\n \"enable\": true,\n \"live_streaming_service\": [\n \"facebook\",\n \"workplace_by_facebook\",\n \"youtube\",\n \"custom_live_streaming_service\"\n ],\n \"custom_service_instructions\": \"specific instructions\",\n \"live_streaming_reminder\": true\n },\n \"webinar_chat\": {\n \"enable\": true,\n \"allow_panelists_chat_with\": 1,\n \"allow_attendees_chat_with\": 1,\n \"default_attendees_chat_with\": 1,\n \"allow_panelists_send_direct_message\": true,\n \"allow_users_save_chats\": 1,\n \"allow_auto_save_local_chat_file\": true\n },\n \"closed_captioning\": {\n \"enable\": true,\n \"third_party_captioning_service\": false,\n \"auto_transcribing\": true,\n \"view_full_transcript\": true,\n \"save_caption\": true\n },\n \"slide_control\": true,\n \"meeting_survey\": true,\n \"webinar_polling\": {\n \"enable\": true,\n \"advanced_polls\": true\n },\n \"webinar_survey\": true\n },\n \"email_notification\": {\n \"cloud_recording_available_reminder\": \"boolean\",\n \"recording_available_reminder_schedulers\": true,\n \"recording_available_reminder_alternative_hosts\": true,\n \"jbh_reminder\": \"boolean\",\n \"cancel_meeting_reminder\": \"boolean\",\n \"low_host_count_reminder\": \"boolean\",\n \"alternative_host_reminder\": \"boolean\",\n \"schedule_for_reminder\": \"boolean\"\n },\n \"zoom_rooms\": {\n \"upcoming_meeting_alert\": \"boolean\",\n \"start_airplay_manually\": \"boolean\",\n \"weekly_system_restart\": \"boolean\",\n \"list_meetings_with_calendar\": \"boolean\",\n \"zr_post_meeting_feedback\": \"boolean\",\n \"ultrasonic\": \"boolean\",\n \"force_private_meeting\": \"boolean\",\n \"hide_host_information\": \"boolean\",\n \"cmr_for_instant_meeting\": \"boolean\",\n \"auto_start_stop_scheduled_meetings\": \"boolean\"\n },\n \"security\": {\n \"admin_change_name_pic\": \"boolean\",\n \"import_photos_from_devices\": \"boolean\",\n \"hide_billing_info\": \"boolean\"\n },\n \"recording\": {\n \"local_recording\": \"boolean\",\n \"cloud_recording\": \"boolean\",\n \"record_speaker_view\": \"boolean\",\n \"record_gallery_view\": \"boolean\",\n \"record_audio_file\": \"boolean\",\n \"save_chat_text\": \"boolean\",\n \"show_timestamp\": \"boolean\",\n \"recording_audio_transcript\": \"boolean\",\n \"auto_recording\": \"string\",\n \"cloud_recording_download\": \"boolean\",\n \"cloud_recording_download_host\": \"boolean\",\n \"account_user_access_recording\": \"boolean\",\n \"auto_delete_cmr\": \"boolean\",\n \"auto_delete_cmr_days\": \"integer\"\n },\n \"telephony\": {\n \"third_party_audio\": \"boolean\",\n \"audio_conference_info\": \"string\"\n },\n \"tsp\": {\n \"call_out\": \"boolean\",\n \"call_out_countries\": [\n \"string\"\n ],\n \"show_international_numbers_link\": \"boolean\",\n \"display_toll_free_numbers\": \"boolean\"\n },\n \"integration\": {\n \"google_calendar\": \"boolean\",\n \"google_drive\": \"boolean\",\n \"dropbox\": \"boolean\",\n \"box\": \"boolean\",\n \"microsoft_one_drive\": \"boolean\",\n \"kubi\": \"boolean\"\n },\n \"feature\": {\n \"meeting_capacity\": \"integer\"\n },\n \"other_options\": {\n \"allow_auto_active_users\": true,\n \"blur_snapshot\": true,\n \"display_meetings_scheduled_for_others\": false,\n \"use_cdn\": \"default\",\n \"allow_users_contact_support_via_chat\": true,\n \"meeting_qos_and_mos\": 0,\n \"show_one_user_meeting_on_dashboard\": true,\n \"allow_users_enter_and_share_pronouns\": true\n },\n \"audio_conferencing\": {\n \"toll_free_and_fee_based_toll_call\": {\n \"enable\": true,\n \"numbers\": [\n {\n \"code\": \"1\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"number\": \"+1 5550100\",\n \"display_number\": \"+1 5550100(Atlanta)\"\n },\n {\n \"code\": \"1\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"number\": \"+1 5550101\",\n \"display_number\": \"+1 5550101(SanJose)\"\n }\n ],\n \"allow_webinar_attendees_dial\": true\n }\n }\n}"
},
{
"name": "**HTTP Status Code:** `404`<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/settings?option=meeting_security&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"accounts",
":accountId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_security"
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "accountId",
"value": "quis officia in reprehenderit",
"description": "(Required) The account's ID."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
