Python / Zoom API / Get a group's settings
Back to Collection Items
import sys
import chilkat
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = chilkat.CkHttp()
queryParams = chilkat.CkJsonObject()
queryParams.UpdateString("option","meeting_authentication")
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://api.zoom.us/v2/groups/:groupId/settings",queryParams)
if (http.get_LastMethodSuccess() == False):
print(http.lastErrorText())
sys.exit()
sbResponseBody = chilkat.CkStringBuilder()
resp.GetBodySb(sbResponseBody)
jResp = chilkat.CkJsonObject()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(False)
print("Response Body:")
print(jResp.emit())
respStatusCode = resp.get_StatusCode()
print("Response Status Code = " + str(respStatusCode))
if (respStatusCode >= 400):
print("Response Header:")
print(resp.header())
print("Failed.")
sys.exit()
# 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
Host_video = jResp.BoolOf("schedule_meeting.host_video")
Participant_video = jResp.BoolOf("schedule_meeting.participant_video")
Audio_type = jResp.stringOf("schedule_meeting.audio_type")
Join_before_host = jResp.BoolOf("schedule_meeting.join_before_host")
Force_pmi_jbh_password = jResp.BoolOf("schedule_meeting.force_pmi_jbh_password")
Require_password_for_scheduling_new_meetings = jResp.BoolOf("schedule_meeting.require_password_for_scheduling_new_meetings")
Require_password_for_scheduled_meetings = jResp.BoolOf("schedule_meeting.require_password_for_scheduled_meetings")
Require_password_for_instant_meetings = jResp.BoolOf("schedule_meeting.require_password_for_instant_meetings")
Require_password_for_pmi_meetings = jResp.stringOf("schedule_meeting.require_password_for_pmi_meetings")
Pstn_password_protected = jResp.BoolOf("schedule_meeting.pstn_password_protected")
Mute_upon_entry = jResp.BoolOf("schedule_meeting.mute_upon_entry")
Upcoming_meeting_reminder = jResp.BoolOf("schedule_meeting.upcoming_meeting_reminder")
E2e_encryption = jResp.BoolOf("in_meeting.e2e_encryption")
Chat = jResp.BoolOf("in_meeting.chat")
Allow_participants_chat_with = jResp.IntOf("in_meeting.allow_participants_chat_with")
Allow_users_save_chats = jResp.IntOf("in_meeting.allow_users_save_chats")
Private_chat = jResp.BoolOf("in_meeting.private_chat")
Auto_saving_chat = jResp.BoolOf("in_meeting.auto_saving_chat")
Entry_exit_chime = jResp.stringOf("in_meeting.entry_exit_chime")
Record_play_own_voice = jResp.BoolOf("in_meeting.record_play_own_voice")
Feedback = jResp.BoolOf("in_meeting.feedback")
Post_meeting_feedback = jResp.BoolOf("in_meeting.post_meeting_feedback")
Co_host = jResp.BoolOf("in_meeting.co_host")
Polling = jResp.BoolOf("in_meeting.polling")
Attendee_on_hold = jResp.BoolOf("in_meeting.attendee_on_hold")
Show_meeting_control_toolbar = jResp.BoolOf("in_meeting.show_meeting_control_toolbar")
Allow_show_zoom_windows = jResp.BoolOf("in_meeting.allow_show_zoom_windows")
Annotation = jResp.BoolOf("in_meeting.annotation")
Whiteboard = jResp.BoolOf("in_meeting.whiteboard")
Remote_control = jResp.BoolOf("in_meeting.remote_control")
Non_verbal_feedback = jResp.BoolOf("in_meeting.non_verbal_feedback")
Breakout_room = jResp.BoolOf("in_meeting.breakout_room")
Breakout_room_schedule = jResp.BoolOf("in_meeting.breakout_room_schedule")
Remote_support = jResp.BoolOf("in_meeting.remote_support")
Closed_caption = jResp.BoolOf("in_meeting.closed_caption")
Far_end_camera_control = jResp.BoolOf("in_meeting.far_end_camera_control")
Group_hd = jResp.BoolOf("in_meeting.group_hd")
Virtual_background = jResp.BoolOf("in_meeting.virtual_background")
Alert_guest_join = jResp.BoolOf("in_meeting.alert_guest_join")
Auto_answer = jResp.BoolOf("in_meeting.auto_answer")
Sending_default_email_invites = jResp.BoolOf("in_meeting.sending_default_email_invites")
Use_html_format_email = jResp.BoolOf("in_meeting.use_html_format_email")
Stereo_audio = jResp.BoolOf("in_meeting.stereo_audio")
Original_audio = jResp.BoolOf("in_meeting.original_audio")
Show_device_list = jResp.BoolOf("in_meeting.show_device_list")
Only_host_view_device_list = jResp.BoolOf("in_meeting.only_host_view_device_list")
Screen_sharing = jResp.BoolOf("in_meeting.screen_sharing")
Waiting_room = jResp.BoolOf("in_meeting.waiting_room")
Show_browser_join_link = jResp.BoolOf("in_meeting.show_browser_join_link")
Show_a_join_from_your_browser_link = jResp.BoolOf("in_meeting.show_a_join_from_your_browser_link")
Join_from_mobile = jResp.BoolOf("in_meeting.join_from_mobile")
Join_from_desktop = jResp.BoolOf("in_meeting.join_from_desktop")
Allow_live_streaming = jResp.BoolOf("in_meeting.allow_live_streaming")
Live_streaming_facebook = jResp.BoolOf("in_meeting.live_streaming_facebook")
Workplace_by_facebook = jResp.BoolOf("in_meeting.workplace_by_facebook")
Live_streaming_youtube = jResp.BoolOf("in_meeting.live_streaming_youtube")
Custom_live_streaming_service = jResp.BoolOf("in_meeting.custom_live_streaming_service")
Custom_service_instructions = jResp.stringOf("in_meeting.custom_service_instructions")
Enable = jResp.BoolOf("in_meeting.webinar_live_streaming.enable")
Webinar_live_streamingCustom_service_instructions = jResp.stringOf("in_meeting.webinar_live_streaming.custom_service_instructions")
Live_streaming_reminder = jResp.BoolOf("in_meeting.webinar_live_streaming.live_streaming_reminder")
Webinar_question_answer = jResp.BoolOf("in_meeting.webinar_question_answer")
Webinar_chatEnable = jResp.BoolOf("in_meeting.webinar_chat.enable")
Allow_panelists_chat_with = jResp.IntOf("in_meeting.webinar_chat.allow_panelists_chat_with")
Allow_attendees_chat_with = jResp.IntOf("in_meeting.webinar_chat.allow_attendees_chat_with")
Default_attendees_chat_with = jResp.IntOf("in_meeting.webinar_chat.default_attendees_chat_with")
Allow_panelists_send_direct_message = jResp.BoolOf("in_meeting.webinar_chat.allow_panelists_send_direct_message")
Webinar_chatAllow_users_save_chats = jResp.IntOf("in_meeting.webinar_chat.allow_users_save_chats")
Allow_auto_save_local_chat_file = jResp.BoolOf("in_meeting.webinar_chat.allow_auto_save_local_chat_file")
Closed_captioningEnable = jResp.BoolOf("in_meeting.closed_captioning.enable")
Third_party_captioning_service = jResp.BoolOf("in_meeting.closed_captioning.third_party_captioning_service")
Auto_transcribing = jResp.BoolOf("in_meeting.closed_captioning.auto_transcribing")
View_full_transcript = jResp.BoolOf("in_meeting.closed_captioning.view_full_transcript")
Save_caption = jResp.BoolOf("in_meeting.closed_captioning.save_caption")
Slide_control = jResp.BoolOf("in_meeting.slide_control")
Meeting_survey = jResp.BoolOf("in_meeting.meeting_survey")
Webinar_pollingEnable = jResp.BoolOf("in_meeting.webinar_polling.enable")
Advanced_polls = jResp.BoolOf("in_meeting.webinar_polling.advanced_polls")
Webinar_survey = jResp.BoolOf("in_meeting.webinar_survey")
Cloud_recording_available_reminder = jResp.BoolOf("email_notification.cloud_recording_available_reminder")
Recording_available_reminder_schedulers = jResp.BoolOf("email_notification.recording_available_reminder_schedulers")
Recording_available_reminder_alternative_hosts = jResp.BoolOf("email_notification.recording_available_reminder_alternative_hosts")
Jbh_reminder = jResp.BoolOf("email_notification.jbh_reminder")
Cancel_meeting_reminder = jResp.BoolOf("email_notification.cancel_meeting_reminder")
Alternative_host_reminder = jResp.BoolOf("email_notification.alternative_host_reminder")
Schedule_for_reminder = jResp.BoolOf("email_notification.schedule_for_reminder")
Local_recording = jResp.BoolOf("recording.local_recording")
Cloud_recording = jResp.BoolOf("recording.cloud_recording")
Record_speaker_view = jResp.BoolOf("recording.record_speaker_view")
Record_gallery_view = jResp.BoolOf("recording.record_gallery_view")
Record_audio_file = jResp.BoolOf("recording.record_audio_file")
Save_chat_text = jResp.BoolOf("recording.save_chat_text")
Show_timestamp = jResp.BoolOf("recording.show_timestamp")
Recording_audio_transcript = jResp.BoolOf("recording.recording_audio_transcript")
Auto_recording = jResp.stringOf("recording.auto_recording")
Cloud_recording_download = jResp.BoolOf("recording.cloud_recording_download")
Cloud_recording_download_host = jResp.BoolOf("recording.cloud_recording_download_host")
Account_user_access_recording = jResp.BoolOf("recording.account_user_access_recording")
Host_delete_cloud_recording = jResp.BoolOf("recording.host_delete_cloud_recording")
Third_party_audio = jResp.BoolOf("telephony.third_party_audio")
Audio_conference_info = jResp.stringOf("telephony.audio_conference_info")
Blur_snapshot = jResp.BoolOf("other_options.blur_snapshot")
Allow_users_contact_support_via_chat = jResp.BoolOf("other_options.allow_users_contact_support_via_chat")
Toll_free_and_fee_based_toll_callEnable = jResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.enable")
Allow_webinar_attendees_dial = jResp.BoolOf("audio_conferencing.toll_free_and_fee_based_toll_call.allow_webinar_attendees_dial")
i = 0
count_i = jResp.SizeOfArray("in_meeting.webinar_live_streaming.live_streaming_service")
while i < count_i :
jResp.put_I(i)
strVal = jResp.stringOf("in_meeting.webinar_live_streaming.live_streaming_service[i]")
i = i + 1
i = 0
count_i = jResp.SizeOfArray("audio_conferencing.toll_free_and_fee_based_toll_call.numbers")
while i < count_i :
jResp.put_I(i)
code = jResp.stringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].code")
country_code = jResp.stringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_code")
country_name = jResp.stringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_name")
v_number = jResp.stringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].number")
display_number = jResp.stringOf("audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].display_number")
i = i + 1
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": ""
}
]
}
