SQL Server / Zoom API / Get a group's settings
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'option', 'meeting_authentication'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.zoom.us/v2/groups/:groupId/settings', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "schedule_meeting": {
-- "host_video": true,
-- "participant_video": true,
-- "audio_type": "both",
-- "join_before_host": true,
-- "force_pmi_jbh_password": true,
-- "require_password_for_scheduling_new_meetings": true,
-- "require_password_for_scheduled_meetings": true,
-- "require_password_for_instant_meetings": false,
-- "require_password_for_pmi_meetings": "all",
-- "pstn_password_protected": true,
-- "mute_upon_entry": true,
-- "upcoming_meeting_reminder": true
-- },
-- "in_meeting": {
-- "e2e_encryption": true,
-- "chat": true,
-- "allow_participants_chat_with": 2,
-- "allow_users_save_chats": 2,
-- "private_chat": true,
-- "auto_saving_chat": true,
-- "entry_exit_chime": "all",
-- "record_play_own_voice": false,
-- "feedback": true,
-- "post_meeting_feedback": true,
-- "co_host": true,
-- "polling": true,
-- "attendee_on_hold": true,
-- "show_meeting_control_toolbar": true,
-- "allow_show_zoom_windows": true,
-- "annotation": true,
-- "whiteboard": true,
-- "remote_control": true,
-- "non_verbal_feedback": true,
-- "breakout_room": true,
-- "breakout_room_schedule": true,
-- "remote_support": true,
-- "closed_caption": true,
-- "far_end_camera_control": true,
-- "group_hd": true,
-- "virtual_background": true,
-- "alert_guest_join": true,
-- "auto_answer": true,
-- "sending_default_email_invites": true,
-- "use_html_format_email": true,
-- "stereo_audio": true,
-- "original_audio": true,
-- "show_device_list": false,
-- "only_host_view_device_list": false,
-- "screen_sharing": true,
-- "waiting_room": true,
-- "show_browser_join_link": true,
-- "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_question_answer": 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": true,
-- "recording_available_reminder_schedulers": true,
-- "recording_available_reminder_alternative_hosts": true,
-- "jbh_reminder": true,
-- "cancel_meeting_reminder": true,
-- "alternative_host_reminder": true,
-- "schedule_for_reminder": true
-- },
-- "recording": {
-- "local_recording": true,
-- "cloud_recording": true,
-- "record_speaker_view": true,
-- "record_gallery_view": false,
-- "record_audio_file": true,
-- "save_chat_text": true,
-- "show_timestamp": false,
-- "recording_audio_transcript": false,
-- "auto_recording": "none",
-- "cloud_recording_download": true,
-- "cloud_recording_download_host": true,
-- "account_user_access_recording": false,
-- "host_delete_cloud_recording": true
-- },
-- "telephony": {
-- "third_party_audio": true,
-- "audio_conference_info": "1234656"
-- },
-- "other_options": {
-- "blur_snapshot": true,
-- "allow_users_contact_support_via_chat": true
-- },
-- "audio_conferencing": {
-- "toll_free_and_fee_based_toll_call": {
-- "enable": true,
-- "numbers": [
-- {
-- "code": "64",
-- "country_code": "US",
-- "country_name": "United States",
-- "number": "+1 5550100",
-- "display_number": "+1 5550100(Atlanta)"
-- },
-- {
-- "code": "64",
-- "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
DECLARE @strVal nvarchar(4000)
DECLARE @code nvarchar(4000)
DECLARE @country_code nvarchar(4000)
DECLARE @country_name nvarchar(4000)
DECLARE @v_number nvarchar(4000)
DECLARE @display_number nvarchar(4000)
DECLARE @Host_video int
EXEC sp_OAMethod @jResp, 'BoolOf', @Host_video OUT, 'schedule_meeting.host_video'
DECLARE @Participant_video int
EXEC sp_OAMethod @jResp, 'BoolOf', @Participant_video OUT, 'schedule_meeting.participant_video'
DECLARE @Audio_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Audio_type OUT, 'schedule_meeting.audio_type'
DECLARE @Join_before_host int
EXEC sp_OAMethod @jResp, 'BoolOf', @Join_before_host OUT, 'schedule_meeting.join_before_host'
DECLARE @Force_pmi_jbh_password int
EXEC sp_OAMethod @jResp, 'BoolOf', @Force_pmi_jbh_password OUT, 'schedule_meeting.force_pmi_jbh_password'
DECLARE @Require_password_for_scheduling_new_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Require_password_for_scheduling_new_meetings OUT, 'schedule_meeting.require_password_for_scheduling_new_meetings'
DECLARE @Require_password_for_scheduled_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Require_password_for_scheduled_meetings OUT, 'schedule_meeting.require_password_for_scheduled_meetings'
DECLARE @Require_password_for_instant_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Require_password_for_instant_meetings OUT, 'schedule_meeting.require_password_for_instant_meetings'
DECLARE @Require_password_for_pmi_meetings nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Require_password_for_pmi_meetings OUT, 'schedule_meeting.require_password_for_pmi_meetings'
DECLARE @Pstn_password_protected int
EXEC sp_OAMethod @jResp, 'BoolOf', @Pstn_password_protected OUT, 'schedule_meeting.pstn_password_protected'
DECLARE @Mute_upon_entry int
EXEC sp_OAMethod @jResp, 'BoolOf', @Mute_upon_entry OUT, 'schedule_meeting.mute_upon_entry'
DECLARE @Upcoming_meeting_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Upcoming_meeting_reminder OUT, 'schedule_meeting.upcoming_meeting_reminder'
DECLARE @E2e_encryption int
EXEC sp_OAMethod @jResp, 'BoolOf', @E2e_encryption OUT, 'in_meeting.e2e_encryption'
DECLARE @Chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Chat OUT, 'in_meeting.chat'
DECLARE @Allow_participants_chat_with int
EXEC sp_OAMethod @jResp, 'IntOf', @Allow_participants_chat_with OUT, 'in_meeting.allow_participants_chat_with'
DECLARE @Allow_users_save_chats int
EXEC sp_OAMethod @jResp, 'IntOf', @Allow_users_save_chats OUT, 'in_meeting.allow_users_save_chats'
DECLARE @Private_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Private_chat OUT, 'in_meeting.private_chat'
DECLARE @Auto_saving_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_saving_chat OUT, 'in_meeting.auto_saving_chat'
DECLARE @Entry_exit_chime nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Entry_exit_chime OUT, 'in_meeting.entry_exit_chime'
DECLARE @Record_play_own_voice int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_play_own_voice OUT, 'in_meeting.record_play_own_voice'
DECLARE @Feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Feedback OUT, 'in_meeting.feedback'
DECLARE @Post_meeting_feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Post_meeting_feedback OUT, 'in_meeting.post_meeting_feedback'
DECLARE @Co_host int
EXEC sp_OAMethod @jResp, 'BoolOf', @Co_host OUT, 'in_meeting.co_host'
DECLARE @Polling int
EXEC sp_OAMethod @jResp, 'BoolOf', @Polling OUT, 'in_meeting.polling'
DECLARE @Attendee_on_hold int
EXEC sp_OAMethod @jResp, 'BoolOf', @Attendee_on_hold OUT, 'in_meeting.attendee_on_hold'
DECLARE @Show_meeting_control_toolbar int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_meeting_control_toolbar OUT, 'in_meeting.show_meeting_control_toolbar'
DECLARE @Allow_show_zoom_windows int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_show_zoom_windows OUT, 'in_meeting.allow_show_zoom_windows'
DECLARE @Annotation int
EXEC sp_OAMethod @jResp, 'BoolOf', @Annotation OUT, 'in_meeting.annotation'
DECLARE @Whiteboard int
EXEC sp_OAMethod @jResp, 'BoolOf', @Whiteboard OUT, 'in_meeting.whiteboard'
DECLARE @Remote_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Remote_control OUT, 'in_meeting.remote_control'
DECLARE @Non_verbal_feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Non_verbal_feedback OUT, 'in_meeting.non_verbal_feedback'
DECLARE @Breakout_room int
EXEC sp_OAMethod @jResp, 'BoolOf', @Breakout_room OUT, 'in_meeting.breakout_room'
DECLARE @Breakout_room_schedule int
EXEC sp_OAMethod @jResp, 'BoolOf', @Breakout_room_schedule OUT, 'in_meeting.breakout_room_schedule'
DECLARE @Remote_support int
EXEC sp_OAMethod @jResp, 'BoolOf', @Remote_support OUT, 'in_meeting.remote_support'
DECLARE @Closed_caption int
EXEC sp_OAMethod @jResp, 'BoolOf', @Closed_caption OUT, 'in_meeting.closed_caption'
DECLARE @Far_end_camera_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Far_end_camera_control OUT, 'in_meeting.far_end_camera_control'
DECLARE @Group_hd int
EXEC sp_OAMethod @jResp, 'BoolOf', @Group_hd OUT, 'in_meeting.group_hd'
DECLARE @Virtual_background int
EXEC sp_OAMethod @jResp, 'BoolOf', @Virtual_background OUT, 'in_meeting.virtual_background'
DECLARE @Alert_guest_join int
EXEC sp_OAMethod @jResp, 'BoolOf', @Alert_guest_join OUT, 'in_meeting.alert_guest_join'
DECLARE @Auto_answer int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_answer OUT, 'in_meeting.auto_answer'
DECLARE @Sending_default_email_invites int
EXEC sp_OAMethod @jResp, 'BoolOf', @Sending_default_email_invites OUT, 'in_meeting.sending_default_email_invites'
DECLARE @Use_html_format_email int
EXEC sp_OAMethod @jResp, 'BoolOf', @Use_html_format_email OUT, 'in_meeting.use_html_format_email'
DECLARE @Stereo_audio int
EXEC sp_OAMethod @jResp, 'BoolOf', @Stereo_audio OUT, 'in_meeting.stereo_audio'
DECLARE @Original_audio int
EXEC sp_OAMethod @jResp, 'BoolOf', @Original_audio OUT, 'in_meeting.original_audio'
DECLARE @Show_device_list int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_device_list OUT, 'in_meeting.show_device_list'
DECLARE @Only_host_view_device_list int
EXEC sp_OAMethod @jResp, 'BoolOf', @Only_host_view_device_list OUT, 'in_meeting.only_host_view_device_list'
DECLARE @Screen_sharing int
EXEC sp_OAMethod @jResp, 'BoolOf', @Screen_sharing OUT, 'in_meeting.screen_sharing'
DECLARE @Waiting_room int
EXEC sp_OAMethod @jResp, 'BoolOf', @Waiting_room OUT, 'in_meeting.waiting_room'
DECLARE @Show_browser_join_link int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_browser_join_link OUT, 'in_meeting.show_browser_join_link'
DECLARE @Show_a_join_from_your_browser_link int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_a_join_from_your_browser_link OUT, 'in_meeting.show_a_join_from_your_browser_link'
DECLARE @Join_from_mobile int
EXEC sp_OAMethod @jResp, 'BoolOf', @Join_from_mobile OUT, 'in_meeting.join_from_mobile'
DECLARE @Join_from_desktop int
EXEC sp_OAMethod @jResp, 'BoolOf', @Join_from_desktop OUT, 'in_meeting.join_from_desktop'
DECLARE @Allow_live_streaming int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_live_streaming OUT, 'in_meeting.allow_live_streaming'
DECLARE @Live_streaming_facebook int
EXEC sp_OAMethod @jResp, 'BoolOf', @Live_streaming_facebook OUT, 'in_meeting.live_streaming_facebook'
DECLARE @Workplace_by_facebook int
EXEC sp_OAMethod @jResp, 'BoolOf', @Workplace_by_facebook OUT, 'in_meeting.workplace_by_facebook'
DECLARE @Live_streaming_youtube int
EXEC sp_OAMethod @jResp, 'BoolOf', @Live_streaming_youtube OUT, 'in_meeting.live_streaming_youtube'
DECLARE @Custom_live_streaming_service int
EXEC sp_OAMethod @jResp, 'BoolOf', @Custom_live_streaming_service OUT, 'in_meeting.custom_live_streaming_service'
DECLARE @Custom_service_instructions nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Custom_service_instructions OUT, 'in_meeting.custom_service_instructions'
DECLARE @Enable int
EXEC sp_OAMethod @jResp, 'BoolOf', @Enable OUT, 'in_meeting.webinar_live_streaming.enable'
DECLARE @Webinar_live_streamingCustom_service_instructions nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Webinar_live_streamingCustom_service_instructions OUT, 'in_meeting.webinar_live_streaming.custom_service_instructions'
DECLARE @Live_streaming_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Live_streaming_reminder OUT, 'in_meeting.webinar_live_streaming.live_streaming_reminder'
DECLARE @Webinar_question_answer int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_question_answer OUT, 'in_meeting.webinar_question_answer'
DECLARE @Webinar_chatEnable int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_chatEnable OUT, 'in_meeting.webinar_chat.enable'
DECLARE @Allow_panelists_chat_with int
EXEC sp_OAMethod @jResp, 'IntOf', @Allow_panelists_chat_with OUT, 'in_meeting.webinar_chat.allow_panelists_chat_with'
DECLARE @Allow_attendees_chat_with int
EXEC sp_OAMethod @jResp, 'IntOf', @Allow_attendees_chat_with OUT, 'in_meeting.webinar_chat.allow_attendees_chat_with'
DECLARE @Default_attendees_chat_with int
EXEC sp_OAMethod @jResp, 'IntOf', @Default_attendees_chat_with OUT, 'in_meeting.webinar_chat.default_attendees_chat_with'
DECLARE @Allow_panelists_send_direct_message int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_panelists_send_direct_message OUT, 'in_meeting.webinar_chat.allow_panelists_send_direct_message'
DECLARE @Webinar_chatAllow_users_save_chats int
EXEC sp_OAMethod @jResp, 'IntOf', @Webinar_chatAllow_users_save_chats OUT, 'in_meeting.webinar_chat.allow_users_save_chats'
DECLARE @Allow_auto_save_local_chat_file int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_auto_save_local_chat_file OUT, 'in_meeting.webinar_chat.allow_auto_save_local_chat_file'
DECLARE @Closed_captioningEnable int
EXEC sp_OAMethod @jResp, 'BoolOf', @Closed_captioningEnable OUT, 'in_meeting.closed_captioning.enable'
DECLARE @Third_party_captioning_service int
EXEC sp_OAMethod @jResp, 'BoolOf', @Third_party_captioning_service OUT, 'in_meeting.closed_captioning.third_party_captioning_service'
DECLARE @Auto_transcribing int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_transcribing OUT, 'in_meeting.closed_captioning.auto_transcribing'
DECLARE @View_full_transcript int
EXEC sp_OAMethod @jResp, 'BoolOf', @View_full_transcript OUT, 'in_meeting.closed_captioning.view_full_transcript'
DECLARE @Save_caption int
EXEC sp_OAMethod @jResp, 'BoolOf', @Save_caption OUT, 'in_meeting.closed_captioning.save_caption'
DECLARE @Slide_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Slide_control OUT, 'in_meeting.slide_control'
DECLARE @Meeting_survey int
EXEC sp_OAMethod @jResp, 'BoolOf', @Meeting_survey OUT, 'in_meeting.meeting_survey'
DECLARE @Webinar_pollingEnable int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_pollingEnable OUT, 'in_meeting.webinar_polling.enable'
DECLARE @Advanced_polls int
EXEC sp_OAMethod @jResp, 'BoolOf', @Advanced_polls OUT, 'in_meeting.webinar_polling.advanced_polls'
DECLARE @Webinar_survey int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_survey OUT, 'in_meeting.webinar_survey'
DECLARE @Cloud_recording_available_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording_available_reminder OUT, 'email_notification.cloud_recording_available_reminder'
DECLARE @Recording_available_reminder_schedulers int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_available_reminder_schedulers OUT, 'email_notification.recording_available_reminder_schedulers'
DECLARE @Recording_available_reminder_alternative_hosts int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_available_reminder_alternative_hosts OUT, 'email_notification.recording_available_reminder_alternative_hosts'
DECLARE @Jbh_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Jbh_reminder OUT, 'email_notification.jbh_reminder'
DECLARE @Cancel_meeting_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cancel_meeting_reminder OUT, 'email_notification.cancel_meeting_reminder'
DECLARE @Alternative_host_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Alternative_host_reminder OUT, 'email_notification.alternative_host_reminder'
DECLARE @Schedule_for_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Schedule_for_reminder OUT, 'email_notification.schedule_for_reminder'
DECLARE @Local_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Local_recording OUT, 'recording.local_recording'
DECLARE @Cloud_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording OUT, 'recording.cloud_recording'
DECLARE @Record_speaker_view int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_speaker_view OUT, 'recording.record_speaker_view'
DECLARE @Record_gallery_view int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_gallery_view OUT, 'recording.record_gallery_view'
DECLARE @Record_audio_file int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_audio_file OUT, 'recording.record_audio_file'
DECLARE @Save_chat_text int
EXEC sp_OAMethod @jResp, 'BoolOf', @Save_chat_text OUT, 'recording.save_chat_text'
DECLARE @Show_timestamp int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_timestamp OUT, 'recording.show_timestamp'
DECLARE @Recording_audio_transcript int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_audio_transcript OUT, 'recording.recording_audio_transcript'
DECLARE @Auto_recording nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Auto_recording OUT, 'recording.auto_recording'
DECLARE @Cloud_recording_download int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording_download OUT, 'recording.cloud_recording_download'
DECLARE @Cloud_recording_download_host int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording_download_host OUT, 'recording.cloud_recording_download_host'
DECLARE @Account_user_access_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Account_user_access_recording OUT, 'recording.account_user_access_recording'
DECLARE @Host_delete_cloud_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Host_delete_cloud_recording OUT, 'recording.host_delete_cloud_recording'
DECLARE @Third_party_audio int
EXEC sp_OAMethod @jResp, 'BoolOf', @Third_party_audio OUT, 'telephony.third_party_audio'
DECLARE @Audio_conference_info nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Audio_conference_info OUT, 'telephony.audio_conference_info'
DECLARE @Blur_snapshot int
EXEC sp_OAMethod @jResp, 'BoolOf', @Blur_snapshot OUT, 'other_options.blur_snapshot'
DECLARE @Allow_users_contact_support_via_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_users_contact_support_via_chat OUT, 'other_options.allow_users_contact_support_via_chat'
DECLARE @Toll_free_and_fee_based_toll_callEnable int
EXEC sp_OAMethod @jResp, 'BoolOf', @Toll_free_and_fee_based_toll_callEnable OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.enable'
DECLARE @Allow_webinar_attendees_dial int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_webinar_attendees_dial OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.allow_webinar_attendees_dial'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'in_meeting.webinar_live_streaming.live_streaming_service'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'in_meeting.webinar_live_streaming.live_streaming_service[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.numbers'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @code OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].code'
EXEC sp_OAMethod @jResp, 'StringOf', @country_code OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_code'
EXEC sp_OAMethod @jResp, 'StringOf', @country_name OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_name'
EXEC sp_OAMethod @jResp, 'StringOf', @v_number OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].number'
EXEC sp_OAMethod @jResp, 'StringOf', @display_number OUT, 'audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].display_number'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -G -d "option=meeting_authentication"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/groups/:groupId/settings
Postman Collection Item JSON
{
"name": "Get a group's settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings?option=meeting_authentication",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_authentication",
"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* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account."
}
],
"variable": [
{
"key": "groupId"
}
]
},
"description": "Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). \n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**Error Code**: `200` <br>\nOnly available for paid account.\n\n**HTTP Status Code**: `200` <br>\nGroup Settings Returned.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings?option=meeting_authentication",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_authentication"
}
],
"variable": [
{
"key": "groupId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"schedule_meeting\": {\n \"host_video\": true,\n \"participant_video\": true,\n \"audio_type\": \"both\",\n \"join_before_host\": true,\n \"force_pmi_jbh_password\": true,\n \"require_password_for_scheduling_new_meetings\": true,\n \"require_password_for_scheduled_meetings\": true,\n \"require_password_for_instant_meetings\": false,\n \"require_password_for_pmi_meetings\": \"all\",\n \"pstn_password_protected\": true,\n \"mute_upon_entry\": true,\n \"upcoming_meeting_reminder\": true\n },\n \"in_meeting\": {\n \"e2e_encryption\": true,\n \"chat\": true,\n \"allow_participants_chat_with\": 2,\n \"allow_users_save_chats\": 2,\n \"private_chat\": true,\n \"auto_saving_chat\": true,\n \"entry_exit_chime\": \"all\",\n \"record_play_own_voice\": false,\n \"feedback\": true,\n \"post_meeting_feedback\": true,\n \"co_host\": true,\n \"polling\": true,\n \"attendee_on_hold\": true,\n \"show_meeting_control_toolbar\": true,\n \"allow_show_zoom_windows\": true,\n \"annotation\": true,\n \"whiteboard\": true,\n \"remote_control\": true,\n \"non_verbal_feedback\": true,\n \"breakout_room\": true,\n \"breakout_room_schedule\": true,\n \"remote_support\": true,\n \"closed_caption\": true,\n \"far_end_camera_control\": true,\n \"group_hd\": true,\n \"virtual_background\": true,\n \"alert_guest_join\": true,\n \"auto_answer\": true,\n \"sending_default_email_invites\": true,\n \"use_html_format_email\": true,\n \"stereo_audio\": true,\n \"original_audio\": true,\n \"show_device_list\": false,\n \"only_host_view_device_list\": false,\n \"screen_sharing\": true,\n \"waiting_room\": true,\n \"show_browser_join_link\": true,\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_question_answer\": true,\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\": true,\n \"recording_available_reminder_schedulers\": true,\n \"recording_available_reminder_alternative_hosts\": true,\n \"jbh_reminder\": true,\n \"cancel_meeting_reminder\": true,\n \"alternative_host_reminder\": true,\n \"schedule_for_reminder\": true\n },\n \"recording\": {\n \"local_recording\": true,\n \"cloud_recording\": true,\n \"record_speaker_view\": true,\n \"record_gallery_view\": false,\n \"record_audio_file\": true,\n \"save_chat_text\": true,\n \"show_timestamp\": false,\n \"recording_audio_transcript\": false,\n \"auto_recording\": \"none\",\n \"cloud_recording_download\": true,\n \"cloud_recording_download_host\": true,\n \"account_user_access_recording\": false,\n \"host_delete_cloud_recording\": true\n },\n \"telephony\": {\n \"third_party_audio\": true,\n \"audio_conference_info\": \"1234656\"\n },\n \"other_options\": {\n \"blur_snapshot\": true,\n \"allow_users_contact_support_via_chat\": true\n },\n \"audio_conferencing\": {\n \"toll_free_and_fee_based_toll_call\": {\n \"enable\": true,\n \"numbers\": [\n {\n \"code\": \"64\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"number\": \"+1 5550100\",\n \"display_number\": \"+1 5550100(Atlanta)\"\n },\n {\n \"code\": \"64\",\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:** `4130` <br>\nGroup does not exist: {groupId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings?option=meeting_authentication",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_authentication"
}
],
"variable": [
{
"key": "groupId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
