DataFlex / Zoom API / Get settings
Back to Collection Items
Use ChilkatAx-9.5.0-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sStrVal
String sCode
String sCountry_code
String sCountry_name
String sV_number
String sDisplay_number
String sHost_video
String sParticipant_video
String sAudio_type
String sJoin_before_host
String sUse_pmi_for_scheduled_meetings
String sUse_pmi_for_instant_meetings
String sEnforce_login
String sEnforce_login_with_domains
String sEnforce_login_domains
String sNot_store_meeting_topic
String sForce_pmi_jbh_password
String sRequire_password_for_scheduling_new_meetings
String sRequire_password_for_scheduled_meetings
String sRequire_password_for_instant_meetings
String sRequire_password_for_pmi_meetings
String sE2e_encryption
String sChat
Integer iAllow_participants_chat_with
Integer iAllow_users_save_chats
String sPrivate_chat
String sAuto_saving_chat
String sEntry_exit_chime
String sRecord_play_own_voice
String sFeedback
String sPost_meeting_feedback
String sCo_host
String sPolling
String sAttendee_on_hold
String sShow_meeting_control_toolbar
String sAllow_show_zoom_windows
String sAnnotation
String sWhiteboard
String sWebinar_question_answer
String sAnonymous_question_answer
String sBreakout_room
Boolean iBreakout_room_schedule
String sClosed_caption
String sFar_end_camera_control
String sGroup_hd
String sVirtual_background
String sWatermark
String sWatermark_by_default
String sAudio_watermark_by_default
String sAlert_guest_join
String sAuto_answer
String sP2p_connetion
String sP2p_ports
String sPorts_range
String sSending_default_email_invites
String sUse_html_format_email
String sDscp_marking
String sDscp_audio
String sDscp_video
String sStereo_audio
String sOriginal_audio
String sScreen_sharing
String sRemote_control
Boolean iAttention_mode_focus_mode
Boolean iAllow_host_to_enable_focus_mode
Boolean iShow_a_join_from_your_browser_link
Boolean iJoin_from_mobile
Boolean iJoin_from_desktop
Boolean iAllow_live_streaming
Boolean iLive_streaming_facebook
Boolean iWorkplace_by_facebook
Boolean iLive_streaming_youtube
Boolean iCustom_live_streaming_service
String sCustom_service_instructions
Boolean iEnable
String sWebinar_live_streamingCustom_service_instructions
Boolean iLive_streaming_reminder
Boolean iWebinar_chatEnable
Integer iAllow_panelists_chat_with
Integer iAllow_attendees_chat_with
Integer iDefault_attendees_chat_with
Boolean iAllow_panelists_send_direct_message
Integer iWebinar_chatAllow_users_save_chats
Boolean iAllow_auto_save_local_chat_file
Boolean iClosed_captioningEnable
Boolean iThird_party_captioning_service
Boolean iAuto_transcribing
Boolean iView_full_transcript
Boolean iSave_caption
Boolean iSlide_control
Boolean iMeeting_survey
Boolean iWebinar_pollingEnable
Boolean iAdvanced_polls
Boolean iWebinar_survey
String sCloud_recording_available_reminder
Boolean iRecording_available_reminder_schedulers
Boolean iRecording_available_reminder_alternative_hosts
String sJbh_reminder
String sCancel_meeting_reminder
String sLow_host_count_reminder
String sAlternative_host_reminder
String sSchedule_for_reminder
String sUpcoming_meeting_alert
String sStart_airplay_manually
String sWeekly_system_restart
String sList_meetings_with_calendar
String sZr_post_meeting_feedback
String sUltrasonic
String sForce_private_meeting
String sHide_host_information
String sCmr_for_instant_meeting
String sAuto_start_stop_scheduled_meetings
String sAdmin_change_name_pic
String sImport_photos_from_devices
String sHide_billing_info
String sLocal_recording
String sCloud_recording
String sRecord_speaker_view
String sRecord_gallery_view
String sRecord_audio_file
String sSave_chat_text
String sShow_timestamp
String sRecording_audio_transcript
String sAuto_recording
String sCloud_recording_download
String sCloud_recording_download_host
String sAccount_user_access_recording
String sAuto_delete_cmr
String sAuto_delete_cmr_days
String sThird_party_audio
String sAudio_conference_info
String sCall_out
String sShow_international_numbers_link
String sDisplay_toll_free_numbers
String sGoogle_calendar
String sGoogle_drive
String sDropbox
String sBox
String sMicrosoft_one_drive
String sKubi
String sMeeting_capacity
Boolean iAllow_auto_active_users
Boolean iBlur_snapshot
Boolean iDisplay_meetings_scheduled_for_others
String sUse_cdn
Boolean iAllow_users_contact_support_via_chat
Integer iMeeting_qos_and_mos
Boolean iShow_one_user_meeting_on_dashboard
Boolean iAllow_users_enter_and_share_pronouns
Boolean iToll_free_and_fee_based_toll_callEnable
Boolean iAllow_webinar_attendees_dial
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateString Of hoQueryParams "option" "meeting_security" To iSuccess
Get ComUpdateString Of hoQueryParams "custom_query_fields" "quis officia in reprehenderit" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/accounts/:accountId/settings" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// 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
Get ComStringOf Of hoJResp "schedule_meeting.host_video" To sHost_video
Get ComStringOf Of hoJResp "schedule_meeting.participant_video" To sParticipant_video
Get ComStringOf Of hoJResp "schedule_meeting.audio_type" To sAudio_type
Get ComStringOf Of hoJResp "schedule_meeting.join_before_host" To sJoin_before_host
Get ComStringOf Of hoJResp "schedule_meeting.use_pmi_for_scheduled_meetings" To sUse_pmi_for_scheduled_meetings
Get ComStringOf Of hoJResp "schedule_meeting.use_pmi_for_instant_meetings" To sUse_pmi_for_instant_meetings
Get ComStringOf Of hoJResp "schedule_meeting.enforce_login" To sEnforce_login
Get ComStringOf Of hoJResp "schedule_meeting.enforce_login_with_domains" To sEnforce_login_with_domains
Get ComStringOf Of hoJResp "schedule_meeting.enforce_login_domains" To sEnforce_login_domains
Get ComStringOf Of hoJResp "schedule_meeting.not_store_meeting_topic" To sNot_store_meeting_topic
Get ComStringOf Of hoJResp "schedule_meeting.force_pmi_jbh_password" To sForce_pmi_jbh_password
Get ComStringOf Of hoJResp "schedule_meeting.require_password_for_scheduling_new_meetings" To sRequire_password_for_scheduling_new_meetings
Get ComStringOf Of hoJResp "schedule_meeting.require_password_for_scheduled_meetings" To sRequire_password_for_scheduled_meetings
Get ComStringOf Of hoJResp "schedule_meeting.require_password_for_instant_meetings" To sRequire_password_for_instant_meetings
Get ComStringOf Of hoJResp "schedule_meeting.require_password_for_pmi_meetings" To sRequire_password_for_pmi_meetings
Get ComStringOf Of hoJResp "in_meeting.e2e_encryption" To sE2e_encryption
Get ComStringOf Of hoJResp "in_meeting.chat" To sChat
Get ComIntOf Of hoJResp "in_meeting.allow_participants_chat_with" To iAllow_participants_chat_with
Get ComIntOf Of hoJResp "in_meeting.allow_users_save_chats" To iAllow_users_save_chats
Get ComStringOf Of hoJResp "in_meeting.private_chat" To sPrivate_chat
Get ComStringOf Of hoJResp "in_meeting.auto_saving_chat" To sAuto_saving_chat
Get ComStringOf Of hoJResp "in_meeting.entry_exit_chime" To sEntry_exit_chime
Get ComStringOf Of hoJResp "in_meeting.record_play_own_voice" To sRecord_play_own_voice
Get ComStringOf Of hoJResp "in_meeting.feedback" To sFeedback
Get ComStringOf Of hoJResp "in_meeting.post_meeting_feedback" To sPost_meeting_feedback
Get ComStringOf Of hoJResp "in_meeting.co_host" To sCo_host
Get ComStringOf Of hoJResp "in_meeting.polling" To sPolling
Get ComStringOf Of hoJResp "in_meeting.attendee_on_hold" To sAttendee_on_hold
Get ComStringOf Of hoJResp "in_meeting.show_meeting_control_toolbar" To sShow_meeting_control_toolbar
Get ComStringOf Of hoJResp "in_meeting.allow_show_zoom_windows" To sAllow_show_zoom_windows
Get ComStringOf Of hoJResp "in_meeting.annotation" To sAnnotation
Get ComStringOf Of hoJResp "in_meeting.whiteboard" To sWhiteboard
Get ComStringOf Of hoJResp "in_meeting.webinar_question_answer" To sWebinar_question_answer
Get ComStringOf Of hoJResp "in_meeting.anonymous_question_answer" To sAnonymous_question_answer
Get ComStringOf Of hoJResp "in_meeting.breakout_room" To sBreakout_room
Get ComBoolOf Of hoJResp "in_meeting.breakout_room_schedule" To iBreakout_room_schedule
Get ComStringOf Of hoJResp "in_meeting.closed_caption" To sClosed_caption
Get ComStringOf Of hoJResp "in_meeting.far_end_camera_control" To sFar_end_camera_control
Get ComStringOf Of hoJResp "in_meeting.group_hd" To sGroup_hd
Get ComStringOf Of hoJResp "in_meeting.virtual_background" To sVirtual_background
Get ComStringOf Of hoJResp "in_meeting.watermark" To sWatermark
Get ComStringOf Of hoJResp "in_meeting.watermark_by_default" To sWatermark_by_default
Get ComStringOf Of hoJResp "in_meeting.audio_watermark_by_default" To sAudio_watermark_by_default
Get ComStringOf Of hoJResp "in_meeting.alert_guest_join" To sAlert_guest_join
Get ComStringOf Of hoJResp "in_meeting.auto_answer" To sAuto_answer
Get ComStringOf Of hoJResp "in_meeting.p2p_connetion" To sP2p_connetion
Get ComStringOf Of hoJResp "in_meeting.p2p_ports" To sP2p_ports
Get ComStringOf Of hoJResp "in_meeting.ports_range" To sPorts_range
Get ComStringOf Of hoJResp "in_meeting.sending_default_email_invites" To sSending_default_email_invites
Get ComStringOf Of hoJResp "in_meeting.use_html_format_email" To sUse_html_format_email
Get ComStringOf Of hoJResp "in_meeting.dscp_marking" To sDscp_marking
Get ComStringOf Of hoJResp "in_meeting.dscp_audio" To sDscp_audio
Get ComStringOf Of hoJResp "in_meeting.dscp_video" To sDscp_video
Get ComStringOf Of hoJResp "in_meeting.stereo_audio" To sStereo_audio
Get ComStringOf Of hoJResp "in_meeting.original_audio" To sOriginal_audio
Get ComStringOf Of hoJResp "in_meeting.screen_sharing" To sScreen_sharing
Get ComStringOf Of hoJResp "in_meeting.remote_control" To sRemote_control
Get ComBoolOf Of hoJResp "in_meeting.attention_mode_focus_mode" To iAttention_mode_focus_mode
Get ComBoolOf Of hoJResp "in_meeting.allow_host_to_enable_focus_mode" To iAllow_host_to_enable_focus_mode
Get ComBoolOf Of hoJResp "in_meeting.show_a_join_from_your_browser_link" To iShow_a_join_from_your_browser_link
Get ComBoolOf Of hoJResp "in_meeting.join_from_mobile" To iJoin_from_mobile
Get ComBoolOf Of hoJResp "in_meeting.join_from_desktop" To iJoin_from_desktop
Get ComBoolOf Of hoJResp "in_meeting.allow_live_streaming" To iAllow_live_streaming
Get ComBoolOf Of hoJResp "in_meeting.live_streaming_facebook" To iLive_streaming_facebook
Get ComBoolOf Of hoJResp "in_meeting.workplace_by_facebook" To iWorkplace_by_facebook
Get ComBoolOf Of hoJResp "in_meeting.live_streaming_youtube" To iLive_streaming_youtube
Get ComBoolOf Of hoJResp "in_meeting.custom_live_streaming_service" To iCustom_live_streaming_service
Get ComStringOf Of hoJResp "in_meeting.custom_service_instructions" To sCustom_service_instructions
Get ComBoolOf Of hoJResp "in_meeting.webinar_live_streaming.enable" To iEnable
Get ComStringOf Of hoJResp "in_meeting.webinar_live_streaming.custom_service_instructions" To sWebinar_live_streamingCustom_service_instructions
Get ComBoolOf Of hoJResp "in_meeting.webinar_live_streaming.live_streaming_reminder" To iLive_streaming_reminder
Get ComBoolOf Of hoJResp "in_meeting.webinar_chat.enable" To iWebinar_chatEnable
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.allow_panelists_chat_with" To iAllow_panelists_chat_with
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.allow_attendees_chat_with" To iAllow_attendees_chat_with
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.default_attendees_chat_with" To iDefault_attendees_chat_with
Get ComBoolOf Of hoJResp "in_meeting.webinar_chat.allow_panelists_send_direct_message" To iAllow_panelists_send_direct_message
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.allow_users_save_chats" To iWebinar_chatAllow_users_save_chats
Get ComBoolOf Of hoJResp "in_meeting.webinar_chat.allow_auto_save_local_chat_file" To iAllow_auto_save_local_chat_file
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.enable" To iClosed_captioningEnable
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.third_party_captioning_service" To iThird_party_captioning_service
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.auto_transcribing" To iAuto_transcribing
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.view_full_transcript" To iView_full_transcript
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.save_caption" To iSave_caption
Get ComBoolOf Of hoJResp "in_meeting.slide_control" To iSlide_control
Get ComBoolOf Of hoJResp "in_meeting.meeting_survey" To iMeeting_survey
Get ComBoolOf Of hoJResp "in_meeting.webinar_polling.enable" To iWebinar_pollingEnable
Get ComBoolOf Of hoJResp "in_meeting.webinar_polling.advanced_polls" To iAdvanced_polls
Get ComBoolOf Of hoJResp "in_meeting.webinar_survey" To iWebinar_survey
Get ComStringOf Of hoJResp "email_notification.cloud_recording_available_reminder" To sCloud_recording_available_reminder
Get ComBoolOf Of hoJResp "email_notification.recording_available_reminder_schedulers" To iRecording_available_reminder_schedulers
Get ComBoolOf Of hoJResp "email_notification.recording_available_reminder_alternative_hosts" To iRecording_available_reminder_alternative_hosts
Get ComStringOf Of hoJResp "email_notification.jbh_reminder" To sJbh_reminder
Get ComStringOf Of hoJResp "email_notification.cancel_meeting_reminder" To sCancel_meeting_reminder
Get ComStringOf Of hoJResp "email_notification.low_host_count_reminder" To sLow_host_count_reminder
Get ComStringOf Of hoJResp "email_notification.alternative_host_reminder" To sAlternative_host_reminder
Get ComStringOf Of hoJResp "email_notification.schedule_for_reminder" To sSchedule_for_reminder
Get ComStringOf Of hoJResp "zoom_rooms.upcoming_meeting_alert" To sUpcoming_meeting_alert
Get ComStringOf Of hoJResp "zoom_rooms.start_airplay_manually" To sStart_airplay_manually
Get ComStringOf Of hoJResp "zoom_rooms.weekly_system_restart" To sWeekly_system_restart
Get ComStringOf Of hoJResp "zoom_rooms.list_meetings_with_calendar" To sList_meetings_with_calendar
Get ComStringOf Of hoJResp "zoom_rooms.zr_post_meeting_feedback" To sZr_post_meeting_feedback
Get ComStringOf Of hoJResp "zoom_rooms.ultrasonic" To sUltrasonic
Get ComStringOf Of hoJResp "zoom_rooms.force_private_meeting" To sForce_private_meeting
Get ComStringOf Of hoJResp "zoom_rooms.hide_host_information" To sHide_host_information
Get ComStringOf Of hoJResp "zoom_rooms.cmr_for_instant_meeting" To sCmr_for_instant_meeting
Get ComStringOf Of hoJResp "zoom_rooms.auto_start_stop_scheduled_meetings" To sAuto_start_stop_scheduled_meetings
Get ComStringOf Of hoJResp "security.admin_change_name_pic" To sAdmin_change_name_pic
Get ComStringOf Of hoJResp "security.import_photos_from_devices" To sImport_photos_from_devices
Get ComStringOf Of hoJResp "security.hide_billing_info" To sHide_billing_info
Get ComStringOf Of hoJResp "recording.local_recording" To sLocal_recording
Get ComStringOf Of hoJResp "recording.cloud_recording" To sCloud_recording
Get ComStringOf Of hoJResp "recording.record_speaker_view" To sRecord_speaker_view
Get ComStringOf Of hoJResp "recording.record_gallery_view" To sRecord_gallery_view
Get ComStringOf Of hoJResp "recording.record_audio_file" To sRecord_audio_file
Get ComStringOf Of hoJResp "recording.save_chat_text" To sSave_chat_text
Get ComStringOf Of hoJResp "recording.show_timestamp" To sShow_timestamp
Get ComStringOf Of hoJResp "recording.recording_audio_transcript" To sRecording_audio_transcript
Get ComStringOf Of hoJResp "recording.auto_recording" To sAuto_recording
Get ComStringOf Of hoJResp "recording.cloud_recording_download" To sCloud_recording_download
Get ComStringOf Of hoJResp "recording.cloud_recording_download_host" To sCloud_recording_download_host
Get ComStringOf Of hoJResp "recording.account_user_access_recording" To sAccount_user_access_recording
Get ComStringOf Of hoJResp "recording.auto_delete_cmr" To sAuto_delete_cmr
Get ComStringOf Of hoJResp "recording.auto_delete_cmr_days" To sAuto_delete_cmr_days
Get ComStringOf Of hoJResp "telephony.third_party_audio" To sThird_party_audio
Get ComStringOf Of hoJResp "telephony.audio_conference_info" To sAudio_conference_info
Get ComStringOf Of hoJResp "tsp.call_out" To sCall_out
Get ComStringOf Of hoJResp "tsp.show_international_numbers_link" To sShow_international_numbers_link
Get ComStringOf Of hoJResp "tsp.display_toll_free_numbers" To sDisplay_toll_free_numbers
Get ComStringOf Of hoJResp "integration.google_calendar" To sGoogle_calendar
Get ComStringOf Of hoJResp "integration.google_drive" To sGoogle_drive
Get ComStringOf Of hoJResp "integration.dropbox" To sDropbox
Get ComStringOf Of hoJResp "integration.box" To sBox
Get ComStringOf Of hoJResp "integration.microsoft_one_drive" To sMicrosoft_one_drive
Get ComStringOf Of hoJResp "integration.kubi" To sKubi
Get ComStringOf Of hoJResp "feature.meeting_capacity" To sMeeting_capacity
Get ComBoolOf Of hoJResp "other_options.allow_auto_active_users" To iAllow_auto_active_users
Get ComBoolOf Of hoJResp "other_options.blur_snapshot" To iBlur_snapshot
Get ComBoolOf Of hoJResp "other_options.display_meetings_scheduled_for_others" To iDisplay_meetings_scheduled_for_others
Get ComStringOf Of hoJResp "other_options.use_cdn" To sUse_cdn
Get ComBoolOf Of hoJResp "other_options.allow_users_contact_support_via_chat" To iAllow_users_contact_support_via_chat
Get ComIntOf Of hoJResp "other_options.meeting_qos_and_mos" To iMeeting_qos_and_mos
Get ComBoolOf Of hoJResp "other_options.show_one_user_meeting_on_dashboard" To iShow_one_user_meeting_on_dashboard
Get ComBoolOf Of hoJResp "other_options.allow_users_enter_and_share_pronouns" To iAllow_users_enter_and_share_pronouns
Get ComBoolOf Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.enable" To iToll_free_and_fee_based_toll_callEnable
Get ComBoolOf Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.allow_webinar_attendees_dial" To iAllow_webinar_attendees_dial
Move 0 To i
Get ComSizeOfArray Of hoJResp "in_meeting.webinar_live_streaming.live_streaming_service" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "in_meeting.webinar_live_streaming.live_streaming_service[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "tsp.call_out_countries" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "tsp.call_out_countries[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.numbers" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].code" To sCode
Get ComStringOf Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_code" To sCountry_code
Get ComStringOf Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_name" To sCountry_name
Get ComStringOf Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].number" To sV_number
Get ComStringOf Of hoJResp "audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].display_number" To sDisplay_number
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
