SQL Server / Zoom API / Get user 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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'login_type', 100
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'option', 'meeting_authentication'
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'custom_query_fields', 'quis officia in reprehenderit'
-- 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/users/:userId/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
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.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": {
-- "audio_type": "both",
-- "embed_password_in_join_link": false,
-- "force_pmi_jbh_password": true,
-- "host_video": true,
-- "join_before_host": false,
-- "meeting_password_requirement": {
-- "have_letter": true,
-- "have_number": false,
-- "have_special_character": false,
-- "length": 6,
-- "only_allow_numeric": false
-- },
-- "not_store_meeting_topic": false,
-- "participants_video": false,
-- "pmi_password": "98654",
-- "pstn_password_protected": false,
-- "require_password_for_pmi_meetings": "all",
-- "require_password_for_scheduling_new_meetings": false,
-- "use_pmi_for_instant_meetings": true,
-- "use_pmi_for_scheduled_meetings": false
-- },
-- "in_meeting": {
-- "allow_live_streaming": false,
-- "allow_host_to_enable_focus_mode": false,
-- "attention_mode_focus_mode": false,
-- "annotation": true,
-- "attendee_on_hold": false,
-- "auto_saving_chat": false,
-- "breakout_room": true,
-- "breakout_room_schedule": true,
-- "chat": true,
-- "allow_participants_chat_with": 2,
-- "allow_users_save_chats": 2,
-- "closed_caption": true,
-- "co_host": false,
-- "custom_data_center_regions": true,
-- "data_center_regions": [
-- "AU",
-- "CN",
-- "EU",
-- "HK",
-- "LA",
-- "TY",
-- "US"
-- ],
-- "e2e_encryption": false,
-- "entry_exit_chime": "all",
-- "far_end_camera_control": false,
-- "feedback": true,
-- "group_hd": false,
-- "non_verbal_feedback": false,
-- "polling": true,
-- "private_chat": true,
-- "record_play_voice": false,
-- "remote_control": true,
-- "remote_support": false,
-- "show_meeting_control_toolbar": false,
-- "virtual_background": true,
-- "waiting_room": false,
-- "show_a_join_from_your_browser_link": true,
-- "join_from_mobile": true,
-- "join_from_desktop": true,
-- "live_streaming_facebook": true,
-- "workplace_by_facebook": true,
-- "live_streaming_youtube": true,
-- "custom_live_streaming_service": true,
-- "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": true,
-- "recording_available_reminder_schedulers": true,
-- "recording_available_reminder_alternative_hosts": true,
-- "jbh_reminder": false,
-- "cancel_meeting_reminder": false,
-- "alternative_host_reminder": false,
-- "schedule_for_reminder": false
-- },
-- "recording": {
-- "auto_delete_cmr": false,
-- "auto_recording": "none",
-- "cloud_recording": true,
-- "local_recording": true,
-- "record_audio_file": true,
-- "record_gallery_view": false,
-- "record_speaker_view": true,
-- "recording_audio_transcript": true,
-- "recording_password_requirement": {
-- "have_letter": true,
-- "have_number": true,
-- "have_special_character": true,
-- "length": 8,
-- "only_allow_numeric": false
-- },
-- "save_chat_text": true,
-- "show_timestamp": false
-- },
-- "telephony": {
-- "third_party_audio": false,
-- "audio_conference_info": "",
-- "show_international_numbers_link": false
-- },
-- "feature": {
-- "meeting_capacity": 100,
-- "large_meeting": false,
-- "webinar": false,
-- "cn_meeting": true,
-- "in_meeting": false,
-- "zoom_phone": false,
-- "concurrent_meeting": "Plus"
-- },
-- "tsp": {
-- "call_out": true,
-- "call_out_countries": [
-- "USA"
-- ],
-- "show_international_numbers_link": false
-- }
-- }
-- 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 @Audio_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Audio_type OUT, 'schedule_meeting.audio_type'
DECLARE @Embed_password_in_join_link int
EXEC sp_OAMethod @jResp, 'BoolOf', @Embed_password_in_join_link OUT, 'schedule_meeting.embed_password_in_join_link'
DECLARE @Force_pmi_jbh_password int
EXEC sp_OAMethod @jResp, 'BoolOf', @Force_pmi_jbh_password OUT, 'schedule_meeting.force_pmi_jbh_password'
DECLARE @Host_video int
EXEC sp_OAMethod @jResp, 'BoolOf', @Host_video OUT, 'schedule_meeting.host_video'
DECLARE @Join_before_host int
EXEC sp_OAMethod @jResp, 'BoolOf', @Join_before_host OUT, 'schedule_meeting.join_before_host'
DECLARE @Have_letter int
EXEC sp_OAMethod @jResp, 'BoolOf', @Have_letter OUT, 'schedule_meeting.meeting_password_requirement.have_letter'
DECLARE @Have_number int
EXEC sp_OAMethod @jResp, 'BoolOf', @Have_number OUT, 'schedule_meeting.meeting_password_requirement.have_number'
DECLARE @Have_special_character int
EXEC sp_OAMethod @jResp, 'BoolOf', @Have_special_character OUT, 'schedule_meeting.meeting_password_requirement.have_special_character'
DECLARE @Length int
EXEC sp_OAMethod @jResp, 'IntOf', @Length OUT, 'schedule_meeting.meeting_password_requirement.length'
DECLARE @Only_allow_numeric int
EXEC sp_OAMethod @jResp, 'BoolOf', @Only_allow_numeric OUT, 'schedule_meeting.meeting_password_requirement.only_allow_numeric'
DECLARE @Not_store_meeting_topic int
EXEC sp_OAMethod @jResp, 'BoolOf', @Not_store_meeting_topic OUT, 'schedule_meeting.not_store_meeting_topic'
DECLARE @Participants_video int
EXEC sp_OAMethod @jResp, 'BoolOf', @Participants_video OUT, 'schedule_meeting.participants_video'
DECLARE @Pmi_password nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Pmi_password OUT, 'schedule_meeting.pmi_password'
DECLARE @Pstn_password_protected int
EXEC sp_OAMethod @jResp, 'BoolOf', @Pstn_password_protected OUT, 'schedule_meeting.pstn_password_protected'
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 @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 @Use_pmi_for_instant_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Use_pmi_for_instant_meetings OUT, 'schedule_meeting.use_pmi_for_instant_meetings'
DECLARE @Use_pmi_for_scheduled_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Use_pmi_for_scheduled_meetings OUT, 'schedule_meeting.use_pmi_for_scheduled_meetings'
DECLARE @Allow_live_streaming int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_live_streaming OUT, 'in_meeting.allow_live_streaming'
DECLARE @Allow_host_to_enable_focus_mode int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_host_to_enable_focus_mode OUT, 'in_meeting.allow_host_to_enable_focus_mode'
DECLARE @Attention_mode_focus_mode int
EXEC sp_OAMethod @jResp, 'BoolOf', @Attention_mode_focus_mode OUT, 'in_meeting.attention_mode_focus_mode'
DECLARE @Annotation int
EXEC sp_OAMethod @jResp, 'BoolOf', @Annotation OUT, 'in_meeting.annotation'
DECLARE @Attendee_on_hold int
EXEC sp_OAMethod @jResp, 'BoolOf', @Attendee_on_hold OUT, 'in_meeting.attendee_on_hold'
DECLARE @Auto_saving_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_saving_chat OUT, 'in_meeting.auto_saving_chat'
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 @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 @Closed_caption int
EXEC sp_OAMethod @jResp, 'BoolOf', @Closed_caption OUT, 'in_meeting.closed_caption'
DECLARE @Co_host int
EXEC sp_OAMethod @jResp, 'BoolOf', @Co_host OUT, 'in_meeting.co_host'
DECLARE @Custom_data_center_regions int
EXEC sp_OAMethod @jResp, 'BoolOf', @Custom_data_center_regions OUT, 'in_meeting.custom_data_center_regions'
DECLARE @E2e_encryption int
EXEC sp_OAMethod @jResp, 'BoolOf', @E2e_encryption OUT, 'in_meeting.e2e_encryption'
DECLARE @Entry_exit_chime nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Entry_exit_chime OUT, 'in_meeting.entry_exit_chime'
DECLARE @Far_end_camera_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Far_end_camera_control OUT, 'in_meeting.far_end_camera_control'
DECLARE @Feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Feedback OUT, 'in_meeting.feedback'
DECLARE @Group_hd int
EXEC sp_OAMethod @jResp, 'BoolOf', @Group_hd OUT, 'in_meeting.group_hd'
DECLARE @Non_verbal_feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Non_verbal_feedback OUT, 'in_meeting.non_verbal_feedback'
DECLARE @Polling int
EXEC sp_OAMethod @jResp, 'BoolOf', @Polling OUT, 'in_meeting.polling'
DECLARE @Private_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Private_chat OUT, 'in_meeting.private_chat'
DECLARE @Record_play_voice int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_play_voice OUT, 'in_meeting.record_play_voice'
DECLARE @Remote_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Remote_control OUT, 'in_meeting.remote_control'
DECLARE @Remote_support int
EXEC sp_OAMethod @jResp, 'BoolOf', @Remote_support OUT, 'in_meeting.remote_support'
DECLARE @Show_meeting_control_toolbar int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_meeting_control_toolbar OUT, 'in_meeting.show_meeting_control_toolbar'
DECLARE @Virtual_background int
EXEC sp_OAMethod @jResp, 'BoolOf', @Virtual_background OUT, 'in_meeting.virtual_background'
DECLARE @Waiting_room int
EXEC sp_OAMethod @jResp, 'BoolOf', @Waiting_room OUT, 'in_meeting.waiting_room'
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 @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 @Enable int
EXEC sp_OAMethod @jResp, 'BoolOf', @Enable OUT, 'in_meeting.webinar_live_streaming.enable'
DECLARE @Custom_service_instructions nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Custom_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_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 @Auto_delete_cmr int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_delete_cmr OUT, 'recording.auto_delete_cmr'
DECLARE @Auto_recording nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Auto_recording OUT, 'recording.auto_recording'
DECLARE @Cloud_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording OUT, 'recording.cloud_recording'
DECLARE @Local_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Local_recording OUT, 'recording.local_recording'
DECLARE @Record_audio_file int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_audio_file OUT, 'recording.record_audio_file'
DECLARE @Record_gallery_view int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_gallery_view OUT, 'recording.record_gallery_view'
DECLARE @Record_speaker_view int
EXEC sp_OAMethod @jResp, 'BoolOf', @Record_speaker_view OUT, 'recording.record_speaker_view'
DECLARE @Recording_audio_transcript int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_audio_transcript OUT, 'recording.recording_audio_transcript'
DECLARE @Recording_password_requirementHave_letter int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_password_requirementHave_letter OUT, 'recording.recording_password_requirement.have_letter'
DECLARE @Recording_password_requirementHave_number int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_password_requirementHave_number OUT, 'recording.recording_password_requirement.have_number'
DECLARE @Recording_password_requirementHave_special_character int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_password_requirementHave_special_character OUT, 'recording.recording_password_requirement.have_special_character'
DECLARE @Recording_password_requirementLength int
EXEC sp_OAMethod @jResp, 'IntOf', @Recording_password_requirementLength OUT, 'recording.recording_password_requirement.length'
DECLARE @Recording_password_requirementOnly_allow_numeric int
EXEC sp_OAMethod @jResp, 'BoolOf', @Recording_password_requirementOnly_allow_numeric OUT, 'recording.recording_password_requirement.only_allow_numeric'
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 @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 @Show_international_numbers_link int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_international_numbers_link OUT, 'telephony.show_international_numbers_link'
DECLARE @Meeting_capacity int
EXEC sp_OAMethod @jResp, 'IntOf', @Meeting_capacity OUT, 'feature.meeting_capacity'
DECLARE @Large_meeting int
EXEC sp_OAMethod @jResp, 'BoolOf', @Large_meeting OUT, 'feature.large_meeting'
DECLARE @Webinar int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar OUT, 'feature.webinar'
DECLARE @Cn_meeting int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cn_meeting OUT, 'feature.cn_meeting'
DECLARE @In_meeting int
EXEC sp_OAMethod @jResp, 'BoolOf', @In_meeting OUT, 'feature.in_meeting'
DECLARE @Zoom_phone int
EXEC sp_OAMethod @jResp, 'BoolOf', @Zoom_phone OUT, 'feature.zoom_phone'
DECLARE @Concurrent_meeting nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Concurrent_meeting OUT, 'feature.concurrent_meeting'
DECLARE @Call_out int
EXEC sp_OAMethod @jResp, 'BoolOf', @Call_out OUT, 'tsp.call_out'
DECLARE @tspShow_international_numbers_link int
EXEC sp_OAMethod @jResp, 'BoolOf', @tspShow_international_numbers_link OUT, 'tsp.show_international_numbers_link'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'in_meeting.data_center_regions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'in_meeting.data_center_regions[i]'
SELECT @i = @i + 1
END
SELECT @i = 0
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, 'tsp.call_out_countries'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @strVal OUT, 'tsp.call_out_countries[i]'
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 "login_type=100"
-d "option=meeting_authentication"
-d "custom_query_fields=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/users/:userId/settings
Postman Collection Item JSON
{
"name": "Get user settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/users/:userId/settings?login_type=100&option=meeting_authentication&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"settings"
],
"query": [
{
"key": "login_type",
"value": "100",
"description": "The user's login method:\n\n`0` — Facebook OAuth</br>`1` — Google OAuth</br>`24` — Apple OAuth</br>`27` — Microsoft OAuth</br>`97` — Mobile device</br>`98` — RingCentral OAuth</br>`99` — API user</br>`100` — Zoom Work email</br>`101` — Single Sign-On (SSO)\n\nThe following login methods are only available in China:\n\n`11` — Phone number</br>`21` — WeChat</br>`23` — Alipay"
},
{
"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."
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit",
"description": "Provide the name of the field by which you would like to filter the response. For example, if you provide \"host_video\" as the value of this field, you will get a response similar to the following:<br>\n{\n \"schedule_meeting\": {\n \"host_video\": false\n }\n}\n<br>You can provide multiple values by separating them with commas(example: \"host_video,participant_video”)."
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
},
"description": "Retrieve a user's settings. For user-level apps, pass [the `me` value](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis#mekeyword) instead of the `userId` parameter.\n\n**Scopes:** `user:read:admin`, `user:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `200`<br>\nUser settings returned.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/settings?login_type=100&option=meeting_authentication&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"settings"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "option",
"value": "meeting_authentication"
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"schedule_meeting\": {\n \"audio_type\": \"both\",\n \"embed_password_in_join_link\": false,\n \"force_pmi_jbh_password\": true,\n \"host_video\": true,\n \"join_before_host\": false,\n \"meeting_password_requirement\": {\n \"have_letter\": true,\n \"have_number\": false,\n \"have_special_character\": false,\n \"length\": 6,\n \"only_allow_numeric\": false\n },\n \"not_store_meeting_topic\": false,\n \"participants_video\": false,\n \"pmi_password\": \"98654\",\n \"pstn_password_protected\": false,\n \"require_password_for_pmi_meetings\": \"all\",\n \"require_password_for_scheduling_new_meetings\": false,\n \"use_pmi_for_instant_meetings\": true,\n \"use_pmi_for_scheduled_meetings\": false\n },\n \"in_meeting\": {\n \"allow_live_streaming\": false,\n \"allow_host_to_enable_focus_mode\": false,\n \"attention_mode_focus_mode\": false,\n \"annotation\": true,\n \"attendee_on_hold\": false,\n \"auto_saving_chat\": false,\n \"breakout_room\": true,\n \"breakout_room_schedule\": true,\n \"chat\": true,\n \"allow_participants_chat_with\": 2,\n \"allow_users_save_chats\": 2,\n \"closed_caption\": true,\n \"co_host\": false,\n \"custom_data_center_regions\": true,\n \"data_center_regions\": [\n \"AU\",\n \"CN\",\n \"EU\",\n \"HK\",\n \"LA\",\n \"TY\",\n \"US\"\n ],\n \"e2e_encryption\": false,\n \"entry_exit_chime\": \"all\",\n \"far_end_camera_control\": false,\n \"feedback\": true,\n \"group_hd\": false,\n \"non_verbal_feedback\": false,\n \"polling\": true,\n \"private_chat\": true,\n \"record_play_voice\": false,\n \"remote_control\": true,\n \"remote_support\": false,\n \"show_meeting_control_toolbar\": false,\n \"virtual_background\": true,\n \"waiting_room\": false,\n \"show_a_join_from_your_browser_link\": true,\n \"join_from_mobile\": true,\n \"join_from_desktop\": true,\n \"live_streaming_facebook\": true,\n \"workplace_by_facebook\": true,\n \"live_streaming_youtube\": true,\n \"custom_live_streaming_service\": true,\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\": true,\n \"recording_available_reminder_schedulers\": true,\n \"recording_available_reminder_alternative_hosts\": true,\n \"jbh_reminder\": false,\n \"cancel_meeting_reminder\": false,\n \"alternative_host_reminder\": false,\n \"schedule_for_reminder\": false\n },\n \"recording\": {\n \"auto_delete_cmr\": false,\n \"auto_recording\": \"none\",\n \"cloud_recording\": true,\n \"local_recording\": true,\n \"record_audio_file\": true,\n \"record_gallery_view\": false,\n \"record_speaker_view\": true,\n \"recording_audio_transcript\": true,\n \"recording_password_requirement\": {\n \"have_letter\": true,\n \"have_number\": true,\n \"have_special_character\": true,\n \"length\": 8,\n \"only_allow_numeric\": false\n },\n \"save_chat_text\": true,\n \"show_timestamp\": false\n },\n \"telephony\": {\n \"third_party_audio\": false,\n \"audio_conference_info\": \"\",\n \"show_international_numbers_link\": false\n },\n \"feature\": {\n \"meeting_capacity\": 100,\n \"large_meeting\": false,\n \"webinar\": false,\n \"cn_meeting\": true,\n \"in_meeting\": false,\n \"zoom_phone\": false,\n \"concurrent_meeting\": \"Plus\"\n },\n \"tsp\": {\n \"call_out\": true,\n \"call_out_countries\": [\n \"USA\"\n ],\n \"show_international_numbers_link\": false\n }\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n\n**Error Code:** `1120`<br>\nA valid invitation to join the Zoom account was not found for this user. <br>\nThis error is thrown if you added a user in your account but the user did not accept the invitation o",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/settings?login_type=100&option=meeting_authentication&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"settings"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "option",
"value": "meeting_authentication"
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404` **Not Found**<br><br>\n**Error Code:** `1001`<br>\nUser does not exist: $userId.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/users/:userId/settings?login_type=100&option=meeting_authentication&custom_query_fields=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"users",
":userId",
"settings"
],
"query": [
{
"key": "login_type",
"value": "100"
},
{
"key": "option",
"value": "meeting_authentication"
},
{
"key": "custom_query_fields",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "userId",
"value": "quis officia in reprehenderit",
"description": "(Required) The user ID or email address of the user. For user-level apps, pass the `me` value for this parameter."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
