DataFlex / Zoom API / Get user settings
Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vQueryParams
Handle hoQueryParams
Variant vResp
Handle hoResp
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sStrVal
String sAudio_type
Boolean iEmbed_password_in_join_link
Boolean iForce_pmi_jbh_password
Boolean iHost_video
Boolean iJoin_before_host
Boolean iHave_letter
Boolean iHave_number
Boolean iHave_special_character
Integer iLength
Boolean iOnly_allow_numeric
Boolean iNot_store_meeting_topic
Boolean iParticipants_video
String sPmi_password
Boolean iPstn_password_protected
String sRequire_password_for_pmi_meetings
Boolean iRequire_password_for_scheduling_new_meetings
Boolean iUse_pmi_for_instant_meetings
Boolean iUse_pmi_for_scheduled_meetings
Boolean iAllow_live_streaming
Boolean iAllow_host_to_enable_focus_mode
Boolean iAttention_mode_focus_mode
Boolean iAnnotation
Boolean iAttendee_on_hold
Boolean iAuto_saving_chat
Boolean iBreakout_room
Boolean iBreakout_room_schedule
Boolean iChat
Integer iAllow_participants_chat_with
Integer iAllow_users_save_chats
Boolean iClosed_caption
Boolean iCo_host
Boolean iCustom_data_center_regions
Boolean iE2e_encryption
String sEntry_exit_chime
Boolean iFar_end_camera_control
Boolean iFeedback
Boolean iGroup_hd
Boolean iNon_verbal_feedback
Boolean iPolling
Boolean iPrivate_chat
Boolean iRecord_play_voice
Boolean iRemote_control
Boolean iRemote_support
Boolean iShow_meeting_control_toolbar
Boolean iVirtual_background
Boolean iWaiting_room
Boolean iShow_a_join_from_your_browser_link
Boolean iJoin_from_mobile
Boolean iJoin_from_desktop
Boolean iLive_streaming_facebook
Boolean iWorkplace_by_facebook
Boolean iLive_streaming_youtube
Boolean iCustom_live_streaming_service
Boolean iEnable
String sCustom_service_instructions
Boolean iLive_streaming_reminder
Boolean iWebinar_chatEnable
Integer iAllow_panelists_chat_with
Integer iAllow_attendees_chat_with
Integer iDefault_attendees_chat_with
Boolean iAllow_panelists_send_direct_message
Integer iWebinar_chatAllow_users_save_chats
Boolean iAllow_auto_save_local_chat_file
Boolean iClosed_captioningEnable
Boolean iThird_party_captioning_service
Boolean iAuto_transcribing
Boolean iView_full_transcript
Boolean iSave_caption
Boolean iSlide_control
Boolean iMeeting_survey
Boolean iWebinar_pollingEnable
Boolean iAdvanced_polls
Boolean iWebinar_survey
Boolean iCloud_recording_available_reminder
Boolean iRecording_available_reminder_schedulers
Boolean iRecording_available_reminder_alternative_hosts
Boolean iJbh_reminder
Boolean iCancel_meeting_reminder
Boolean iAlternative_host_reminder
Boolean iSchedule_for_reminder
Boolean iAuto_delete_cmr
String sAuto_recording
Boolean iCloud_recording
Boolean iLocal_recording
Boolean iRecord_audio_file
Boolean iRecord_gallery_view
Boolean iRecord_speaker_view
Boolean iRecording_audio_transcript
Boolean iRecording_password_requirementHave_letter
Boolean iRecording_password_requirementHave_number
Boolean iRecording_password_requirementHave_special_character
Integer iRecording_password_requirementLength
Boolean iRecording_password_requirementOnly_allow_numeric
Boolean iSave_chat_text
Boolean iShow_timestamp
Boolean iThird_party_audio
String sAudio_conference_info
Boolean iShow_international_numbers_link
Integer iMeeting_capacity
Boolean iLarge_meeting
Boolean iWebinar
Boolean iCn_meeting
Boolean iIn_meeting
Boolean iZoom_phone
String sConcurrent_meeting
Boolean iCall_out
Boolean iTspShow_international_numbers_link
Integer i
Integer iCount_i
String sTemp1
Boolean bTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
Get Create (RefClass(cComChilkatJsonObject)) To hoQueryParams
If (Not(IsComObjectCreated(hoQueryParams))) Begin
Send CreateComObject of hoQueryParams
End
Get ComUpdateInt Of hoQueryParams "login_type" 100 To iSuccess
Get ComUpdateString Of hoQueryParams "option" "meeting_authentication" To iSuccess
Get ComUpdateString Of hoQueryParams "custom_query_fields" "quis officia in reprehenderit" To iSuccess
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get pvComObject of hoQueryParams to vQueryParams
Get ComQuickRequestParams Of hoHttp "GET" "https://api.zoom.us/v2/users/:userId/settings" vQueryParams To vResp
If (IsComObject(vResp)) Begin
Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
Set pvComObject Of hoResp To vResp
End
Get ComLastMethodSuccess Of hoHttp To bTemp1
If (bTemp1 = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComGetBodySb Of hoResp vSbResponseBody To iSuccess
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComStatusCode Of hoResp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComHeader Of hoResp To sTemp1
Showln sTemp1
Showln "Failed."
Send Destroy of hoResp
Procedure_Return
End
Send Destroy of hoResp
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "schedule_meeting": {
// "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
Get ComStringOf Of hoJResp "schedule_meeting.audio_type" To sAudio_type
Get ComBoolOf Of hoJResp "schedule_meeting.embed_password_in_join_link" To iEmbed_password_in_join_link
Get ComBoolOf Of hoJResp "schedule_meeting.force_pmi_jbh_password" To iForce_pmi_jbh_password
Get ComBoolOf Of hoJResp "schedule_meeting.host_video" To iHost_video
Get ComBoolOf Of hoJResp "schedule_meeting.join_before_host" To iJoin_before_host
Get ComBoolOf Of hoJResp "schedule_meeting.meeting_password_requirement.have_letter" To iHave_letter
Get ComBoolOf Of hoJResp "schedule_meeting.meeting_password_requirement.have_number" To iHave_number
Get ComBoolOf Of hoJResp "schedule_meeting.meeting_password_requirement.have_special_character" To iHave_special_character
Get ComIntOf Of hoJResp "schedule_meeting.meeting_password_requirement.length" To iLength
Get ComBoolOf Of hoJResp "schedule_meeting.meeting_password_requirement.only_allow_numeric" To iOnly_allow_numeric
Get ComBoolOf Of hoJResp "schedule_meeting.not_store_meeting_topic" To iNot_store_meeting_topic
Get ComBoolOf Of hoJResp "schedule_meeting.participants_video" To iParticipants_video
Get ComStringOf Of hoJResp "schedule_meeting.pmi_password" To sPmi_password
Get ComBoolOf Of hoJResp "schedule_meeting.pstn_password_protected" To iPstn_password_protected
Get ComStringOf Of hoJResp "schedule_meeting.require_password_for_pmi_meetings" To sRequire_password_for_pmi_meetings
Get ComBoolOf Of hoJResp "schedule_meeting.require_password_for_scheduling_new_meetings" To iRequire_password_for_scheduling_new_meetings
Get ComBoolOf Of hoJResp "schedule_meeting.use_pmi_for_instant_meetings" To iUse_pmi_for_instant_meetings
Get ComBoolOf Of hoJResp "schedule_meeting.use_pmi_for_scheduled_meetings" To iUse_pmi_for_scheduled_meetings
Get ComBoolOf Of hoJResp "in_meeting.allow_live_streaming" To iAllow_live_streaming
Get ComBoolOf Of hoJResp "in_meeting.allow_host_to_enable_focus_mode" To iAllow_host_to_enable_focus_mode
Get ComBoolOf Of hoJResp "in_meeting.attention_mode_focus_mode" To iAttention_mode_focus_mode
Get ComBoolOf Of hoJResp "in_meeting.annotation" To iAnnotation
Get ComBoolOf Of hoJResp "in_meeting.attendee_on_hold" To iAttendee_on_hold
Get ComBoolOf Of hoJResp "in_meeting.auto_saving_chat" To iAuto_saving_chat
Get ComBoolOf Of hoJResp "in_meeting.breakout_room" To iBreakout_room
Get ComBoolOf Of hoJResp "in_meeting.breakout_room_schedule" To iBreakout_room_schedule
Get ComBoolOf Of hoJResp "in_meeting.chat" To iChat
Get ComIntOf Of hoJResp "in_meeting.allow_participants_chat_with" To iAllow_participants_chat_with
Get ComIntOf Of hoJResp "in_meeting.allow_users_save_chats" To iAllow_users_save_chats
Get ComBoolOf Of hoJResp "in_meeting.closed_caption" To iClosed_caption
Get ComBoolOf Of hoJResp "in_meeting.co_host" To iCo_host
Get ComBoolOf Of hoJResp "in_meeting.custom_data_center_regions" To iCustom_data_center_regions
Get ComBoolOf Of hoJResp "in_meeting.e2e_encryption" To iE2e_encryption
Get ComStringOf Of hoJResp "in_meeting.entry_exit_chime" To sEntry_exit_chime
Get ComBoolOf Of hoJResp "in_meeting.far_end_camera_control" To iFar_end_camera_control
Get ComBoolOf Of hoJResp "in_meeting.feedback" To iFeedback
Get ComBoolOf Of hoJResp "in_meeting.group_hd" To iGroup_hd
Get ComBoolOf Of hoJResp "in_meeting.non_verbal_feedback" To iNon_verbal_feedback
Get ComBoolOf Of hoJResp "in_meeting.polling" To iPolling
Get ComBoolOf Of hoJResp "in_meeting.private_chat" To iPrivate_chat
Get ComBoolOf Of hoJResp "in_meeting.record_play_voice" To iRecord_play_voice
Get ComBoolOf Of hoJResp "in_meeting.remote_control" To iRemote_control
Get ComBoolOf Of hoJResp "in_meeting.remote_support" To iRemote_support
Get ComBoolOf Of hoJResp "in_meeting.show_meeting_control_toolbar" To iShow_meeting_control_toolbar
Get ComBoolOf Of hoJResp "in_meeting.virtual_background" To iVirtual_background
Get ComBoolOf Of hoJResp "in_meeting.waiting_room" To iWaiting_room
Get ComBoolOf Of hoJResp "in_meeting.show_a_join_from_your_browser_link" To iShow_a_join_from_your_browser_link
Get ComBoolOf Of hoJResp "in_meeting.join_from_mobile" To iJoin_from_mobile
Get ComBoolOf Of hoJResp "in_meeting.join_from_desktop" To iJoin_from_desktop
Get ComBoolOf Of hoJResp "in_meeting.live_streaming_facebook" To iLive_streaming_facebook
Get ComBoolOf Of hoJResp "in_meeting.workplace_by_facebook" To iWorkplace_by_facebook
Get ComBoolOf Of hoJResp "in_meeting.live_streaming_youtube" To iLive_streaming_youtube
Get ComBoolOf Of hoJResp "in_meeting.custom_live_streaming_service" To iCustom_live_streaming_service
Get ComBoolOf Of hoJResp "in_meeting.webinar_live_streaming.enable" To iEnable
Get ComStringOf Of hoJResp "in_meeting.webinar_live_streaming.custom_service_instructions" To sCustom_service_instructions
Get ComBoolOf Of hoJResp "in_meeting.webinar_live_streaming.live_streaming_reminder" To iLive_streaming_reminder
Get ComBoolOf Of hoJResp "in_meeting.webinar_chat.enable" To iWebinar_chatEnable
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.allow_panelists_chat_with" To iAllow_panelists_chat_with
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.allow_attendees_chat_with" To iAllow_attendees_chat_with
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.default_attendees_chat_with" To iDefault_attendees_chat_with
Get ComBoolOf Of hoJResp "in_meeting.webinar_chat.allow_panelists_send_direct_message" To iAllow_panelists_send_direct_message
Get ComIntOf Of hoJResp "in_meeting.webinar_chat.allow_users_save_chats" To iWebinar_chatAllow_users_save_chats
Get ComBoolOf Of hoJResp "in_meeting.webinar_chat.allow_auto_save_local_chat_file" To iAllow_auto_save_local_chat_file
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.enable" To iClosed_captioningEnable
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.third_party_captioning_service" To iThird_party_captioning_service
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.auto_transcribing" To iAuto_transcribing
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.view_full_transcript" To iView_full_transcript
Get ComBoolOf Of hoJResp "in_meeting.closed_captioning.save_caption" To iSave_caption
Get ComBoolOf Of hoJResp "in_meeting.slide_control" To iSlide_control
Get ComBoolOf Of hoJResp "in_meeting.meeting_survey" To iMeeting_survey
Get ComBoolOf Of hoJResp "in_meeting.webinar_polling.enable" To iWebinar_pollingEnable
Get ComBoolOf Of hoJResp "in_meeting.webinar_polling.advanced_polls" To iAdvanced_polls
Get ComBoolOf Of hoJResp "in_meeting.webinar_survey" To iWebinar_survey
Get ComBoolOf Of hoJResp "email_notification.cloud_recording_available_reminder" To iCloud_recording_available_reminder
Get ComBoolOf Of hoJResp "email_notification.recording_available_reminder_schedulers" To iRecording_available_reminder_schedulers
Get ComBoolOf Of hoJResp "email_notification.recording_available_reminder_alternative_hosts" To iRecording_available_reminder_alternative_hosts
Get ComBoolOf Of hoJResp "email_notification.jbh_reminder" To iJbh_reminder
Get ComBoolOf Of hoJResp "email_notification.cancel_meeting_reminder" To iCancel_meeting_reminder
Get ComBoolOf Of hoJResp "email_notification.alternative_host_reminder" To iAlternative_host_reminder
Get ComBoolOf Of hoJResp "email_notification.schedule_for_reminder" To iSchedule_for_reminder
Get ComBoolOf Of hoJResp "recording.auto_delete_cmr" To iAuto_delete_cmr
Get ComStringOf Of hoJResp "recording.auto_recording" To sAuto_recording
Get ComBoolOf Of hoJResp "recording.cloud_recording" To iCloud_recording
Get ComBoolOf Of hoJResp "recording.local_recording" To iLocal_recording
Get ComBoolOf Of hoJResp "recording.record_audio_file" To iRecord_audio_file
Get ComBoolOf Of hoJResp "recording.record_gallery_view" To iRecord_gallery_view
Get ComBoolOf Of hoJResp "recording.record_speaker_view" To iRecord_speaker_view
Get ComBoolOf Of hoJResp "recording.recording_audio_transcript" To iRecording_audio_transcript
Get ComBoolOf Of hoJResp "recording.recording_password_requirement.have_letter" To iRecording_password_requirementHave_letter
Get ComBoolOf Of hoJResp "recording.recording_password_requirement.have_number" To iRecording_password_requirementHave_number
Get ComBoolOf Of hoJResp "recording.recording_password_requirement.have_special_character" To iRecording_password_requirementHave_special_character
Get ComIntOf Of hoJResp "recording.recording_password_requirement.length" To iRecording_password_requirementLength
Get ComBoolOf Of hoJResp "recording.recording_password_requirement.only_allow_numeric" To iRecording_password_requirementOnly_allow_numeric
Get ComBoolOf Of hoJResp "recording.save_chat_text" To iSave_chat_text
Get ComBoolOf Of hoJResp "recording.show_timestamp" To iShow_timestamp
Get ComBoolOf Of hoJResp "telephony.third_party_audio" To iThird_party_audio
Get ComStringOf Of hoJResp "telephony.audio_conference_info" To sAudio_conference_info
Get ComBoolOf Of hoJResp "telephony.show_international_numbers_link" To iShow_international_numbers_link
Get ComIntOf Of hoJResp "feature.meeting_capacity" To iMeeting_capacity
Get ComBoolOf Of hoJResp "feature.large_meeting" To iLarge_meeting
Get ComBoolOf Of hoJResp "feature.webinar" To iWebinar
Get ComBoolOf Of hoJResp "feature.cn_meeting" To iCn_meeting
Get ComBoolOf Of hoJResp "feature.in_meeting" To iIn_meeting
Get ComBoolOf Of hoJResp "feature.zoom_phone" To iZoom_phone
Get ComStringOf Of hoJResp "feature.concurrent_meeting" To sConcurrent_meeting
Get ComBoolOf Of hoJResp "tsp.call_out" To iCall_out
Get ComBoolOf Of hoJResp "tsp.show_international_numbers_link" To iTspShow_international_numbers_link
Move 0 To i
Get ComSizeOfArray Of hoJResp "in_meeting.data_center_regions" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "in_meeting.data_center_regions[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "in_meeting.webinar_live_streaming.live_streaming_service" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "in_meeting.webinar_live_streaming.live_streaming_service[i]" To sStrVal
Move (i + 1) To i
Loop
Move 0 To i
Get ComSizeOfArray Of hoJResp "tsp.call_out_countries" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "tsp.call_out_countries[i]" To sStrVal
Move (i + 1) To i
Loop
End_Procedure
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": ""
}
]
}
