unicodeC / Zoom API / Get user settings
Back to Collection Items
#include <C_CkHttpW.h>
#include <C_CkJsonObjectW.h>
#include <C_CkHttpResponseW.h>
#include <C_CkStringBuilderW.h>
void ChilkatSample(void)
{
HCkHttpW http;
BOOL success;
HCkJsonObjectW queryParams;
HCkHttpResponseW resp;
HCkStringBuilderW sbResponseBody;
HCkJsonObjectW jResp;
int respStatusCode;
const wchar_t *strVal;
const wchar_t *Audio_type;
BOOL Embed_password_in_join_link;
BOOL Force_pmi_jbh_password;
BOOL Host_video;
BOOL Join_before_host;
BOOL Have_letter;
BOOL Have_number;
BOOL Have_special_character;
int Length;
BOOL Only_allow_numeric;
BOOL Not_store_meeting_topic;
BOOL Participants_video;
const wchar_t *Pmi_password;
BOOL Pstn_password_protected;
const wchar_t *Require_password_for_pmi_meetings;
BOOL Require_password_for_scheduling_new_meetings;
BOOL Use_pmi_for_instant_meetings;
BOOL Use_pmi_for_scheduled_meetings;
BOOL Allow_live_streaming;
BOOL Allow_host_to_enable_focus_mode;
BOOL Attention_mode_focus_mode;
BOOL Annotation;
BOOL Attendee_on_hold;
BOOL Auto_saving_chat;
BOOL Breakout_room;
BOOL Breakout_room_schedule;
BOOL Chat;
int Allow_participants_chat_with;
int Allow_users_save_chats;
BOOL Closed_caption;
BOOL Co_host;
BOOL Custom_data_center_regions;
BOOL E2e_encryption;
const wchar_t *Entry_exit_chime;
BOOL Far_end_camera_control;
BOOL Feedback;
BOOL Group_hd;
BOOL Non_verbal_feedback;
BOOL Polling;
BOOL Private_chat;
BOOL Record_play_voice;
BOOL Remote_control;
BOOL Remote_support;
BOOL Show_meeting_control_toolbar;
BOOL Virtual_background;
BOOL Waiting_room;
BOOL Show_a_join_from_your_browser_link;
BOOL Join_from_mobile;
BOOL Join_from_desktop;
BOOL Live_streaming_facebook;
BOOL Workplace_by_facebook;
BOOL Live_streaming_youtube;
BOOL Custom_live_streaming_service;
BOOL Enable;
const wchar_t *Custom_service_instructions;
BOOL Live_streaming_reminder;
BOOL Webinar_chatEnable;
int Allow_panelists_chat_with;
int Allow_attendees_chat_with;
int Default_attendees_chat_with;
BOOL Allow_panelists_send_direct_message;
int Webinar_chatAllow_users_save_chats;
BOOL Allow_auto_save_local_chat_file;
BOOL Closed_captioningEnable;
BOOL Third_party_captioning_service;
BOOL Auto_transcribing;
BOOL View_full_transcript;
BOOL Save_caption;
BOOL Slide_control;
BOOL Meeting_survey;
BOOL Webinar_pollingEnable;
BOOL Advanced_polls;
BOOL Webinar_survey;
BOOL Cloud_recording_available_reminder;
BOOL Recording_available_reminder_schedulers;
BOOL Recording_available_reminder_alternative_hosts;
BOOL Jbh_reminder;
BOOL Cancel_meeting_reminder;
BOOL Alternative_host_reminder;
BOOL Schedule_for_reminder;
BOOL Auto_delete_cmr;
const wchar_t *Auto_recording;
BOOL Cloud_recording;
BOOL Local_recording;
BOOL Record_audio_file;
BOOL Record_gallery_view;
BOOL Record_speaker_view;
BOOL Recording_audio_transcript;
BOOL Recording_password_requirementHave_letter;
BOOL Recording_password_requirementHave_number;
BOOL Recording_password_requirementHave_special_character;
int Recording_password_requirementLength;
BOOL Recording_password_requirementOnly_allow_numeric;
BOOL Save_chat_text;
BOOL Show_timestamp;
BOOL Third_party_audio;
const wchar_t *Audio_conference_info;
BOOL Show_international_numbers_link;
int Meeting_capacity;
BOOL Large_meeting;
BOOL Webinar;
BOOL Cn_meeting;
BOOL In_meeting;
BOOL Zoom_phone;
const wchar_t *Concurrent_meeting;
BOOL Call_out;
BOOL tspShow_international_numbers_link;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttpW_Create();
queryParams = CkJsonObjectW_Create();
CkJsonObjectW_UpdateInt(queryParams,L"login_type",100);
CkJsonObjectW_UpdateString(queryParams,L"option",L"meeting_authentication");
CkJsonObjectW_UpdateString(queryParams,L"custom_query_fields",L"quis officia in reprehenderit");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttpW_putAuthToken(http,L"<access_token>");
resp = CkHttpW_QuickRequestParams(http,L"GET",L"https://api.zoom.us/v2/users/:userId/settings",queryParams);
if (CkHttpW_getLastMethodSuccess(http) == FALSE) {
wprintf(L"%s\n",CkHttpW_lastErrorText(http));
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilderW_Create();
CkHttpResponseW_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObjectW_Create();
CkJsonObjectW_LoadSb(jResp,sbResponseBody);
CkJsonObjectW_putEmitCompact(jResp,FALSE);
wprintf(L"Response Body:\n");
wprintf(L"%s\n",CkJsonObjectW_emit(jResp));
respStatusCode = CkHttpResponseW_getStatusCode(resp);
wprintf(L"Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
wprintf(L"Response Header:\n");
wprintf(L"%s\n",CkHttpResponseW_header(resp));
wprintf(L"Failed.\n");
CkHttpResponseW_Dispose(resp);
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(jResp);
return;
}
CkHttpResponseW_Dispose(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
// Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.
Audio_type = CkJsonObjectW_stringOf(jResp,L"schedule_meeting.audio_type");
Embed_password_in_join_link = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.embed_password_in_join_link");
Force_pmi_jbh_password = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.force_pmi_jbh_password");
Host_video = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.host_video");
Join_before_host = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.join_before_host");
Have_letter = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.meeting_password_requirement.have_letter");
Have_number = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.meeting_password_requirement.have_number");
Have_special_character = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.meeting_password_requirement.have_special_character");
Length = CkJsonObjectW_IntOf(jResp,L"schedule_meeting.meeting_password_requirement.length");
Only_allow_numeric = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.meeting_password_requirement.only_allow_numeric");
Not_store_meeting_topic = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.not_store_meeting_topic");
Participants_video = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.participants_video");
Pmi_password = CkJsonObjectW_stringOf(jResp,L"schedule_meeting.pmi_password");
Pstn_password_protected = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.pstn_password_protected");
Require_password_for_pmi_meetings = CkJsonObjectW_stringOf(jResp,L"schedule_meeting.require_password_for_pmi_meetings");
Require_password_for_scheduling_new_meetings = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.require_password_for_scheduling_new_meetings");
Use_pmi_for_instant_meetings = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.use_pmi_for_instant_meetings");
Use_pmi_for_scheduled_meetings = CkJsonObjectW_BoolOf(jResp,L"schedule_meeting.use_pmi_for_scheduled_meetings");
Allow_live_streaming = CkJsonObjectW_BoolOf(jResp,L"in_meeting.allow_live_streaming");
Allow_host_to_enable_focus_mode = CkJsonObjectW_BoolOf(jResp,L"in_meeting.allow_host_to_enable_focus_mode");
Attention_mode_focus_mode = CkJsonObjectW_BoolOf(jResp,L"in_meeting.attention_mode_focus_mode");
Annotation = CkJsonObjectW_BoolOf(jResp,L"in_meeting.annotation");
Attendee_on_hold = CkJsonObjectW_BoolOf(jResp,L"in_meeting.attendee_on_hold");
Auto_saving_chat = CkJsonObjectW_BoolOf(jResp,L"in_meeting.auto_saving_chat");
Breakout_room = CkJsonObjectW_BoolOf(jResp,L"in_meeting.breakout_room");
Breakout_room_schedule = CkJsonObjectW_BoolOf(jResp,L"in_meeting.breakout_room_schedule");
Chat = CkJsonObjectW_BoolOf(jResp,L"in_meeting.chat");
Allow_participants_chat_with = CkJsonObjectW_IntOf(jResp,L"in_meeting.allow_participants_chat_with");
Allow_users_save_chats = CkJsonObjectW_IntOf(jResp,L"in_meeting.allow_users_save_chats");
Closed_caption = CkJsonObjectW_BoolOf(jResp,L"in_meeting.closed_caption");
Co_host = CkJsonObjectW_BoolOf(jResp,L"in_meeting.co_host");
Custom_data_center_regions = CkJsonObjectW_BoolOf(jResp,L"in_meeting.custom_data_center_regions");
E2e_encryption = CkJsonObjectW_BoolOf(jResp,L"in_meeting.e2e_encryption");
Entry_exit_chime = CkJsonObjectW_stringOf(jResp,L"in_meeting.entry_exit_chime");
Far_end_camera_control = CkJsonObjectW_BoolOf(jResp,L"in_meeting.far_end_camera_control");
Feedback = CkJsonObjectW_BoolOf(jResp,L"in_meeting.feedback");
Group_hd = CkJsonObjectW_BoolOf(jResp,L"in_meeting.group_hd");
Non_verbal_feedback = CkJsonObjectW_BoolOf(jResp,L"in_meeting.non_verbal_feedback");
Polling = CkJsonObjectW_BoolOf(jResp,L"in_meeting.polling");
Private_chat = CkJsonObjectW_BoolOf(jResp,L"in_meeting.private_chat");
Record_play_voice = CkJsonObjectW_BoolOf(jResp,L"in_meeting.record_play_voice");
Remote_control = CkJsonObjectW_BoolOf(jResp,L"in_meeting.remote_control");
Remote_support = CkJsonObjectW_BoolOf(jResp,L"in_meeting.remote_support");
Show_meeting_control_toolbar = CkJsonObjectW_BoolOf(jResp,L"in_meeting.show_meeting_control_toolbar");
Virtual_background = CkJsonObjectW_BoolOf(jResp,L"in_meeting.virtual_background");
Waiting_room = CkJsonObjectW_BoolOf(jResp,L"in_meeting.waiting_room");
Show_a_join_from_your_browser_link = CkJsonObjectW_BoolOf(jResp,L"in_meeting.show_a_join_from_your_browser_link");
Join_from_mobile = CkJsonObjectW_BoolOf(jResp,L"in_meeting.join_from_mobile");
Join_from_desktop = CkJsonObjectW_BoolOf(jResp,L"in_meeting.join_from_desktop");
Live_streaming_facebook = CkJsonObjectW_BoolOf(jResp,L"in_meeting.live_streaming_facebook");
Workplace_by_facebook = CkJsonObjectW_BoolOf(jResp,L"in_meeting.workplace_by_facebook");
Live_streaming_youtube = CkJsonObjectW_BoolOf(jResp,L"in_meeting.live_streaming_youtube");
Custom_live_streaming_service = CkJsonObjectW_BoolOf(jResp,L"in_meeting.custom_live_streaming_service");
Enable = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_live_streaming.enable");
Custom_service_instructions = CkJsonObjectW_stringOf(jResp,L"in_meeting.webinar_live_streaming.custom_service_instructions");
Live_streaming_reminder = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_live_streaming.live_streaming_reminder");
Webinar_chatEnable = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_chat.enable");
Allow_panelists_chat_with = CkJsonObjectW_IntOf(jResp,L"in_meeting.webinar_chat.allow_panelists_chat_with");
Allow_attendees_chat_with = CkJsonObjectW_IntOf(jResp,L"in_meeting.webinar_chat.allow_attendees_chat_with");
Default_attendees_chat_with = CkJsonObjectW_IntOf(jResp,L"in_meeting.webinar_chat.default_attendees_chat_with");
Allow_panelists_send_direct_message = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_chat.allow_panelists_send_direct_message");
Webinar_chatAllow_users_save_chats = CkJsonObjectW_IntOf(jResp,L"in_meeting.webinar_chat.allow_users_save_chats");
Allow_auto_save_local_chat_file = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_chat.allow_auto_save_local_chat_file");
Closed_captioningEnable = CkJsonObjectW_BoolOf(jResp,L"in_meeting.closed_captioning.enable");
Third_party_captioning_service = CkJsonObjectW_BoolOf(jResp,L"in_meeting.closed_captioning.third_party_captioning_service");
Auto_transcribing = CkJsonObjectW_BoolOf(jResp,L"in_meeting.closed_captioning.auto_transcribing");
View_full_transcript = CkJsonObjectW_BoolOf(jResp,L"in_meeting.closed_captioning.view_full_transcript");
Save_caption = CkJsonObjectW_BoolOf(jResp,L"in_meeting.closed_captioning.save_caption");
Slide_control = CkJsonObjectW_BoolOf(jResp,L"in_meeting.slide_control");
Meeting_survey = CkJsonObjectW_BoolOf(jResp,L"in_meeting.meeting_survey");
Webinar_pollingEnable = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_polling.enable");
Advanced_polls = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_polling.advanced_polls");
Webinar_survey = CkJsonObjectW_BoolOf(jResp,L"in_meeting.webinar_survey");
Cloud_recording_available_reminder = CkJsonObjectW_BoolOf(jResp,L"email_notification.cloud_recording_available_reminder");
Recording_available_reminder_schedulers = CkJsonObjectW_BoolOf(jResp,L"email_notification.recording_available_reminder_schedulers");
Recording_available_reminder_alternative_hosts = CkJsonObjectW_BoolOf(jResp,L"email_notification.recording_available_reminder_alternative_hosts");
Jbh_reminder = CkJsonObjectW_BoolOf(jResp,L"email_notification.jbh_reminder");
Cancel_meeting_reminder = CkJsonObjectW_BoolOf(jResp,L"email_notification.cancel_meeting_reminder");
Alternative_host_reminder = CkJsonObjectW_BoolOf(jResp,L"email_notification.alternative_host_reminder");
Schedule_for_reminder = CkJsonObjectW_BoolOf(jResp,L"email_notification.schedule_for_reminder");
Auto_delete_cmr = CkJsonObjectW_BoolOf(jResp,L"recording.auto_delete_cmr");
Auto_recording = CkJsonObjectW_stringOf(jResp,L"recording.auto_recording");
Cloud_recording = CkJsonObjectW_BoolOf(jResp,L"recording.cloud_recording");
Local_recording = CkJsonObjectW_BoolOf(jResp,L"recording.local_recording");
Record_audio_file = CkJsonObjectW_BoolOf(jResp,L"recording.record_audio_file");
Record_gallery_view = CkJsonObjectW_BoolOf(jResp,L"recording.record_gallery_view");
Record_speaker_view = CkJsonObjectW_BoolOf(jResp,L"recording.record_speaker_view");
Recording_audio_transcript = CkJsonObjectW_BoolOf(jResp,L"recording.recording_audio_transcript");
Recording_password_requirementHave_letter = CkJsonObjectW_BoolOf(jResp,L"recording.recording_password_requirement.have_letter");
Recording_password_requirementHave_number = CkJsonObjectW_BoolOf(jResp,L"recording.recording_password_requirement.have_number");
Recording_password_requirementHave_special_character = CkJsonObjectW_BoolOf(jResp,L"recording.recording_password_requirement.have_special_character");
Recording_password_requirementLength = CkJsonObjectW_IntOf(jResp,L"recording.recording_password_requirement.length");
Recording_password_requirementOnly_allow_numeric = CkJsonObjectW_BoolOf(jResp,L"recording.recording_password_requirement.only_allow_numeric");
Save_chat_text = CkJsonObjectW_BoolOf(jResp,L"recording.save_chat_text");
Show_timestamp = CkJsonObjectW_BoolOf(jResp,L"recording.show_timestamp");
Third_party_audio = CkJsonObjectW_BoolOf(jResp,L"telephony.third_party_audio");
Audio_conference_info = CkJsonObjectW_stringOf(jResp,L"telephony.audio_conference_info");
Show_international_numbers_link = CkJsonObjectW_BoolOf(jResp,L"telephony.show_international_numbers_link");
Meeting_capacity = CkJsonObjectW_IntOf(jResp,L"feature.meeting_capacity");
Large_meeting = CkJsonObjectW_BoolOf(jResp,L"feature.large_meeting");
Webinar = CkJsonObjectW_BoolOf(jResp,L"feature.webinar");
Cn_meeting = CkJsonObjectW_BoolOf(jResp,L"feature.cn_meeting");
In_meeting = CkJsonObjectW_BoolOf(jResp,L"feature.in_meeting");
Zoom_phone = CkJsonObjectW_BoolOf(jResp,L"feature.zoom_phone");
Concurrent_meeting = CkJsonObjectW_stringOf(jResp,L"feature.concurrent_meeting");
Call_out = CkJsonObjectW_BoolOf(jResp,L"tsp.call_out");
tspShow_international_numbers_link = CkJsonObjectW_BoolOf(jResp,L"tsp.show_international_numbers_link");
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"in_meeting.data_center_regions");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"in_meeting.data_center_regions[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"in_meeting.webinar_live_streaming.live_streaming_service");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"in_meeting.webinar_live_streaming.live_streaming_service[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObjectW_SizeOfArray(jResp,L"tsp.call_out_countries");
while (i < count_i) {
CkJsonObjectW_putI(jResp,i);
strVal = CkJsonObjectW_stringOf(jResp,L"tsp.call_out_countries[i]");
i = i + 1;
}
CkHttpW_Dispose(http);
CkJsonObjectW_Dispose(queryParams);
CkStringBuilderW_Dispose(sbResponseBody);
CkJsonObjectW_Dispose(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": ""
}
]
}
