C / Zoom API / Get a group's settings
Back to Collection Items
#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>
#include <C_CkStringBuilder.h>
void ChilkatSample(void)
{
HCkHttp http;
BOOL success;
HCkJsonObject queryParams;
HCkHttpResponse resp;
HCkStringBuilder sbResponseBody;
HCkJsonObject jResp;
int respStatusCode;
const char *strVal;
const char *code;
const char *country_code;
const char *country_name;
const char *v_number;
const char *display_number;
BOOL Host_video;
BOOL Participant_video;
const char *Audio_type;
BOOL Join_before_host;
BOOL Force_pmi_jbh_password;
BOOL Require_password_for_scheduling_new_meetings;
BOOL Require_password_for_scheduled_meetings;
BOOL Require_password_for_instant_meetings;
const char *Require_password_for_pmi_meetings;
BOOL Pstn_password_protected;
BOOL Mute_upon_entry;
BOOL Upcoming_meeting_reminder;
BOOL E2e_encryption;
BOOL Chat;
int Allow_participants_chat_with;
int Allow_users_save_chats;
BOOL Private_chat;
BOOL Auto_saving_chat;
const char *Entry_exit_chime;
BOOL Record_play_own_voice;
BOOL Feedback;
BOOL Post_meeting_feedback;
BOOL Co_host;
BOOL Polling;
BOOL Attendee_on_hold;
BOOL Show_meeting_control_toolbar;
BOOL Allow_show_zoom_windows;
BOOL Annotation;
BOOL Whiteboard;
BOOL Remote_control;
BOOL Non_verbal_feedback;
BOOL Breakout_room;
BOOL Breakout_room_schedule;
BOOL Remote_support;
BOOL Closed_caption;
BOOL Far_end_camera_control;
BOOL Group_hd;
BOOL Virtual_background;
BOOL Alert_guest_join;
BOOL Auto_answer;
BOOL Sending_default_email_invites;
BOOL Use_html_format_email;
BOOL Stereo_audio;
BOOL Original_audio;
BOOL Show_device_list;
BOOL Only_host_view_device_list;
BOOL Screen_sharing;
BOOL Waiting_room;
BOOL Show_browser_join_link;
BOOL Show_a_join_from_your_browser_link;
BOOL Join_from_mobile;
BOOL Join_from_desktop;
BOOL Allow_live_streaming;
BOOL Live_streaming_facebook;
BOOL Workplace_by_facebook;
BOOL Live_streaming_youtube;
BOOL Custom_live_streaming_service;
const char *Custom_service_instructions;
BOOL Enable;
const char *Webinar_live_streamingCustom_service_instructions;
BOOL Live_streaming_reminder;
BOOL Webinar_question_answer;
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 Local_recording;
BOOL Cloud_recording;
BOOL Record_speaker_view;
BOOL Record_gallery_view;
BOOL Record_audio_file;
BOOL Save_chat_text;
BOOL Show_timestamp;
BOOL Recording_audio_transcript;
const char *Auto_recording;
BOOL Cloud_recording_download;
BOOL Cloud_recording_download_host;
BOOL Account_user_access_recording;
BOOL Host_delete_cloud_recording;
BOOL Third_party_audio;
const char *Audio_conference_info;
BOOL Blur_snapshot;
BOOL Allow_users_contact_support_via_chat;
BOOL Toll_free_and_fee_based_toll_callEnable;
BOOL Allow_webinar_attendees_dial;
int i;
int count_i;
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http = CkHttp_Create();
queryParams = CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,"option","meeting_authentication");
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,"<access_token>");
resp = CkHttp_QuickRequestParams(http,"GET","https://api.zoom.us/v2/groups/:groupId/settings",queryParams);
if (CkHttp_getLastMethodSuccess(http) == FALSE) {
printf("%s\n",CkHttp_lastErrorText(http));
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
return;
}
sbResponseBody = CkStringBuilder_Create();
CkHttpResponse_GetBodySb(resp,sbResponseBody);
jResp = CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,FALSE);
printf("Response Body:\n");
printf("%s\n",CkJsonObject_emit(jResp));
respStatusCode = CkHttpResponse_getStatusCode(resp);
printf("Response Status Code = %d\n",respStatusCode);
if (respStatusCode >= 400) {
printf("Response Header:\n");
printf("%s\n",CkHttpResponse_header(resp));
printf("Failed.\n");
CkHttpResponse_Dispose(resp);
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
return;
}
CkHttpResponse_Dispose(resp);
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "schedule_meeting": {
// "host_video": true,
// "participant_video": true,
// "audio_type": "both",
// "join_before_host": true,
// "force_pmi_jbh_password": true,
// "require_password_for_scheduling_new_meetings": true,
// "require_password_for_scheduled_meetings": true,
// "require_password_for_instant_meetings": false,
// "require_password_for_pmi_meetings": "all",
// "pstn_password_protected": true,
// "mute_upon_entry": true,
// "upcoming_meeting_reminder": true
// },
// "in_meeting": {
// "e2e_encryption": true,
// "chat": true,
// "allow_participants_chat_with": 2,
// "allow_users_save_chats": 2,
// "private_chat": true,
// "auto_saving_chat": true,
// "entry_exit_chime": "all",
// "record_play_own_voice": false,
// "feedback": true,
// "post_meeting_feedback": true,
// "co_host": true,
// "polling": true,
// "attendee_on_hold": true,
// "show_meeting_control_toolbar": true,
// "allow_show_zoom_windows": true,
// "annotation": true,
// "whiteboard": true,
// "remote_control": true,
// "non_verbal_feedback": true,
// "breakout_room": true,
// "breakout_room_schedule": true,
// "remote_support": true,
// "closed_caption": true,
// "far_end_camera_control": true,
// "group_hd": true,
// "virtual_background": true,
// "alert_guest_join": true,
// "auto_answer": true,
// "sending_default_email_invites": true,
// "use_html_format_email": true,
// "stereo_audio": true,
// "original_audio": true,
// "show_device_list": false,
// "only_host_view_device_list": false,
// "screen_sharing": true,
// "waiting_room": true,
// "show_browser_join_link": true,
// "show_a_join_from_your_browser_link": true,
// "join_from_mobile": true,
// "join_from_desktop": true,
// "allow_live_streaming": true,
// "live_streaming_facebook": true,
// "workplace_by_facebook": true,
// "live_streaming_youtube": true,
// "custom_live_streaming_service": true,
// "custom_service_instructions": "specific instructions",
// "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_question_answer": 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": true,
// "cancel_meeting_reminder": true,
// "alternative_host_reminder": true,
// "schedule_for_reminder": true
// },
// "recording": {
// "local_recording": true,
// "cloud_recording": true,
// "record_speaker_view": true,
// "record_gallery_view": false,
// "record_audio_file": true,
// "save_chat_text": true,
// "show_timestamp": false,
// "recording_audio_transcript": false,
// "auto_recording": "none",
// "cloud_recording_download": true,
// "cloud_recording_download_host": true,
// "account_user_access_recording": false,
// "host_delete_cloud_recording": true
// },
// "telephony": {
// "third_party_audio": true,
// "audio_conference_info": "1234656"
// },
// "other_options": {
// "blur_snapshot": true,
// "allow_users_contact_support_via_chat": true
// },
// "audio_conferencing": {
// "toll_free_and_fee_based_toll_call": {
// "enable": true,
// "numbers": [
// {
// "code": "64",
// "country_code": "US",
// "country_name": "United States",
// "number": "+1 5550100",
// "display_number": "+1 5550100(Atlanta)"
// },
// {
// "code": "64",
// "country_code": "US",
// "country_name": "United States",
// "number": "+1 5550101",
// "display_number": "+1 5550101(SanJose)"
// }
// ],
// "allow_webinar_attendees_dial": true
// }
// }
// }
// 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.
Host_video = CkJsonObject_BoolOf(jResp,"schedule_meeting.host_video");
Participant_video = CkJsonObject_BoolOf(jResp,"schedule_meeting.participant_video");
Audio_type = CkJsonObject_stringOf(jResp,"schedule_meeting.audio_type");
Join_before_host = CkJsonObject_BoolOf(jResp,"schedule_meeting.join_before_host");
Force_pmi_jbh_password = CkJsonObject_BoolOf(jResp,"schedule_meeting.force_pmi_jbh_password");
Require_password_for_scheduling_new_meetings = CkJsonObject_BoolOf(jResp,"schedule_meeting.require_password_for_scheduling_new_meetings");
Require_password_for_scheduled_meetings = CkJsonObject_BoolOf(jResp,"schedule_meeting.require_password_for_scheduled_meetings");
Require_password_for_instant_meetings = CkJsonObject_BoolOf(jResp,"schedule_meeting.require_password_for_instant_meetings");
Require_password_for_pmi_meetings = CkJsonObject_stringOf(jResp,"schedule_meeting.require_password_for_pmi_meetings");
Pstn_password_protected = CkJsonObject_BoolOf(jResp,"schedule_meeting.pstn_password_protected");
Mute_upon_entry = CkJsonObject_BoolOf(jResp,"schedule_meeting.mute_upon_entry");
Upcoming_meeting_reminder = CkJsonObject_BoolOf(jResp,"schedule_meeting.upcoming_meeting_reminder");
E2e_encryption = CkJsonObject_BoolOf(jResp,"in_meeting.e2e_encryption");
Chat = CkJsonObject_BoolOf(jResp,"in_meeting.chat");
Allow_participants_chat_with = CkJsonObject_IntOf(jResp,"in_meeting.allow_participants_chat_with");
Allow_users_save_chats = CkJsonObject_IntOf(jResp,"in_meeting.allow_users_save_chats");
Private_chat = CkJsonObject_BoolOf(jResp,"in_meeting.private_chat");
Auto_saving_chat = CkJsonObject_BoolOf(jResp,"in_meeting.auto_saving_chat");
Entry_exit_chime = CkJsonObject_stringOf(jResp,"in_meeting.entry_exit_chime");
Record_play_own_voice = CkJsonObject_BoolOf(jResp,"in_meeting.record_play_own_voice");
Feedback = CkJsonObject_BoolOf(jResp,"in_meeting.feedback");
Post_meeting_feedback = CkJsonObject_BoolOf(jResp,"in_meeting.post_meeting_feedback");
Co_host = CkJsonObject_BoolOf(jResp,"in_meeting.co_host");
Polling = CkJsonObject_BoolOf(jResp,"in_meeting.polling");
Attendee_on_hold = CkJsonObject_BoolOf(jResp,"in_meeting.attendee_on_hold");
Show_meeting_control_toolbar = CkJsonObject_BoolOf(jResp,"in_meeting.show_meeting_control_toolbar");
Allow_show_zoom_windows = CkJsonObject_BoolOf(jResp,"in_meeting.allow_show_zoom_windows");
Annotation = CkJsonObject_BoolOf(jResp,"in_meeting.annotation");
Whiteboard = CkJsonObject_BoolOf(jResp,"in_meeting.whiteboard");
Remote_control = CkJsonObject_BoolOf(jResp,"in_meeting.remote_control");
Non_verbal_feedback = CkJsonObject_BoolOf(jResp,"in_meeting.non_verbal_feedback");
Breakout_room = CkJsonObject_BoolOf(jResp,"in_meeting.breakout_room");
Breakout_room_schedule = CkJsonObject_BoolOf(jResp,"in_meeting.breakout_room_schedule");
Remote_support = CkJsonObject_BoolOf(jResp,"in_meeting.remote_support");
Closed_caption = CkJsonObject_BoolOf(jResp,"in_meeting.closed_caption");
Far_end_camera_control = CkJsonObject_BoolOf(jResp,"in_meeting.far_end_camera_control");
Group_hd = CkJsonObject_BoolOf(jResp,"in_meeting.group_hd");
Virtual_background = CkJsonObject_BoolOf(jResp,"in_meeting.virtual_background");
Alert_guest_join = CkJsonObject_BoolOf(jResp,"in_meeting.alert_guest_join");
Auto_answer = CkJsonObject_BoolOf(jResp,"in_meeting.auto_answer");
Sending_default_email_invites = CkJsonObject_BoolOf(jResp,"in_meeting.sending_default_email_invites");
Use_html_format_email = CkJsonObject_BoolOf(jResp,"in_meeting.use_html_format_email");
Stereo_audio = CkJsonObject_BoolOf(jResp,"in_meeting.stereo_audio");
Original_audio = CkJsonObject_BoolOf(jResp,"in_meeting.original_audio");
Show_device_list = CkJsonObject_BoolOf(jResp,"in_meeting.show_device_list");
Only_host_view_device_list = CkJsonObject_BoolOf(jResp,"in_meeting.only_host_view_device_list");
Screen_sharing = CkJsonObject_BoolOf(jResp,"in_meeting.screen_sharing");
Waiting_room = CkJsonObject_BoolOf(jResp,"in_meeting.waiting_room");
Show_browser_join_link = CkJsonObject_BoolOf(jResp,"in_meeting.show_browser_join_link");
Show_a_join_from_your_browser_link = CkJsonObject_BoolOf(jResp,"in_meeting.show_a_join_from_your_browser_link");
Join_from_mobile = CkJsonObject_BoolOf(jResp,"in_meeting.join_from_mobile");
Join_from_desktop = CkJsonObject_BoolOf(jResp,"in_meeting.join_from_desktop");
Allow_live_streaming = CkJsonObject_BoolOf(jResp,"in_meeting.allow_live_streaming");
Live_streaming_facebook = CkJsonObject_BoolOf(jResp,"in_meeting.live_streaming_facebook");
Workplace_by_facebook = CkJsonObject_BoolOf(jResp,"in_meeting.workplace_by_facebook");
Live_streaming_youtube = CkJsonObject_BoolOf(jResp,"in_meeting.live_streaming_youtube");
Custom_live_streaming_service = CkJsonObject_BoolOf(jResp,"in_meeting.custom_live_streaming_service");
Custom_service_instructions = CkJsonObject_stringOf(jResp,"in_meeting.custom_service_instructions");
Enable = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_live_streaming.enable");
Webinar_live_streamingCustom_service_instructions = CkJsonObject_stringOf(jResp,"in_meeting.webinar_live_streaming.custom_service_instructions");
Live_streaming_reminder = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_live_streaming.live_streaming_reminder");
Webinar_question_answer = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_question_answer");
Webinar_chatEnable = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_chat.enable");
Allow_panelists_chat_with = CkJsonObject_IntOf(jResp,"in_meeting.webinar_chat.allow_panelists_chat_with");
Allow_attendees_chat_with = CkJsonObject_IntOf(jResp,"in_meeting.webinar_chat.allow_attendees_chat_with");
Default_attendees_chat_with = CkJsonObject_IntOf(jResp,"in_meeting.webinar_chat.default_attendees_chat_with");
Allow_panelists_send_direct_message = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_chat.allow_panelists_send_direct_message");
Webinar_chatAllow_users_save_chats = CkJsonObject_IntOf(jResp,"in_meeting.webinar_chat.allow_users_save_chats");
Allow_auto_save_local_chat_file = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_chat.allow_auto_save_local_chat_file");
Closed_captioningEnable = CkJsonObject_BoolOf(jResp,"in_meeting.closed_captioning.enable");
Third_party_captioning_service = CkJsonObject_BoolOf(jResp,"in_meeting.closed_captioning.third_party_captioning_service");
Auto_transcribing = CkJsonObject_BoolOf(jResp,"in_meeting.closed_captioning.auto_transcribing");
View_full_transcript = CkJsonObject_BoolOf(jResp,"in_meeting.closed_captioning.view_full_transcript");
Save_caption = CkJsonObject_BoolOf(jResp,"in_meeting.closed_captioning.save_caption");
Slide_control = CkJsonObject_BoolOf(jResp,"in_meeting.slide_control");
Meeting_survey = CkJsonObject_BoolOf(jResp,"in_meeting.meeting_survey");
Webinar_pollingEnable = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_polling.enable");
Advanced_polls = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_polling.advanced_polls");
Webinar_survey = CkJsonObject_BoolOf(jResp,"in_meeting.webinar_survey");
Cloud_recording_available_reminder = CkJsonObject_BoolOf(jResp,"email_notification.cloud_recording_available_reminder");
Recording_available_reminder_schedulers = CkJsonObject_BoolOf(jResp,"email_notification.recording_available_reminder_schedulers");
Recording_available_reminder_alternative_hosts = CkJsonObject_BoolOf(jResp,"email_notification.recording_available_reminder_alternative_hosts");
Jbh_reminder = CkJsonObject_BoolOf(jResp,"email_notification.jbh_reminder");
Cancel_meeting_reminder = CkJsonObject_BoolOf(jResp,"email_notification.cancel_meeting_reminder");
Alternative_host_reminder = CkJsonObject_BoolOf(jResp,"email_notification.alternative_host_reminder");
Schedule_for_reminder = CkJsonObject_BoolOf(jResp,"email_notification.schedule_for_reminder");
Local_recording = CkJsonObject_BoolOf(jResp,"recording.local_recording");
Cloud_recording = CkJsonObject_BoolOf(jResp,"recording.cloud_recording");
Record_speaker_view = CkJsonObject_BoolOf(jResp,"recording.record_speaker_view");
Record_gallery_view = CkJsonObject_BoolOf(jResp,"recording.record_gallery_view");
Record_audio_file = CkJsonObject_BoolOf(jResp,"recording.record_audio_file");
Save_chat_text = CkJsonObject_BoolOf(jResp,"recording.save_chat_text");
Show_timestamp = CkJsonObject_BoolOf(jResp,"recording.show_timestamp");
Recording_audio_transcript = CkJsonObject_BoolOf(jResp,"recording.recording_audio_transcript");
Auto_recording = CkJsonObject_stringOf(jResp,"recording.auto_recording");
Cloud_recording_download = CkJsonObject_BoolOf(jResp,"recording.cloud_recording_download");
Cloud_recording_download_host = CkJsonObject_BoolOf(jResp,"recording.cloud_recording_download_host");
Account_user_access_recording = CkJsonObject_BoolOf(jResp,"recording.account_user_access_recording");
Host_delete_cloud_recording = CkJsonObject_BoolOf(jResp,"recording.host_delete_cloud_recording");
Third_party_audio = CkJsonObject_BoolOf(jResp,"telephony.third_party_audio");
Audio_conference_info = CkJsonObject_stringOf(jResp,"telephony.audio_conference_info");
Blur_snapshot = CkJsonObject_BoolOf(jResp,"other_options.blur_snapshot");
Allow_users_contact_support_via_chat = CkJsonObject_BoolOf(jResp,"other_options.allow_users_contact_support_via_chat");
Toll_free_and_fee_based_toll_callEnable = CkJsonObject_BoolOf(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.enable");
Allow_webinar_attendees_dial = CkJsonObject_BoolOf(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.allow_webinar_attendees_dial");
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"in_meeting.webinar_live_streaming.live_streaming_service");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
strVal = CkJsonObject_stringOf(jResp,"in_meeting.webinar_live_streaming.live_streaming_service[i]");
i = i + 1;
}
i = 0;
count_i = CkJsonObject_SizeOfArray(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.numbers");
while (i < count_i) {
CkJsonObject_putI(jResp,i);
code = CkJsonObject_stringOf(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].code");
country_code = CkJsonObject_stringOf(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_code");
country_name = CkJsonObject_stringOf(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_name");
v_number = CkJsonObject_stringOf(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].number");
display_number = CkJsonObject_stringOf(jResp,"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].display_number");
i = i + 1;
}
CkHttp_Dispose(http);
CkJsonObject_Dispose(queryParams);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(jResp);
}
Curl Command
curl -G -d "option=meeting_authentication"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/groups/:groupId/settings
Postman Collection Item JSON
{
"name": "Get a group's settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings?option=meeting_authentication",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings"
],
"query": [
{
"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."
}
],
"variable": [
{
"key": "groupId"
}
]
},
"description": "Get settings for a [group](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-). \n**Prerequisite**: Pro, Business, or Education account<br>\n**Scopes**: `group:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**Error Code**: `200` <br>\nOnly available for paid account.\n\n**HTTP Status Code**: `200` <br>\nGroup Settings Returned.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings?option=meeting_authentication",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_authentication"
}
],
"variable": [
{
"key": "groupId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"schedule_meeting\": {\n \"host_video\": true,\n \"participant_video\": true,\n \"audio_type\": \"both\",\n \"join_before_host\": true,\n \"force_pmi_jbh_password\": true,\n \"require_password_for_scheduling_new_meetings\": true,\n \"require_password_for_scheduled_meetings\": true,\n \"require_password_for_instant_meetings\": false,\n \"require_password_for_pmi_meetings\": \"all\",\n \"pstn_password_protected\": true,\n \"mute_upon_entry\": true,\n \"upcoming_meeting_reminder\": true\n },\n \"in_meeting\": {\n \"e2e_encryption\": true,\n \"chat\": true,\n \"allow_participants_chat_with\": 2,\n \"allow_users_save_chats\": 2,\n \"private_chat\": true,\n \"auto_saving_chat\": true,\n \"entry_exit_chime\": \"all\",\n \"record_play_own_voice\": false,\n \"feedback\": true,\n \"post_meeting_feedback\": true,\n \"co_host\": true,\n \"polling\": true,\n \"attendee_on_hold\": true,\n \"show_meeting_control_toolbar\": true,\n \"allow_show_zoom_windows\": true,\n \"annotation\": true,\n \"whiteboard\": true,\n \"remote_control\": true,\n \"non_verbal_feedback\": true,\n \"breakout_room\": true,\n \"breakout_room_schedule\": true,\n \"remote_support\": true,\n \"closed_caption\": true,\n \"far_end_camera_control\": true,\n \"group_hd\": true,\n \"virtual_background\": true,\n \"alert_guest_join\": true,\n \"auto_answer\": true,\n \"sending_default_email_invites\": true,\n \"use_html_format_email\": true,\n \"stereo_audio\": true,\n \"original_audio\": true,\n \"show_device_list\": false,\n \"only_host_view_device_list\": false,\n \"screen_sharing\": true,\n \"waiting_room\": true,\n \"show_browser_join_link\": true,\n \"show_a_join_from_your_browser_link\": true,\n \"join_from_mobile\": true,\n \"join_from_desktop\": true,\n \"allow_live_streaming\": true,\n \"live_streaming_facebook\": true,\n \"workplace_by_facebook\": true,\n \"live_streaming_youtube\": true,\n \"custom_live_streaming_service\": true,\n \"custom_service_instructions\": \"specific instructions\",\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_question_answer\": true,\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\": true,\n \"cancel_meeting_reminder\": true,\n \"alternative_host_reminder\": true,\n \"schedule_for_reminder\": true\n },\n \"recording\": {\n \"local_recording\": true,\n \"cloud_recording\": true,\n \"record_speaker_view\": true,\n \"record_gallery_view\": false,\n \"record_audio_file\": true,\n \"save_chat_text\": true,\n \"show_timestamp\": false,\n \"recording_audio_transcript\": false,\n \"auto_recording\": \"none\",\n \"cloud_recording_download\": true,\n \"cloud_recording_download_host\": true,\n \"account_user_access_recording\": false,\n \"host_delete_cloud_recording\": true\n },\n \"telephony\": {\n \"third_party_audio\": true,\n \"audio_conference_info\": \"1234656\"\n },\n \"other_options\": {\n \"blur_snapshot\": true,\n \"allow_users_contact_support_via_chat\": true\n },\n \"audio_conferencing\": {\n \"toll_free_and_fee_based_toll_call\": {\n \"enable\": true,\n \"numbers\": [\n {\n \"code\": \"64\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"number\": \"+1 5550100\",\n \"display_number\": \"+1 5550100(Atlanta)\"\n },\n {\n \"code\": \"64\",\n \"country_code\": \"US\",\n \"country_name\": \"United States\",\n \"number\": \"+1 5550101\",\n \"display_number\": \"+1 5550101(SanJose)\"\n }\n ],\n \"allow_webinar_attendees_dial\": true\n }\n }\n}"
},
{
"name": "**HTTP Status Code:** `404` <br>\n**Error Code:** `4130` <br>\nGroup does not exist: {groupId}.",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings?option=meeting_authentication",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings"
],
"query": [
{
"key": "option",
"value": "meeting_authentication"
}
],
"variable": [
{
"key": "groupId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
