PowerBuilder / Zoom API / Get user settings
Back to Collection Items
integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp
oleobject loo_SbResponseBody
oleobject loo_JResp
integer li_RespStatusCode
string ls_StrVal
string ls_Audio_type
integer li_Embed_password_in_join_link
integer li_Force_pmi_jbh_password
integer li_Host_video
integer li_Join_before_host
integer li_Have_letter
integer li_Have_number
integer li_Have_special_character
integer li_Length
integer li_Only_allow_numeric
integer li_Not_store_meeting_topic
integer li_Participants_video
string ls_Pmi_password
integer li_Pstn_password_protected
string ls_Require_password_for_pmi_meetings
integer li_Require_password_for_scheduling_new_meetings
integer li_Use_pmi_for_instant_meetings
integer li_Use_pmi_for_scheduled_meetings
integer li_Allow_live_streaming
integer li_Allow_host_to_enable_focus_mode
integer li_Attention_mode_focus_mode
integer li_Annotation
integer li_Attendee_on_hold
integer li_Auto_saving_chat
integer li_Breakout_room
integer li_Breakout_room_schedule
integer li_Chat
integer li_Allow_participants_chat_with
integer li_Allow_users_save_chats
integer li_Closed_caption
integer li_Co_host
integer li_Custom_data_center_regions
integer li_E2e_encryption
string ls_Entry_exit_chime
integer li_Far_end_camera_control
integer li_Feedback
integer li_Group_hd
integer li_Non_verbal_feedback
integer li_Polling
integer li_Private_chat
integer li_Record_play_voice
integer li_Remote_control
integer li_Remote_support
integer li_Show_meeting_control_toolbar
integer li_Virtual_background
integer li_Waiting_room
integer li_Show_a_join_from_your_browser_link
integer li_Join_from_mobile
integer li_Join_from_desktop
integer li_Live_streaming_facebook
integer li_Workplace_by_facebook
integer li_Live_streaming_youtube
integer li_Custom_live_streaming_service
integer li_Enable
string ls_Custom_service_instructions
integer li_Live_streaming_reminder
integer li_Webinar_chatEnable
integer li_Allow_panelists_chat_with
integer li_Allow_attendees_chat_with
integer li_Default_attendees_chat_with
integer li_Allow_panelists_send_direct_message
integer li_Webinar_chatAllow_users_save_chats
integer li_Allow_auto_save_local_chat_file
integer li_Closed_captioningEnable
integer li_Third_party_captioning_service
integer li_Auto_transcribing
integer li_View_full_transcript
integer li_Save_caption
integer li_Slide_control
integer li_Meeting_survey
integer li_Webinar_pollingEnable
integer li_Advanced_polls
integer li_Webinar_survey
integer li_Cloud_recording_available_reminder
integer li_Recording_available_reminder_schedulers
integer li_Recording_available_reminder_alternative_hosts
integer li_Jbh_reminder
integer li_Cancel_meeting_reminder
integer li_Alternative_host_reminder
integer li_Schedule_for_reminder
integer li_Auto_delete_cmr
string ls_Auto_recording
integer li_Cloud_recording
integer li_Local_recording
integer li_Record_audio_file
integer li_Record_gallery_view
integer li_Record_speaker_view
integer li_Recording_audio_transcript
integer li_Recording_password_requirementHave_letter
integer li_Recording_password_requirementHave_number
integer li_Recording_password_requirementHave_special_character
integer li_Recording_password_requirementLength
integer li_Recording_password_requirementOnly_allow_numeric
integer li_Save_chat_text
integer li_Show_timestamp
integer li_Third_party_audio
string ls_Audio_conference_info
integer li_Show_international_numbers_link
integer li_Meeting_capacity
integer li_Large_meeting
integer li_Webinar
integer li_Cn_meeting
integer li_In_meeting
integer li_Zoom_phone
string ls_Concurrent_meeting
integer li_Call_out
integer li_TspShow_international_numbers_link
integer i
integer li_Count_i
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
destroy loo_Http
MessageBox("Error","Connecting to COM object failed")
return
end if
loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")
loo_QueryParams.UpdateInt("login_type",100)
loo_QueryParams.UpdateString("option","meeting_authentication")
loo_QueryParams.UpdateString("custom_query_fields","quis officia in reprehenderit")
// Adds the "Authorization: Bearer <access_token>" header.
loo_Http.AuthToken = "<access_token>"
loo_Resp = loo_Http.QuickRequestParams("GET","https://api.zoom.us/v2/users/:userId/settings",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
Write-Debug loo_Http.LastErrorText
destroy loo_Http
destroy loo_QueryParams
return
end if
loo_SbResponseBody = create oleobject
// Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
li_rc = loo_SbResponseBody.ConnectToNewObject("Chilkat.StringBuilder")
loo_Resp.GetBodySb(loo_SbResponseBody)
loo_JResp = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_JResp.ConnectToNewObject("Chilkat.JsonObject")
loo_JResp.LoadSb(loo_SbResponseBody)
loo_JResp.EmitCompact = 0
Write-Debug "Response Body:"
Write-Debug loo_JResp.Emit()
li_RespStatusCode = loo_Resp.StatusCode
Write-Debug "Response Status Code = " + string(li_RespStatusCode)
if li_RespStatusCode >= 400 then
Write-Debug "Response Header:"
Write-Debug loo_Resp.Header
Write-Debug "Failed."
destroy loo_Resp
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
return
end if
destroy loo_Resp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "schedule_meeting": {
// "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
ls_Audio_type = loo_JResp.StringOf("schedule_meeting.audio_type")
li_Embed_password_in_join_link = loo_JResp.BoolOf("schedule_meeting.embed_password_in_join_link")
li_Force_pmi_jbh_password = loo_JResp.BoolOf("schedule_meeting.force_pmi_jbh_password")
li_Host_video = loo_JResp.BoolOf("schedule_meeting.host_video")
li_Join_before_host = loo_JResp.BoolOf("schedule_meeting.join_before_host")
li_Have_letter = loo_JResp.BoolOf("schedule_meeting.meeting_password_requirement.have_letter")
li_Have_number = loo_JResp.BoolOf("schedule_meeting.meeting_password_requirement.have_number")
li_Have_special_character = loo_JResp.BoolOf("schedule_meeting.meeting_password_requirement.have_special_character")
li_Length = loo_JResp.IntOf("schedule_meeting.meeting_password_requirement.length")
li_Only_allow_numeric = loo_JResp.BoolOf("schedule_meeting.meeting_password_requirement.only_allow_numeric")
li_Not_store_meeting_topic = loo_JResp.BoolOf("schedule_meeting.not_store_meeting_topic")
li_Participants_video = loo_JResp.BoolOf("schedule_meeting.participants_video")
ls_Pmi_password = loo_JResp.StringOf("schedule_meeting.pmi_password")
li_Pstn_password_protected = loo_JResp.BoolOf("schedule_meeting.pstn_password_protected")
ls_Require_password_for_pmi_meetings = loo_JResp.StringOf("schedule_meeting.require_password_for_pmi_meetings")
li_Require_password_for_scheduling_new_meetings = loo_JResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings")
li_Use_pmi_for_instant_meetings = loo_JResp.BoolOf("schedule_meeting.use_pmi_for_instant_meetings")
li_Use_pmi_for_scheduled_meetings = loo_JResp.BoolOf("schedule_meeting.use_pmi_for_scheduled_meetings")
li_Allow_live_streaming = loo_JResp.BoolOf("in_meeting.allow_live_streaming")
li_Allow_host_to_enable_focus_mode = loo_JResp.BoolOf("in_meeting.allow_host_to_enable_focus_mode")
li_Attention_mode_focus_mode = loo_JResp.BoolOf("in_meeting.attention_mode_focus_mode")
li_Annotation = loo_JResp.BoolOf("in_meeting.annotation")
li_Attendee_on_hold = loo_JResp.BoolOf("in_meeting.attendee_on_hold")
li_Auto_saving_chat = loo_JResp.BoolOf("in_meeting.auto_saving_chat")
li_Breakout_room = loo_JResp.BoolOf("in_meeting.breakout_room")
li_Breakout_room_schedule = loo_JResp.BoolOf("in_meeting.breakout_room_schedule")
li_Chat = loo_JResp.BoolOf("in_meeting.chat")
li_Allow_participants_chat_with = loo_JResp.IntOf("in_meeting.allow_participants_chat_with")
li_Allow_users_save_chats = loo_JResp.IntOf("in_meeting.allow_users_save_chats")
li_Closed_caption = loo_JResp.BoolOf("in_meeting.closed_caption")
li_Co_host = loo_JResp.BoolOf("in_meeting.co_host")
li_Custom_data_center_regions = loo_JResp.BoolOf("in_meeting.custom_data_center_regions")
li_E2e_encryption = loo_JResp.BoolOf("in_meeting.e2e_encryption")
ls_Entry_exit_chime = loo_JResp.StringOf("in_meeting.entry_exit_chime")
li_Far_end_camera_control = loo_JResp.BoolOf("in_meeting.far_end_camera_control")
li_Feedback = loo_JResp.BoolOf("in_meeting.feedback")
li_Group_hd = loo_JResp.BoolOf("in_meeting.group_hd")
li_Non_verbal_feedback = loo_JResp.BoolOf("in_meeting.non_verbal_feedback")
li_Polling = loo_JResp.BoolOf("in_meeting.polling")
li_Private_chat = loo_JResp.BoolOf("in_meeting.private_chat")
li_Record_play_voice = loo_JResp.BoolOf("in_meeting.record_play_voice")
li_Remote_control = loo_JResp.BoolOf("in_meeting.remote_control")
li_Remote_support = loo_JResp.BoolOf("in_meeting.remote_support")
li_Show_meeting_control_toolbar = loo_JResp.BoolOf("in_meeting.show_meeting_control_toolbar")
li_Virtual_background = loo_JResp.BoolOf("in_meeting.virtual_background")
li_Waiting_room = loo_JResp.BoolOf("in_meeting.waiting_room")
li_Show_a_join_from_your_browser_link = loo_JResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
li_Join_from_mobile = loo_JResp.BoolOf("in_meeting.join_from_mobile")
li_Join_from_desktop = loo_JResp.BoolOf("in_meeting.join_from_desktop")
li_Live_streaming_facebook = loo_JResp.BoolOf("in_meeting.live_streaming_facebook")
li_Workplace_by_facebook = loo_JResp.BoolOf("in_meeting.workplace_by_facebook")
li_Live_streaming_youtube = loo_JResp.BoolOf("in_meeting.live_streaming_youtube")
li_Custom_live_streaming_service = loo_JResp.BoolOf("in_meeting.custom_live_streaming_service")
li_Enable = loo_JResp.BoolOf("in_meeting.webinar_live_streaming.enable")
ls_Custom_service_instructions = loo_JResp.StringOf("in_meeting.webinar_live_streaming.custom_service_instructions")
li_Live_streaming_reminder = loo_JResp.BoolOf("in_meeting.webinar_live_streaming.live_streaming_reminder")
li_Webinar_chatEnable = loo_JResp.BoolOf("in_meeting.webinar_chat.enable")
li_Allow_panelists_chat_with = loo_JResp.IntOf("in_meeting.webinar_chat.allow_panelists_chat_with")
li_Allow_attendees_chat_with = loo_JResp.IntOf("in_meeting.webinar_chat.allow_attendees_chat_with")
li_Default_attendees_chat_with = loo_JResp.IntOf("in_meeting.webinar_chat.default_attendees_chat_with")
li_Allow_panelists_send_direct_message = loo_JResp.BoolOf("in_meeting.webinar_chat.allow_panelists_send_direct_message")
li_Webinar_chatAllow_users_save_chats = loo_JResp.IntOf("in_meeting.webinar_chat.allow_users_save_chats")
li_Allow_auto_save_local_chat_file = loo_JResp.BoolOf("in_meeting.webinar_chat.allow_auto_save_local_chat_file")
li_Closed_captioningEnable = loo_JResp.BoolOf("in_meeting.closed_captioning.enable")
li_Third_party_captioning_service = loo_JResp.BoolOf("in_meeting.closed_captioning.third_party_captioning_service")
li_Auto_transcribing = loo_JResp.BoolOf("in_meeting.closed_captioning.auto_transcribing")
li_View_full_transcript = loo_JResp.BoolOf("in_meeting.closed_captioning.view_full_transcript")
li_Save_caption = loo_JResp.BoolOf("in_meeting.closed_captioning.save_caption")
li_Slide_control = loo_JResp.BoolOf("in_meeting.slide_control")
li_Meeting_survey = loo_JResp.BoolOf("in_meeting.meeting_survey")
li_Webinar_pollingEnable = loo_JResp.BoolOf("in_meeting.webinar_polling.enable")
li_Advanced_polls = loo_JResp.BoolOf("in_meeting.webinar_polling.advanced_polls")
li_Webinar_survey = loo_JResp.BoolOf("in_meeting.webinar_survey")
li_Cloud_recording_available_reminder = loo_JResp.BoolOf("email_notification.cloud_recording_available_reminder")
li_Recording_available_reminder_schedulers = loo_JResp.BoolOf("email_notification.recording_available_reminder_schedulers")
li_Recording_available_reminder_alternative_hosts = loo_JResp.BoolOf("email_notification.recording_available_reminder_alternative_hosts")
li_Jbh_reminder = loo_JResp.BoolOf("email_notification.jbh_reminder")
li_Cancel_meeting_reminder = loo_JResp.BoolOf("email_notification.cancel_meeting_reminder")
li_Alternative_host_reminder = loo_JResp.BoolOf("email_notification.alternative_host_reminder")
li_Schedule_for_reminder = loo_JResp.BoolOf("email_notification.schedule_for_reminder")
li_Auto_delete_cmr = loo_JResp.BoolOf("recording.auto_delete_cmr")
ls_Auto_recording = loo_JResp.StringOf("recording.auto_recording")
li_Cloud_recording = loo_JResp.BoolOf("recording.cloud_recording")
li_Local_recording = loo_JResp.BoolOf("recording.local_recording")
li_Record_audio_file = loo_JResp.BoolOf("recording.record_audio_file")
li_Record_gallery_view = loo_JResp.BoolOf("recording.record_gallery_view")
li_Record_speaker_view = loo_JResp.BoolOf("recording.record_speaker_view")
li_Recording_audio_transcript = loo_JResp.BoolOf("recording.recording_audio_transcript")
li_Recording_password_requirementHave_letter = loo_JResp.BoolOf("recording.recording_password_requirement.have_letter")
li_Recording_password_requirementHave_number = loo_JResp.BoolOf("recording.recording_password_requirement.have_number")
li_Recording_password_requirementHave_special_character = loo_JResp.BoolOf("recording.recording_password_requirement.have_special_character")
li_Recording_password_requirementLength = loo_JResp.IntOf("recording.recording_password_requirement.length")
li_Recording_password_requirementOnly_allow_numeric = loo_JResp.BoolOf("recording.recording_password_requirement.only_allow_numeric")
li_Save_chat_text = loo_JResp.BoolOf("recording.save_chat_text")
li_Show_timestamp = loo_JResp.BoolOf("recording.show_timestamp")
li_Third_party_audio = loo_JResp.BoolOf("telephony.third_party_audio")
ls_Audio_conference_info = loo_JResp.StringOf("telephony.audio_conference_info")
li_Show_international_numbers_link = loo_JResp.BoolOf("telephony.show_international_numbers_link")
li_Meeting_capacity = loo_JResp.IntOf("feature.meeting_capacity")
li_Large_meeting = loo_JResp.BoolOf("feature.large_meeting")
li_Webinar = loo_JResp.BoolOf("feature.webinar")
li_Cn_meeting = loo_JResp.BoolOf("feature.cn_meeting")
li_In_meeting = loo_JResp.BoolOf("feature.in_meeting")
li_Zoom_phone = loo_JResp.BoolOf("feature.zoom_phone")
ls_Concurrent_meeting = loo_JResp.StringOf("feature.concurrent_meeting")
li_Call_out = loo_JResp.BoolOf("tsp.call_out")
li_TspShow_international_numbers_link = loo_JResp.BoolOf("tsp.show_international_numbers_link")
i = 0
li_Count_i = loo_JResp.SizeOfArray("in_meeting.data_center_regions")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("in_meeting.data_center_regions[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("in_meeting.webinar_live_streaming.live_streaming_service")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("in_meeting.webinar_live_streaming.live_streaming_service[i]")
i = i + 1
loop
i = 0
li_Count_i = loo_JResp.SizeOfArray("tsp.call_out_countries")
do while i < li_Count_i
loo_JResp.I = i
ls_StrVal = loo_JResp.StringOf("tsp.call_out_countries[i]")
i = i + 1
loop
destroy loo_Http
destroy loo_QueryParams
destroy loo_SbResponseBody
destroy loo_JResp
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": ""
}
]
}
