PowerBuilder / Zoom API / Get 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
string ls_StrVal
string ls_Code
string ls_Country_code
string ls_Country_name
string ls_V_number
string ls_Display_number
string ls_Host_video
string ls_Participant_video
string ls_Audio_type
string ls_Join_before_host
string ls_Use_pmi_for_scheduled_meetings
string ls_Use_pmi_for_instant_meetings
string ls_Enforce_login
string ls_Enforce_login_with_domains
string ls_Enforce_login_domains
string ls_Not_store_meeting_topic
string ls_Force_pmi_jbh_password
string ls_Require_password_for_scheduling_new_meetings
string ls_Require_password_for_scheduled_meetings
string ls_Require_password_for_instant_meetings
string ls_Require_password_for_pmi_meetings
string ls_E2e_encryption
string ls_Chat
integer li_Allow_participants_chat_with
integer li_Allow_users_save_chats
string ls_Private_chat
string ls_Auto_saving_chat
string ls_Entry_exit_chime
string ls_Record_play_own_voice
string ls_Feedback
string ls_Post_meeting_feedback
string ls_Co_host
string ls_Polling
string ls_Attendee_on_hold
string ls_Show_meeting_control_toolbar
string ls_Allow_show_zoom_windows
string ls_Annotation
string ls_Whiteboard
string ls_Webinar_question_answer
string ls_Anonymous_question_answer
string ls_Breakout_room
integer li_Breakout_room_schedule
string ls_Closed_caption
string ls_Far_end_camera_control
string ls_Group_hd
string ls_Virtual_background
string ls_Watermark
string ls_Watermark_by_default
string ls_Audio_watermark_by_default
string ls_Alert_guest_join
string ls_Auto_answer
string ls_P2p_connetion
string ls_P2p_ports
string ls_Ports_range
string ls_Sending_default_email_invites
string ls_Use_html_format_email
string ls_Dscp_marking
string ls_Dscp_audio
string ls_Dscp_video
string ls_Stereo_audio
string ls_Original_audio
string ls_Screen_sharing
string ls_Remote_control
integer li_Attention_mode_focus_mode
integer li_Allow_host_to_enable_focus_mode
integer li_Show_a_join_from_your_browser_link
integer li_Join_from_mobile
integer li_Join_from_desktop
integer li_Allow_live_streaming
integer li_Live_streaming_facebook
integer li_Workplace_by_facebook
integer li_Live_streaming_youtube
integer li_Custom_live_streaming_service
string ls_Custom_service_instructions
integer li_Enable
string ls_Webinar_live_streamingCustom_service_instructions
integer li_Live_streaming_reminder
integer li_Webinar_chatEnable
integer li_Allow_panelists_chat_with
integer li_Allow_attendees_chat_with
integer li_Default_attendees_chat_with
integer li_Allow_panelists_send_direct_message
integer li_Webinar_chatAllow_users_save_chats
integer li_Allow_auto_save_local_chat_file
integer li_Closed_captioningEnable
integer li_Third_party_captioning_service
integer li_Auto_transcribing
integer li_View_full_transcript
integer li_Save_caption
integer li_Slide_control
integer li_Meeting_survey
integer li_Webinar_pollingEnable
integer li_Advanced_polls
integer li_Webinar_survey
string ls_Cloud_recording_available_reminder
integer li_Recording_available_reminder_schedulers
integer li_Recording_available_reminder_alternative_hosts
string ls_Jbh_reminder
string ls_Cancel_meeting_reminder
string ls_Low_host_count_reminder
string ls_Alternative_host_reminder
string ls_Schedule_for_reminder
string ls_Upcoming_meeting_alert
string ls_Start_airplay_manually
string ls_Weekly_system_restart
string ls_List_meetings_with_calendar
string ls_Zr_post_meeting_feedback
string ls_Ultrasonic
string ls_Force_private_meeting
string ls_Hide_host_information
string ls_Cmr_for_instant_meeting
string ls_Auto_start_stop_scheduled_meetings
string ls_Admin_change_name_pic
string ls_Import_photos_from_devices
string ls_Hide_billing_info
string ls_Local_recording
string ls_Cloud_recording
string ls_Record_speaker_view
string ls_Record_gallery_view
string ls_Record_audio_file
string ls_Save_chat_text
string ls_Show_timestamp
string ls_Recording_audio_transcript
string ls_Auto_recording
string ls_Cloud_recording_download
string ls_Cloud_recording_download_host
string ls_Account_user_access_recording
string ls_Auto_delete_cmr
string ls_Auto_delete_cmr_days
string ls_Third_party_audio
string ls_Audio_conference_info
string ls_Call_out
string ls_Show_international_numbers_link
string ls_Display_toll_free_numbers
string ls_Google_calendar
string ls_Google_drive
string ls_Dropbox
string ls_Box
string ls_Microsoft_one_drive
string ls_Kubi
string ls_Meeting_capacity
integer li_Allow_auto_active_users
integer li_Blur_snapshot
integer li_Display_meetings_scheduled_for_others
string ls_Use_cdn
integer li_Allow_users_contact_support_via_chat
integer li_Meeting_qos_and_mos
integer li_Show_one_user_meeting_on_dashboard
integer li_Allow_users_enter_and_share_pronouns
integer li_Toll_free_and_fee_based_toll_callEnable
integer li_Allow_webinar_attendees_dial
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateString("option","meeting_security")
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/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
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.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": "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
ls_Host_video = loo_JResp.StringOf("schedule_meeting.host_video")
ls_Participant_video = loo_JResp.StringOf("schedule_meeting.participant_video")
ls_Audio_type = loo_JResp.StringOf("schedule_meeting.audio_type")
ls_Join_before_host = loo_JResp.StringOf("schedule_meeting.join_before_host")
ls_Use_pmi_for_scheduled_meetings = loo_JResp.StringOf("schedule_meeting.use_pmi_for_scheduled_meetings")
ls_Use_pmi_for_instant_meetings = loo_JResp.StringOf("schedule_meeting.use_pmi_for_instant_meetings")
ls_Enforce_login = loo_JResp.StringOf("schedule_meeting.enforce_login")
ls_Enforce_login_with_domains = loo_JResp.StringOf("schedule_meeting.enforce_login_with_domains")
ls_Enforce_login_domains = loo_JResp.StringOf("schedule_meeting.enforce_login_domains")
ls_Not_store_meeting_topic = loo_JResp.StringOf("schedule_meeting.not_store_meeting_topic")
ls_Force_pmi_jbh_password = loo_JResp.StringOf("schedule_meeting.force_pmi_jbh_password")
ls_Require_password_for_scheduling_new_meetings = loo_JResp.StringOf("schedule_meeting.require_password_for_scheduling_new_meetings")
ls_Require_password_for_scheduled_meetings = loo_JResp.StringOf("schedule_meeting.require_password_for_scheduled_meetings")
ls_Require_password_for_instant_meetings = loo_JResp.StringOf("schedule_meeting.require_password_for_instant_meetings")
ls_Require_password_for_pmi_meetings = loo_JResp.StringOf("schedule_meeting.require_password_for_pmi_meetings")
ls_E2e_encryption = loo_JResp.StringOf("in_meeting.e2e_encryption")
ls_Chat = loo_JResp.StringOf("in_meeting.chat")
li_Allow_participants_chat_with = loo_JResp.IntOf("in_meeting.allow_participants_chat_with")
li_Allow_users_save_chats = loo_JResp.IntOf("in_meeting.allow_users_save_chats")
ls_Private_chat = loo_JResp.StringOf("in_meeting.private_chat")
ls_Auto_saving_chat = loo_JResp.StringOf("in_meeting.auto_saving_chat")
ls_Entry_exit_chime = loo_JResp.StringOf("in_meeting.entry_exit_chime")
ls_Record_play_own_voice = loo_JResp.StringOf("in_meeting.record_play_own_voice")
ls_Feedback = loo_JResp.StringOf("in_meeting.feedback")
ls_Post_meeting_feedback = loo_JResp.StringOf("in_meeting.post_meeting_feedback")
ls_Co_host = loo_JResp.StringOf("in_meeting.co_host")
ls_Polling = loo_JResp.StringOf("in_meeting.polling")
ls_Attendee_on_hold = loo_JResp.StringOf("in_meeting.attendee_on_hold")
ls_Show_meeting_control_toolbar = loo_JResp.StringOf("in_meeting.show_meeting_control_toolbar")
ls_Allow_show_zoom_windows = loo_JResp.StringOf("in_meeting.allow_show_zoom_windows")
ls_Annotation = loo_JResp.StringOf("in_meeting.annotation")
ls_Whiteboard = loo_JResp.StringOf("in_meeting.whiteboard")
ls_Webinar_question_answer = loo_JResp.StringOf("in_meeting.webinar_question_answer")
ls_Anonymous_question_answer = loo_JResp.StringOf("in_meeting.anonymous_question_answer")
ls_Breakout_room = loo_JResp.StringOf("in_meeting.breakout_room")
li_Breakout_room_schedule = loo_JResp.BoolOf("in_meeting.breakout_room_schedule")
ls_Closed_caption = loo_JResp.StringOf("in_meeting.closed_caption")
ls_Far_end_camera_control = loo_JResp.StringOf("in_meeting.far_end_camera_control")
ls_Group_hd = loo_JResp.StringOf("in_meeting.group_hd")
ls_Virtual_background = loo_JResp.StringOf("in_meeting.virtual_background")
ls_Watermark = loo_JResp.StringOf("in_meeting.watermark")
ls_Watermark_by_default = loo_JResp.StringOf("in_meeting.watermark_by_default")
ls_Audio_watermark_by_default = loo_JResp.StringOf("in_meeting.audio_watermark_by_default")
ls_Alert_guest_join = loo_JResp.StringOf("in_meeting.alert_guest_join")
ls_Auto_answer = loo_JResp.StringOf("in_meeting.auto_answer")
ls_P2p_connetion = loo_JResp.StringOf("in_meeting.p2p_connetion")
ls_P2p_ports = loo_JResp.StringOf("in_meeting.p2p_ports")
ls_Ports_range = loo_JResp.StringOf("in_meeting.ports_range")
ls_Sending_default_email_invites = loo_JResp.StringOf("in_meeting.sending_default_email_invites")
ls_Use_html_format_email = loo_JResp.StringOf("in_meeting.use_html_format_email")
ls_Dscp_marking = loo_JResp.StringOf("in_meeting.dscp_marking")
ls_Dscp_audio = loo_JResp.StringOf("in_meeting.dscp_audio")
ls_Dscp_video = loo_JResp.StringOf("in_meeting.dscp_video")
ls_Stereo_audio = loo_JResp.StringOf("in_meeting.stereo_audio")
ls_Original_audio = loo_JResp.StringOf("in_meeting.original_audio")
ls_Screen_sharing = loo_JResp.StringOf("in_meeting.screen_sharing")
ls_Remote_control = loo_JResp.StringOf("in_meeting.remote_control")
li_Attention_mode_focus_mode = loo_JResp.BoolOf("in_meeting.attention_mode_focus_mode")
li_Allow_host_to_enable_focus_mode = loo_JResp.BoolOf("in_meeting.allow_host_to_enable_focus_mode")
li_Show_a_join_from_your_browser_link = loo_JResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
li_Join_from_mobile = loo_JResp.BoolOf("in_meeting.join_from_mobile")
li_Join_from_desktop = loo_JResp.BoolOf("in_meeting.join_from_desktop")
li_Allow_live_streaming = loo_JResp.BoolOf("in_meeting.allow_live_streaming")
li_Live_streaming_facebook = loo_JResp.BoolOf("in_meeting.live_streaming_facebook")
li_Workplace_by_facebook = loo_JResp.BoolOf("in_meeting.workplace_by_facebook")
li_Live_streaming_youtube = loo_JResp.BoolOf("in_meeting.live_streaming_youtube")
li_Custom_live_streaming_service = loo_JResp.BoolOf("in_meeting.custom_live_streaming_service")
ls_Custom_service_instructions = loo_JResp.StringOf("in_meeting.custom_service_instructions")
li_Enable = loo_JResp.BoolOf("in_meeting.webinar_live_streaming.enable")
ls_Webinar_live_streamingCustom_service_instructions = loo_JResp.StringOf("in_meeting.webinar_live_streaming.custom_service_instructions")
li_Live_streaming_reminder = loo_JResp.BoolOf("in_meeting.webinar_live_streaming.live_streaming_reminder")
li_Webinar_chatEnable = loo_JResp.BoolOf("in_meeting.webinar_chat.enable")
li_Allow_panelists_chat_with = loo_JResp.IntOf("in_meeting.webinar_chat.allow_panelists_chat_with")
li_Allow_attendees_chat_with = loo_JResp.IntOf("in_meeting.webinar_chat.allow_attendees_chat_with")
li_Default_attendees_chat_with = loo_JResp.IntOf("in_meeting.webinar_chat.default_attendees_chat_with")
li_Allow_panelists_send_direct_message = loo_JResp.BoolOf("in_meeting.webinar_chat.allow_panelists_send_direct_message")
li_Webinar_chatAllow_users_save_chats = loo_JResp.IntOf("in_meeting.webinar_chat.allow_users_save_chats")
li_Allow_auto_save_local_chat_file = loo_JResp.BoolOf("in_meeting.webinar_chat.allow_auto_save_local_chat_file")
li_Closed_captioningEnable = loo_JResp.BoolOf("in_meeting.closed_captioning.enable")
li_Third_party_captioning_service = loo_JResp.BoolOf("in_meeting.closed_captioning.third_party_captioning_service")
li_Auto_transcribing = loo_JResp.BoolOf("in_meeting.closed_captioning.auto_transcribing")
li_View_full_transcript = loo_JResp.BoolOf("in_meeting.closed_captioning.view_full_transcript")
li_Save_caption = loo_JResp.BoolOf("in_meeting.closed_captioning.save_caption")
li_Slide_control = loo_JResp.BoolOf("in_meeting.slide_control")
li_Meeting_survey = loo_JResp.BoolOf("in_meeting.meeting_survey")
li_Webinar_pollingEnable = loo_JResp.BoolOf("in_meeting.webinar_polling.enable")
li_Advanced_polls = loo_JResp.BoolOf("in_meeting.webinar_polling.advanced_polls")
li_Webinar_survey = loo_JResp.BoolOf("in_meeting.webinar_survey")
ls_Cloud_recording_available_reminder = loo_JResp.StringOf("email_notification.cloud_recording_available_reminder")
li_Recording_available_reminder_schedulers = loo_JResp.BoolOf("email_notification.recording_available_reminder_schedulers")
li_Recording_available_reminder_alternative_hosts = loo_JResp.BoolOf("email_notification.recording_available_reminder_alternative_hosts")
ls_Jbh_reminder = loo_JResp.StringOf("email_notification.jbh_reminder")
ls_Cancel_meeting_reminder = loo_JResp.StringOf("email_notification.cancel_meeting_reminder")
ls_Low_host_count_reminder = loo_JResp.StringOf("email_notification.low_host_count_reminder")
ls_Alternative_host_reminder = loo_JResp.StringOf("email_notification.alternative_host_reminder")
ls_Schedule_for_reminder = loo_JResp.StringOf("email_notification.schedule_for_reminder")
ls_Upcoming_meeting_alert = loo_JResp.StringOf("zoom_rooms.upcoming_meeting_alert")
ls_Start_airplay_manually = loo_JResp.StringOf("zoom_rooms.start_airplay_manually")
ls_Weekly_system_restart = loo_JResp.StringOf("zoom_rooms.weekly_system_restart")
ls_List_meetings_with_calendar = loo_JResp.StringOf("zoom_rooms.list_meetings_with_calendar")
ls_Zr_post_meeting_feedback = loo_JResp.StringOf("zoom_rooms.zr_post_meeting_feedback")
ls_Ultrasonic = loo_JResp.StringOf("zoom_rooms.ultrasonic")
ls_Force_private_meeting = loo_JResp.StringOf("zoom_rooms.force_private_meeting")
ls_Hide_host_information = loo_JResp.StringOf("zoom_rooms.hide_host_information")
ls_Cmr_for_instant_meeting = loo_JResp.StringOf("zoom_rooms.cmr_for_instant_meeting")
ls_Auto_start_stop_scheduled_meetings = loo_JResp.StringOf("zoom_rooms.auto_start_stop_scheduled_meetings")
ls_Admin_change_name_pic = loo_JResp.StringOf("security.admin_change_name_pic")
ls_Import_photos_from_devices = loo_JResp.StringOf("security.import_photos_from_devices")
ls_Hide_billing_info = loo_JResp.StringOf("security.hide_billing_info")
ls_Local_recording = loo_JResp.StringOf("recording.local_recording")
ls_Cloud_recording = loo_JResp.StringOf("recording.cloud_recording")
ls_Record_speaker_view = loo_JResp.StringOf("recording.record_speaker_view")
ls_Record_gallery_view = loo_JResp.StringOf("recording.record_gallery_view")
ls_Record_audio_file = loo_JResp.StringOf("recording.record_audio_file")
ls_Save_chat_text = loo_JResp.StringOf("recording.save_chat_text")
ls_Show_timestamp = loo_JResp.StringOf("recording.show_timestamp")
ls_Recording_audio_transcript = loo_JResp.StringOf("recording.recording_audio_transcript")
ls_Auto_recording = loo_JResp.StringOf("recording.auto_recording")
ls_Cloud_recording_download = loo_JResp.StringOf("recording.cloud_recording_download")
ls_Cloud_recording_download_host = loo_JResp.StringOf("recording.cloud_recording_download_host")
ls_Account_user_access_recording = loo_JResp.StringOf("recording.account_user_access_recording")
ls_Auto_delete_cmr = loo_JResp.StringOf("recording.auto_delete_cmr")
ls_Auto_delete_cmr_days = loo_JResp.StringOf("recording.auto_delete_cmr_days")
ls_Third_party_audio = loo_JResp.StringOf("telephony.third_party_audio")
ls_Audio_conference_info = loo_JResp.StringOf("telephony.audio_conference_info")
ls_Call_out = loo_JResp.StringOf("tsp.call_out")
ls_Show_international_numbers_link = loo_JResp.StringOf("tsp.show_international_numbers_link")
ls_Display_toll_free_numbers = loo_JResp.StringOf("tsp.display_toll_free_numbers")
ls_Google_calendar = loo_JResp.StringOf("integration.google_calendar")
ls_Google_drive = loo_JResp.StringOf("integration.google_drive")
ls_Dropbox = loo_JResp.StringOf("integration.dropbox")
ls_Box = loo_JResp.StringOf("integration.box")
ls_Microsoft_one_drive = loo_JResp.StringOf("integration.microsoft_one_drive")
ls_Kubi = loo_JResp.StringOf("integration.kubi")
ls_Meeting_capacity = loo_JResp.StringOf("feature.meeting_capacity")
li_Allow_auto_active_users = loo_JResp.BoolOf("other_options.allow_auto_active_users")
li_Blur_snapshot = loo_JResp.BoolOf("other_options.blur_snapshot")
li_Display_meetings_scheduled_for_others = loo_JResp.BoolOf("other_options.display_meetings_scheduled_for_others")
ls_Use_cdn = loo_JResp.StringOf("other_options.use_cdn")
li_Allow_users_contact_support_via_chat = loo_JResp.BoolOf("other_options.allow_users_contact_support_via_chat")
li_Meeting_qos_and_mos = loo_JResp.IntOf("other_options.meeting_qos_and_mos")
li_Show_one_user_meeting_on_dashboard = loo_JResp.BoolOf("other_options.show_one_user_meeting_on_dashboard")
li_Allow_users_enter_and_share_pronouns = loo_JResp.BoolOf("other_options.allow_users_enter_and_share_pronouns")
li_Toll_free_and_fee_based_toll_callEnable = loo_JResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.enable")
li_Allow_webinar_attendees_dial = loo_JResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.allow_webinar_attendees_dial")
i = 0
li_Count_i = loo_JResp.SizeOfArray("in_meeting.webinar_live_streaming.live_streaming_service")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("in_meeting.webinar_live_streaming.live_streaming_service[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("tsp.call_out_countries")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("tsp.call_out_countries[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("audio_conferencing.toll_free_and_fee_based_toll_call.numbers")
do while i < li_Count_i
loo_JResp.I = i
ls_Code = loo_JResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].code")
ls_Country_code = loo_JResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_code")
ls_Country_name = loo_JResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_name")
ls_V_number = loo_JResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].number")
ls_Display_number = loo_JResp.StringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].display_number")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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": ""
}
]
}
