Powershell / Zoom API / Get settings
Back to Collection Items
Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = New-Object Chilkat.Http
$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("option","meeting_security")
$queryParams.UpdateString("custom_query_fields","quis officia in reprehenderit")
# Adds the "Authorization: Bearer <access_token>" header.
$http.AuthToken = "<access_token>"
$resp = $http.QuickRequestParams("GET","https://api.zoom.us/v2/accounts/:accountId/settings",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
$($http.LastErrorText)
exit
}
$sbResponseBody = New-Object Chilkat.StringBuilder
$resp.GetBodySb($sbResponseBody)
$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false
$("Response Body:")
$($jResp.Emit())
$respStatusCode = $resp.StatusCode
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
$("Response Header:")
$($resp.Header)
$("Failed.")
exit
}
# 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
$Host_video = $jResp.StringOf("schedule_meeting.host_video")
$Participant_video = $jResp.StringOf("schedule_meeting.participant_video")
$Audio_type = $jResp.StringOf("schedule_meeting.audio_type")
$Join_before_host = $jResp.StringOf("schedule_meeting.join_before_host")
$Use_pmi_for_scheduled_meetings = $jResp.StringOf("schedule_meeting.use_pmi_for_scheduled_meetings")
$Use_pmi_for_instant_meetings = $jResp.StringOf("schedule_meeting.use_pmi_for_instant_meetings")
$Enforce_login = $jResp.StringOf("schedule_meeting.enforce_login")
$Enforce_login_with_domains = $jResp.StringOf("schedule_meeting.enforce_login_with_domains")
$Enforce_login_domains = $jResp.StringOf("schedule_meeting.enforce_login_domains")
$Not_store_meeting_topic = $jResp.StringOf("schedule_meeting.not_store_meeting_topic")
$Force_pmi_jbh_password = $jResp.StringOf("schedule_meeting.force_pmi_jbh_password")
$Require_password_for_scheduling_new_meetings = $jResp.StringOf("schedule_meeting.require_password_for_scheduling_new_meetings")
$Require_password_for_scheduled_meetings = $jResp.StringOf("schedule_meeting.require_password_for_scheduled_meetings")
$Require_password_for_instant_meetings = $jResp.StringOf("schedule_meeting.require_password_for_instant_meetings")
$Require_password_for_pmi_meetings = $jResp.StringOf("schedule_meeting.require_password_for_pmi_meetings")
$E2e_encryption = $jResp.StringOf("in_meeting.e2e_encryption")
$Chat = $jResp.StringOf("in_meeting.chat")
$Allow_participants_chat_with = $jResp.IntOf("in_meeting.allow_participants_chat_with")
$Allow_users_save_chats = $jResp.IntOf("in_meeting.allow_users_save_chats")
$Private_chat = $jResp.StringOf("in_meeting.private_chat")
$Auto_saving_chat = $jResp.StringOf("in_meeting.auto_saving_chat")
$Entry_exit_chime = $jResp.StringOf("in_meeting.entry_exit_chime")
$Record_play_own_voice = $jResp.StringOf("in_meeting.record_play_own_voice")
$Feedback = $jResp.StringOf("in_meeting.feedback")
$Post_meeting_feedback = $jResp.StringOf("in_meeting.post_meeting_feedback")
$Co_host = $jResp.StringOf("in_meeting.co_host")
$Polling = $jResp.StringOf("in_meeting.polling")
$Attendee_on_hold = $jResp.StringOf("in_meeting.attendee_on_hold")
$Show_meeting_control_toolbar = $jResp.StringOf("in_meeting.show_meeting_control_toolbar")
$Allow_show_zoom_windows = $jResp.StringOf("in_meeting.allow_show_zoom_windows")
$Annotation = $jResp.StringOf("in_meeting.annotation")
$Whiteboard = $jResp.StringOf("in_meeting.whiteboard")
$Webinar_question_answer = $jResp.StringOf("in_meeting.webinar_question_answer")
$Anonymous_question_answer = $jResp.StringOf("in_meeting.anonymous_question_answer")
$Breakout_room = $jResp.StringOf("in_meeting.breakout_room")
$Breakout_room_schedule = $jResp.BoolOf("in_meeting.breakout_room_schedule")
$Closed_caption = $jResp.StringOf("in_meeting.closed_caption")
$Far_end_camera_control = $jResp.StringOf("in_meeting.far_end_camera_control")
$Group_hd = $jResp.StringOf("in_meeting.group_hd")
$Virtual_background = $jResp.StringOf("in_meeting.virtual_background")
$Watermark = $jResp.StringOf("in_meeting.watermark")
$Watermark_by_default = $jResp.StringOf("in_meeting.watermark_by_default")
$Audio_watermark_by_default = $jResp.StringOf("in_meeting.audio_watermark_by_default")
$Alert_guest_join = $jResp.StringOf("in_meeting.alert_guest_join")
$Auto_answer = $jResp.StringOf("in_meeting.auto_answer")
$P2p_connetion = $jResp.StringOf("in_meeting.p2p_connetion")
$P2p_ports = $jResp.StringOf("in_meeting.p2p_ports")
$Ports_range = $jResp.StringOf("in_meeting.ports_range")
$Sending_default_email_invites = $jResp.StringOf("in_meeting.sending_default_email_invites")
$Use_html_format_email = $jResp.StringOf("in_meeting.use_html_format_email")
$Dscp_marking = $jResp.StringOf("in_meeting.dscp_marking")
$Dscp_audio = $jResp.StringOf("in_meeting.dscp_audio")
$Dscp_video = $jResp.StringOf("in_meeting.dscp_video")
$Stereo_audio = $jResp.StringOf("in_meeting.stereo_audio")
$Original_audio = $jResp.StringOf("in_meeting.original_audio")
$Screen_sharing = $jResp.StringOf("in_meeting.screen_sharing")
$Remote_control = $jResp.StringOf("in_meeting.remote_control")
$Attention_mode_focus_mode = $jResp.BoolOf("in_meeting.attention_mode_focus_mode")
$Allow_host_to_enable_focus_mode = $jResp.BoolOf("in_meeting.allow_host_to_enable_focus_mode")
$Show_a_join_from_your_browser_link = $jResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
$Join_from_mobile = $jResp.BoolOf("in_meeting.join_from_mobile")
$Join_from_desktop = $jResp.BoolOf("in_meeting.join_from_desktop")
$Allow_live_streaming = $jResp.BoolOf("in_meeting.allow_live_streaming")
$Live_streaming_facebook = $jResp.BoolOf("in_meeting.live_streaming_facebook")
$Workplace_by_facebook = $jResp.BoolOf("in_meeting.workplace_by_facebook")
$Live_streaming_youtube = $jResp.BoolOf("in_meeting.live_streaming_youtube")
$Custom_live_streaming_service = $jResp.BoolOf("in_meeting.custom_live_streaming_service")
$Custom_service_instructions = $jResp.StringOf("in_meeting.custom_service_instructions")
$Enable = $jResp.BoolOf("in_meeting.webinar_live_streaming.enable")
$Webinar_live_streamingCustom_service_instructions = $jResp.StringOf("in_meeting.webinar_live_streaming.custom_service_instructions")
$Live_streaming_reminder = $jResp.BoolOf("in_meeting.webinar_live_streaming.live_streaming_reminder")
$Webinar_chatEnable = $jResp.BoolOf("in_meeting.webinar_chat.enable")
$Allow_panelists_chat_with = $jResp.IntOf("in_meeting.webinar_chat.allow_panelists_chat_with")
$Allow_attendees_chat_with = $jResp.IntOf("in_meeting.webinar_chat.allow_attendees_chat_with")
$Default_attendees_chat_with = $jResp.IntOf("in_meeting.webinar_chat.default_attendees_chat_with")
$Allow_panelists_send_direct_message = $jResp.BoolOf("in_meeting.webinar_chat.allow_panelists_send_direct_message")
$Webinar_chatAllow_users_save_chats = $jResp.IntOf("in_meeting.webinar_chat.allow_users_save_chats")
$Allow_auto_save_local_chat_file = $jResp.BoolOf("in_meeting.webinar_chat.allow_auto_save_local_chat_file")
$Closed_captioningEnable = $jResp.BoolOf("in_meeting.closed_captioning.enable")
$Third_party_captioning_service = $jResp.BoolOf("in_meeting.closed_captioning.third_party_captioning_service")
$Auto_transcribing = $jResp.BoolOf("in_meeting.closed_captioning.auto_transcribing")
$View_full_transcript = $jResp.BoolOf("in_meeting.closed_captioning.view_full_transcript")
$Save_caption = $jResp.BoolOf("in_meeting.closed_captioning.save_caption")
$Slide_control = $jResp.BoolOf("in_meeting.slide_control")
$Meeting_survey = $jResp.BoolOf("in_meeting.meeting_survey")
$Webinar_pollingEnable = $jResp.BoolOf("in_meeting.webinar_polling.enable")
$Advanced_polls = $jResp.BoolOf("in_meeting.webinar_polling.advanced_polls")
$Webinar_survey = $jResp.BoolOf("in_meeting.webinar_survey")
$Cloud_recording_available_reminder = $jResp.StringOf("email_notification.cloud_recording_available_reminder")
$Recording_available_reminder_schedulers = $jResp.BoolOf("email_notification.recording_available_reminder_schedulers")
$Recording_available_reminder_alternative_hosts = $jResp.BoolOf("email_notification.recording_available_reminder_alternative_hosts")
$Jbh_reminder = $jResp.StringOf("email_notification.jbh_reminder")
$Cancel_meeting_reminder = $jResp.StringOf("email_notification.cancel_meeting_reminder")
$Low_host_count_reminder = $jResp.StringOf("email_notification.low_host_count_reminder")
$Alternative_host_reminder = $jResp.StringOf("email_notification.alternative_host_reminder")
$Schedule_for_reminder = $jResp.StringOf("email_notification.schedule_for_reminder")
$Upcoming_meeting_alert = $jResp.StringOf("zoom_rooms.upcoming_meeting_alert")
$Start_airplay_manually = $jResp.StringOf("zoom_rooms.start_airplay_manually")
$Weekly_system_restart = $jResp.StringOf("zoom_rooms.weekly_system_restart")
$List_meetings_with_calendar = $jResp.StringOf("zoom_rooms.list_meetings_with_calendar")
$Zr_post_meeting_feedback = $jResp.StringOf("zoom_rooms.zr_post_meeting_feedback")
$Ultrasonic = $jResp.StringOf("zoom_rooms.ultrasonic")
$Force_private_meeting = $jResp.StringOf("zoom_rooms.force_private_meeting")
$Hide_host_information = $jResp.StringOf("zoom_rooms.hide_host_information")
$Cmr_for_instant_meeting = $jResp.StringOf("zoom_rooms.cmr_for_instant_meeting")
$Auto_start_stop_scheduled_meetings = $jResp.StringOf("zoom_rooms.auto_start_stop_scheduled_meetings")
$Admin_change_name_pic = $jResp.StringOf("security.admin_change_name_pic")
$Import_photos_from_devices = $jResp.StringOf("security.import_photos_from_devices")
$Hide_billing_info = $jResp.StringOf("security.hide_billing_info")
$Local_recording = $jResp.StringOf("recording.local_recording")
$Cloud_recording = $jResp.StringOf("recording.cloud_recording")
$Record_speaker_view = $jResp.StringOf("recording.record_speaker_view")
$Record_gallery_view = $jResp.StringOf("recording.record_gallery_view")
$Record_audio_file = $jResp.StringOf("recording.record_audio_file")
$Save_chat_text = $jResp.StringOf("recording.save_chat_text")
$Show_timestamp = $jResp.StringOf("recording.show_timestamp")
$Recording_audio_transcript = $jResp.StringOf("recording.recording_audio_transcript")
$Auto_recording = $jResp.StringOf("recording.auto_recording")
$Cloud_recording_download = $jResp.StringOf("recording.cloud_recording_download")
$Cloud_recording_download_host = $jResp.StringOf("recording.cloud_recording_download_host")
$Account_user_access_recording = $jResp.StringOf("recording.account_user_access_recording")
$Auto_delete_cmr = $jResp.StringOf("recording.auto_delete_cmr")
$Auto_delete_cmr_days = $jResp.StringOf("recording.auto_delete_cmr_days")
$Third_party_audio = $jResp.StringOf("telephony.third_party_audio")
$Audio_conference_info = $jResp.StringOf("telephony.audio_conference_info")
$Call_out = $jResp.StringOf("tsp.call_out")
$Show_international_numbers_link = $jResp.StringOf("tsp.show_international_numbers_link")
$Display_toll_free_numbers = $jResp.StringOf("tsp.display_toll_free_numbers")
$Google_calendar = $jResp.StringOf("integration.google_calendar")
$Google_drive = $jResp.StringOf("integration.google_drive")
$Dropbox = $jResp.StringOf("integration.dropbox")
$Box = $jResp.StringOf("integration.box")
$Microsoft_one_drive = $jResp.StringOf("integration.microsoft_one_drive")
$Kubi = $jResp.StringOf("integration.kubi")
$Meeting_capacity = $jResp.StringOf("feature.meeting_capacity")
$Allow_auto_active_users = $jResp.BoolOf("other_options.allow_auto_active_users")
$Blur_snapshot = $jResp.BoolOf("other_options.blur_snapshot")
$Display_meetings_scheduled_for_others = $jResp.BoolOf("other_options.display_meetings_scheduled_for_others")
$Use_cdn = $jResp.StringOf("other_options.use_cdn")
$Allow_users_contact_support_via_chat = $jResp.BoolOf("other_options.allow_users_contact_support_via_chat")
$Meeting_qos_and_mos = $jResp.IntOf("other_options.meeting_qos_and_mos")
$Show_one_user_meeting_on_dashboard = $jResp.BoolOf("other_options.show_one_user_meeting_on_dashboard")
$Allow_users_enter_and_share_pronouns = $jResp.BoolOf("other_options.allow_users_enter_and_share_pronouns")
$Toll_free_and_fee_based_toll_callEnable = $jResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.enable")
$Allow_webinar_attendees_dial = $jResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.allow_webinar_attendees_dial")
$i = 0
$count_i = $jResp.SizeOfArray("in_meeting.webinar_live_streaming.live_streaming_service")
while ($i -lt $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")
while ($i -lt $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")
while ($i -lt $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": ""
}
]
}
