Foxpro / Zoom API / Get user settings
Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loQueryParams
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcStrVal
LOCAL lcAudio_type
LOCAL lnEmbed_password_in_join_link
LOCAL lnForce_pmi_jbh_password
LOCAL lnHost_video
LOCAL lnJoin_before_host
LOCAL lnHave_letter
LOCAL lnHave_number
LOCAL lnHave_special_character
LOCAL lnLength
LOCAL lnOnly_allow_numeric
LOCAL lnNot_store_meeting_topic
LOCAL lnParticipants_video
LOCAL lcPmi_password
LOCAL lnPstn_password_protected
LOCAL lcRequire_password_for_pmi_meetings
LOCAL lnRequire_password_for_scheduling_new_meetings
LOCAL lnUse_pmi_for_instant_meetings
LOCAL lnUse_pmi_for_scheduled_meetings
LOCAL lnAllow_live_streaming
LOCAL lnAllow_host_to_enable_focus_mode
LOCAL lnAttention_mode_focus_mode
LOCAL lnAnnotation
LOCAL lnAttendee_on_hold
LOCAL lnAuto_saving_chat
LOCAL lnBreakout_room
LOCAL lnBreakout_room_schedule
LOCAL lnChat
LOCAL lnAllow_participants_chat_with
LOCAL lnAllow_users_save_chats
LOCAL lnClosed_caption
LOCAL lnCo_host
LOCAL lnCustom_data_center_regions
LOCAL lnE2e_encryption
LOCAL lcEntry_exit_chime
LOCAL lnFar_end_camera_control
LOCAL lnFeedback
LOCAL lnGroup_hd
LOCAL lnNon_verbal_feedback
LOCAL lnPolling
LOCAL lnPrivate_chat
LOCAL lnRecord_play_voice
LOCAL lnRemote_control
LOCAL lnRemote_support
LOCAL lnShow_meeting_control_toolbar
LOCAL lnVirtual_background
LOCAL lnWaiting_room
LOCAL lnShow_a_join_from_your_browser_link
LOCAL lnJoin_from_mobile
LOCAL lnJoin_from_desktop
LOCAL lnLive_streaming_facebook
LOCAL lnWorkplace_by_facebook
LOCAL lnLive_streaming_youtube
LOCAL lnCustom_live_streaming_service
LOCAL lnEnable
LOCAL lcCustom_service_instructions
LOCAL lnLive_streaming_reminder
LOCAL lnWebinar_chatEnable
LOCAL lnAllow_panelists_chat_with
LOCAL lnAllow_attendees_chat_with
LOCAL lnDefault_attendees_chat_with
LOCAL lnAllow_panelists_send_direct_message
LOCAL lnWebinar_chatAllow_users_save_chats
LOCAL lnAllow_auto_save_local_chat_file
LOCAL lnClosed_captioningEnable
LOCAL lnThird_party_captioning_service
LOCAL lnAuto_transcribing
LOCAL lnView_full_transcript
LOCAL lnSave_caption
LOCAL lnSlide_control
LOCAL lnMeeting_survey
LOCAL lnWebinar_pollingEnable
LOCAL lnAdvanced_polls
LOCAL lnWebinar_survey
LOCAL lnCloud_recording_available_reminder
LOCAL lnRecording_available_reminder_schedulers
LOCAL lnRecording_available_reminder_alternative_hosts
LOCAL lnJbh_reminder
LOCAL lnCancel_meeting_reminder
LOCAL lnAlternative_host_reminder
LOCAL lnSchedule_for_reminder
LOCAL lnAuto_delete_cmr
LOCAL lcAuto_recording
LOCAL lnCloud_recording
LOCAL lnLocal_recording
LOCAL lnRecord_audio_file
LOCAL lnRecord_gallery_view
LOCAL lnRecord_speaker_view
LOCAL lnRecording_audio_transcript
LOCAL lnRecording_password_requirementHave_letter
LOCAL lnRecording_password_requirementHave_number
LOCAL lnRecording_password_requirementHave_special_character
LOCAL lnRecording_password_requirementLength
LOCAL lnRecording_password_requirementOnly_allow_numeric
LOCAL lnSave_chat_text
LOCAL lnShow_timestamp
LOCAL lnThird_party_audio
LOCAL lcAudio_conference_info
LOCAL lnShow_international_numbers_link
LOCAL lnMeeting_capacity
LOCAL lnLarge_meeting
LOCAL lnWebinar
LOCAL lnCn_meeting
LOCAL lnIn_meeting
LOCAL lnZoom_phone
LOCAL lcConcurrent_meeting
LOCAL lnCall_out
LOCAL lnTspShow_international_numbers_link
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loQueryParams = CreateObject('Chilkat.JsonObject')
loQueryParams.UpdateInt("login_type",100)
loQueryParams.UpdateString("option","meeting_authentication")
loQueryParams.UpdateString("custom_query_fields","quis officia in reprehenderit")
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loResp = loHttp.QuickRequestParams("GET","https://api.zoom.us/v2/users/:userId/settings",loQueryParams)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loQueryParams
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcAudio_type = loJResp.StringOf("schedule_meeting.audio_type")
lnEmbed_password_in_join_link = loJResp.BoolOf("schedule_meeting.embed_password_in_join_link")
lnForce_pmi_jbh_password = loJResp.BoolOf("schedule_meeting.force_pmi_jbh_password")
lnHost_video = loJResp.BoolOf("schedule_meeting.host_video")
lnJoin_before_host = loJResp.BoolOf("schedule_meeting.join_before_host")
lnHave_letter = loJResp.BoolOf("schedule_meeting.meeting_password_requirement.have_letter")
lnHave_number = loJResp.BoolOf("schedule_meeting.meeting_password_requirement.have_number")
lnHave_special_character = loJResp.BoolOf("schedule_meeting.meeting_password_requirement.have_special_character")
lnLength = loJResp.IntOf("schedule_meeting.meeting_password_requirement.length")
lnOnly_allow_numeric = loJResp.BoolOf("schedule_meeting.meeting_password_requirement.only_allow_numeric")
lnNot_store_meeting_topic = loJResp.BoolOf("schedule_meeting.not_store_meeting_topic")
lnParticipants_video = loJResp.BoolOf("schedule_meeting.participants_video")
lcPmi_password = loJResp.StringOf("schedule_meeting.pmi_password")
lnPstn_password_protected = loJResp.BoolOf("schedule_meeting.pstn_password_protected")
lcRequire_password_for_pmi_meetings = loJResp.StringOf("schedule_meeting.require_password_for_pmi_meetings")
lnRequire_password_for_scheduling_new_meetings = loJResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings")
lnUse_pmi_for_instant_meetings = loJResp.BoolOf("schedule_meeting.use_pmi_for_instant_meetings")
lnUse_pmi_for_scheduled_meetings = loJResp.BoolOf("schedule_meeting.use_pmi_for_scheduled_meetings")
lnAllow_live_streaming = loJResp.BoolOf("in_meeting.allow_live_streaming")
lnAllow_host_to_enable_focus_mode = loJResp.BoolOf("in_meeting.allow_host_to_enable_focus_mode")
lnAttention_mode_focus_mode = loJResp.BoolOf("in_meeting.attention_mode_focus_mode")
lnAnnotation = loJResp.BoolOf("in_meeting.annotation")
lnAttendee_on_hold = loJResp.BoolOf("in_meeting.attendee_on_hold")
lnAuto_saving_chat = loJResp.BoolOf("in_meeting.auto_saving_chat")
lnBreakout_room = loJResp.BoolOf("in_meeting.breakout_room")
lnBreakout_room_schedule = loJResp.BoolOf("in_meeting.breakout_room_schedule")
lnChat = loJResp.BoolOf("in_meeting.chat")
lnAllow_participants_chat_with = loJResp.IntOf("in_meeting.allow_participants_chat_with")
lnAllow_users_save_chats = loJResp.IntOf("in_meeting.allow_users_save_chats")
lnClosed_caption = loJResp.BoolOf("in_meeting.closed_caption")
lnCo_host = loJResp.BoolOf("in_meeting.co_host")
lnCustom_data_center_regions = loJResp.BoolOf("in_meeting.custom_data_center_regions")
lnE2e_encryption = loJResp.BoolOf("in_meeting.e2e_encryption")
lcEntry_exit_chime = loJResp.StringOf("in_meeting.entry_exit_chime")
lnFar_end_camera_control = loJResp.BoolOf("in_meeting.far_end_camera_control")
lnFeedback = loJResp.BoolOf("in_meeting.feedback")
lnGroup_hd = loJResp.BoolOf("in_meeting.group_hd")
lnNon_verbal_feedback = loJResp.BoolOf("in_meeting.non_verbal_feedback")
lnPolling = loJResp.BoolOf("in_meeting.polling")
lnPrivate_chat = loJResp.BoolOf("in_meeting.private_chat")
lnRecord_play_voice = loJResp.BoolOf("in_meeting.record_play_voice")
lnRemote_control = loJResp.BoolOf("in_meeting.remote_control")
lnRemote_support = loJResp.BoolOf("in_meeting.remote_support")
lnShow_meeting_control_toolbar = loJResp.BoolOf("in_meeting.show_meeting_control_toolbar")
lnVirtual_background = loJResp.BoolOf("in_meeting.virtual_background")
lnWaiting_room = loJResp.BoolOf("in_meeting.waiting_room")
lnShow_a_join_from_your_browser_link = loJResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
lnJoin_from_mobile = loJResp.BoolOf("in_meeting.join_from_mobile")
lnJoin_from_desktop = loJResp.BoolOf("in_meeting.join_from_desktop")
lnLive_streaming_facebook = loJResp.BoolOf("in_meeting.live_streaming_facebook")
lnWorkplace_by_facebook = loJResp.BoolOf("in_meeting.workplace_by_facebook")
lnLive_streaming_youtube = loJResp.BoolOf("in_meeting.live_streaming_youtube")
lnCustom_live_streaming_service = loJResp.BoolOf("in_meeting.custom_live_streaming_service")
lnEnable = loJResp.BoolOf("in_meeting.webinar_live_streaming.enable")
lcCustom_service_instructions = loJResp.StringOf("in_meeting.webinar_live_streaming.custom_service_instructions")
lnLive_streaming_reminder = loJResp.BoolOf("in_meeting.webinar_live_streaming.live_streaming_reminder")
lnWebinar_chatEnable = loJResp.BoolOf("in_meeting.webinar_chat.enable")
lnAllow_panelists_chat_with = loJResp.IntOf("in_meeting.webinar_chat.allow_panelists_chat_with")
lnAllow_attendees_chat_with = loJResp.IntOf("in_meeting.webinar_chat.allow_attendees_chat_with")
lnDefault_attendees_chat_with = loJResp.IntOf("in_meeting.webinar_chat.default_attendees_chat_with")
lnAllow_panelists_send_direct_message = loJResp.BoolOf("in_meeting.webinar_chat.allow_panelists_send_direct_message")
lnWebinar_chatAllow_users_save_chats = loJResp.IntOf("in_meeting.webinar_chat.allow_users_save_chats")
lnAllow_auto_save_local_chat_file = loJResp.BoolOf("in_meeting.webinar_chat.allow_auto_save_local_chat_file")
lnClosed_captioningEnable = loJResp.BoolOf("in_meeting.closed_captioning.enable")
lnThird_party_captioning_service = loJResp.BoolOf("in_meeting.closed_captioning.third_party_captioning_service")
lnAuto_transcribing = loJResp.BoolOf("in_meeting.closed_captioning.auto_transcribing")
lnView_full_transcript = loJResp.BoolOf("in_meeting.closed_captioning.view_full_transcript")
lnSave_caption = loJResp.BoolOf("in_meeting.closed_captioning.save_caption")
lnSlide_control = loJResp.BoolOf("in_meeting.slide_control")
lnMeeting_survey = loJResp.BoolOf("in_meeting.meeting_survey")
lnWebinar_pollingEnable = loJResp.BoolOf("in_meeting.webinar_polling.enable")
lnAdvanced_polls = loJResp.BoolOf("in_meeting.webinar_polling.advanced_polls")
lnWebinar_survey = loJResp.BoolOf("in_meeting.webinar_survey")
lnCloud_recording_available_reminder = loJResp.BoolOf("email_notification.cloud_recording_available_reminder")
lnRecording_available_reminder_schedulers = loJResp.BoolOf("email_notification.recording_available_reminder_schedulers")
lnRecording_available_reminder_alternative_hosts = loJResp.BoolOf("email_notification.recording_available_reminder_alternative_hosts")
lnJbh_reminder = loJResp.BoolOf("email_notification.jbh_reminder")
lnCancel_meeting_reminder = loJResp.BoolOf("email_notification.cancel_meeting_reminder")
lnAlternative_host_reminder = loJResp.BoolOf("email_notification.alternative_host_reminder")
lnSchedule_for_reminder = loJResp.BoolOf("email_notification.schedule_for_reminder")
lnAuto_delete_cmr = loJResp.BoolOf("recording.auto_delete_cmr")
lcAuto_recording = loJResp.StringOf("recording.auto_recording")
lnCloud_recording = loJResp.BoolOf("recording.cloud_recording")
lnLocal_recording = loJResp.BoolOf("recording.local_recording")
lnRecord_audio_file = loJResp.BoolOf("recording.record_audio_file")
lnRecord_gallery_view = loJResp.BoolOf("recording.record_gallery_view")
lnRecord_speaker_view = loJResp.BoolOf("recording.record_speaker_view")
lnRecording_audio_transcript = loJResp.BoolOf("recording.recording_audio_transcript")
lnRecording_password_requirementHave_letter = loJResp.BoolOf("recording.recording_password_requirement.have_letter")
lnRecording_password_requirementHave_number = loJResp.BoolOf("recording.recording_password_requirement.have_number")
lnRecording_password_requirementHave_special_character = loJResp.BoolOf("recording.recording_password_requirement.have_special_character")
lnRecording_password_requirementLength = loJResp.IntOf("recording.recording_password_requirement.length")
lnRecording_password_requirementOnly_allow_numeric = loJResp.BoolOf("recording.recording_password_requirement.only_allow_numeric")
lnSave_chat_text = loJResp.BoolOf("recording.save_chat_text")
lnShow_timestamp = loJResp.BoolOf("recording.show_timestamp")
lnThird_party_audio = loJResp.BoolOf("telephony.third_party_audio")
lcAudio_conference_info = loJResp.StringOf("telephony.audio_conference_info")
lnShow_international_numbers_link = loJResp.BoolOf("telephony.show_international_numbers_link")
lnMeeting_capacity = loJResp.IntOf("feature.meeting_capacity")
lnLarge_meeting = loJResp.BoolOf("feature.large_meeting")
lnWebinar = loJResp.BoolOf("feature.webinar")
lnCn_meeting = loJResp.BoolOf("feature.cn_meeting")
lnIn_meeting = loJResp.BoolOf("feature.in_meeting")
lnZoom_phone = loJResp.BoolOf("feature.zoom_phone")
lcConcurrent_meeting = loJResp.StringOf("feature.concurrent_meeting")
lnCall_out = loJResp.BoolOf("tsp.call_out")
lnTspShow_international_numbers_link = loJResp.BoolOf("tsp.show_international_numbers_link")
i = 0
lnCount_i = loJResp.SizeOfArray("in_meeting.data_center_regions")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("in_meeting.data_center_regions[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("in_meeting.webinar_live_streaming.live_streaming_service")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("in_meeting.webinar_live_streaming.live_streaming_service[i]")
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("tsp.call_out_countries")
DO WHILE i < lnCount_i
loJResp.I = i
lcStrVal = loJResp.StringOf("tsp.call_out_countries[i]")
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loQueryParams
RELEASE loSbResponseBody
RELEASE loJResp
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": ""
}
]
}
