DataFlex / Zoom API / Get locked 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
Boolean iHost_video
Boolean iParticipant_video
Boolean iAudio_type
Boolean iJoin_before_host
Boolean iForce_pmi_jbh_password
Boolean iRequire_password_for_scheduling_new_meetings
Boolean iRequire_password_for_instant_meetings
Boolean iRequire_password_for_pmi_meetings
Boolean iPstn_password_protected
Boolean iMute_upon_entry
Boolean iUpcoming_meeting_reminder
Boolean iE2e_encryption
Boolean iChat
Boolean iPrivate_chat
Boolean iAuto_saving_chat
Boolean iEntry_exit_chime
Boolean iFeedback
Boolean iPost_meeting_feedback
Boolean iCo_host
Boolean iPolling
Boolean iAttendee_on_hold
Boolean iShow_meeting_control_toolbar
Boolean iAllow_show_zoom_windows
Boolean iAnnotation
Boolean iWhiteboard
Boolean iRemote_control
Boolean iNon_verbal_feedback
Boolean iBreakout_room
Boolean iRemote_support
Boolean iClosed_caption
Boolean iFar_end_camera_control
Boolean iGroup_hd
Boolean iVirtual_background
Boolean iAlert_guest_join
Boolean iAuto_answer
Boolean iSending_default_email_invites
Boolean iUse_html_format_email
Boolean iStereo_audio
Boolean iOriginal_audio
Boolean iScreen_sharing
Boolean iWaiting_room
Boolean iShow_browser_join_link
Boolean iShow_a_join_from_your_browser_link
Boolean iAllow_live_streaming
Boolean iWebinar_live_streaming
Boolean iWebinar_chat
Boolean iWebinar_question_answer
Boolean iSave_caption
Boolean iSlide_control
Boolean iMeeting_survey
Boolean iWebinar_polling
Boolean iWebinar_survey
Boolean iCloud_recording_available_reminder
Boolean iJbh_reminder
Boolean iCancel_meeting_reminder
Boolean iAlternative_host_reminder
Boolean iSchedule_for_reminder
Boolean iLocal_recording
Boolean iCloud_recording
Boolean iAuto_recording
Boolean iCloud_recording_download
Boolean iAccount_user_access_recording
Boolean iHost_delete_cloud_recording
Boolean iAuto_delete_cmr
Boolean iThird_party_audio
Boolean iBlur_snapshot
Boolean iToll_call
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 ComUpdateString Of hoQueryParams "option" "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/groups/:groupId/lock_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": {
// "host_video": true,
// "participant_video": true,
// "audio_type": true,
// "join_before_host": true,
// "force_pmi_jbh_password": true,
// "require_password_for_scheduling_new_meetings": true,
// "require_password_for_instant_meetings": false,
// "require_password_for_pmi_meetings": true,
// "pstn_password_protected": true,
// "mute_upon_entry": true,
// "upcoming_meeting_reminder": true
// },
// "in_meeting": {
// "e2e_encryption": true,
// "chat": true,
// "private_chat": true,
// "auto_saving_chat": true,
// "entry_exit_chime": 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,
// "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,
// "screen_sharing": true,
// "waiting_room": true,
// "show_browser_join_link": true,
// "show_a_join_from_your_browser_link": true,
// "allow_live_streaming": true,
// "webinar_live_streaming": true,
// "webinar_chat": true,
// "webinar_question_answer": true,
// "save_caption": true,
// "slide_control": true,
// "meeting_survey": true,
// "webinar_polling": true,
// "webinar_survey": true
// },
// "email_notification": {
// "cloud_recording_available_reminder": true,
// "jbh_reminder": true,
// "cancel_meeting_reminder": true,
// "alternative_host_reminder": true,
// "schedule_for_reminder": true
// },
// "recording": {
// "local_recording": false,
// "cloud_recording": false,
// "auto_recording": false,
// "cloud_recording_download": false,
// "account_user_access_recording": false,
// "host_delete_cloud_recording": false,
// "auto_delete_cmr": false
// },
// "telephony": {
// "third_party_audio": false
// },
// "other_options": {
// "blur_snapshot": true
// },
// "audio_conferencing": {
// "toll_call": true
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Get ComBoolOf Of hoJResp "schedule_meeting.host_video" To iHost_video
Get ComBoolOf Of hoJResp "schedule_meeting.participant_video" To iParticipant_video
Get ComBoolOf Of hoJResp "schedule_meeting.audio_type" To iAudio_type
Get ComBoolOf Of hoJResp "schedule_meeting.join_before_host" To iJoin_before_host
Get ComBoolOf Of hoJResp "schedule_meeting.force_pmi_jbh_password" To iForce_pmi_jbh_password
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.require_password_for_instant_meetings" To iRequire_password_for_instant_meetings
Get ComBoolOf Of hoJResp "schedule_meeting.require_password_for_pmi_meetings" To iRequire_password_for_pmi_meetings
Get ComBoolOf Of hoJResp "schedule_meeting.pstn_password_protected" To iPstn_password_protected
Get ComBoolOf Of hoJResp "schedule_meeting.mute_upon_entry" To iMute_upon_entry
Get ComBoolOf Of hoJResp "schedule_meeting.upcoming_meeting_reminder" To iUpcoming_meeting_reminder
Get ComBoolOf Of hoJResp "in_meeting.e2e_encryption" To iE2e_encryption
Get ComBoolOf Of hoJResp "in_meeting.chat" To iChat
Get ComBoolOf Of hoJResp "in_meeting.private_chat" To iPrivate_chat
Get ComBoolOf Of hoJResp "in_meeting.auto_saving_chat" To iAuto_saving_chat
Get ComBoolOf Of hoJResp "in_meeting.entry_exit_chime" To iEntry_exit_chime
Get ComBoolOf Of hoJResp "in_meeting.feedback" To iFeedback
Get ComBoolOf Of hoJResp "in_meeting.post_meeting_feedback" To iPost_meeting_feedback
Get ComBoolOf Of hoJResp "in_meeting.co_host" To iCo_host
Get ComBoolOf Of hoJResp "in_meeting.polling" To iPolling
Get ComBoolOf Of hoJResp "in_meeting.attendee_on_hold" To iAttendee_on_hold
Get ComBoolOf Of hoJResp "in_meeting.show_meeting_control_toolbar" To iShow_meeting_control_toolbar
Get ComBoolOf Of hoJResp "in_meeting.allow_show_zoom_windows" To iAllow_show_zoom_windows
Get ComBoolOf Of hoJResp "in_meeting.annotation" To iAnnotation
Get ComBoolOf Of hoJResp "in_meeting.whiteboard" To iWhiteboard
Get ComBoolOf Of hoJResp "in_meeting.remote_control" To iRemote_control
Get ComBoolOf Of hoJResp "in_meeting.non_verbal_feedback" To iNon_verbal_feedback
Get ComBoolOf Of hoJResp "in_meeting.breakout_room" To iBreakout_room
Get ComBoolOf Of hoJResp "in_meeting.remote_support" To iRemote_support
Get ComBoolOf Of hoJResp "in_meeting.closed_caption" To iClosed_caption
Get ComBoolOf Of hoJResp "in_meeting.far_end_camera_control" To iFar_end_camera_control
Get ComBoolOf Of hoJResp "in_meeting.group_hd" To iGroup_hd
Get ComBoolOf Of hoJResp "in_meeting.virtual_background" To iVirtual_background
Get ComBoolOf Of hoJResp "in_meeting.alert_guest_join" To iAlert_guest_join
Get ComBoolOf Of hoJResp "in_meeting.auto_answer" To iAuto_answer
Get ComBoolOf Of hoJResp "in_meeting.sending_default_email_invites" To iSending_default_email_invites
Get ComBoolOf Of hoJResp "in_meeting.use_html_format_email" To iUse_html_format_email
Get ComBoolOf Of hoJResp "in_meeting.stereo_audio" To iStereo_audio
Get ComBoolOf Of hoJResp "in_meeting.original_audio" To iOriginal_audio
Get ComBoolOf Of hoJResp "in_meeting.screen_sharing" To iScreen_sharing
Get ComBoolOf Of hoJResp "in_meeting.waiting_room" To iWaiting_room
Get ComBoolOf Of hoJResp "in_meeting.show_browser_join_link" To iShow_browser_join_link
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.allow_live_streaming" To iAllow_live_streaming
Get ComBoolOf Of hoJResp "in_meeting.webinar_live_streaming" To iWebinar_live_streaming
Get ComBoolOf Of hoJResp "in_meeting.webinar_chat" To iWebinar_chat
Get ComBoolOf Of hoJResp "in_meeting.webinar_question_answer" To iWebinar_question_answer
Get ComBoolOf Of hoJResp "in_meeting.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" To iWebinar_polling
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.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.local_recording" To iLocal_recording
Get ComBoolOf Of hoJResp "recording.cloud_recording" To iCloud_recording
Get ComBoolOf Of hoJResp "recording.auto_recording" To iAuto_recording
Get ComBoolOf Of hoJResp "recording.cloud_recording_download" To iCloud_recording_download
Get ComBoolOf Of hoJResp "recording.account_user_access_recording" To iAccount_user_access_recording
Get ComBoolOf Of hoJResp "recording.host_delete_cloud_recording" To iHost_delete_cloud_recording
Get ComBoolOf Of hoJResp "recording.auto_delete_cmr" To iAuto_delete_cmr
Get ComBoolOf Of hoJResp "telephony.third_party_audio" To iThird_party_audio
Get ComBoolOf Of hoJResp "other_options.blur_snapshot" To iBlur_snapshot
Get ComBoolOf Of hoJResp "audio_conferencing.toll_call" To iToll_call
End_Procedure
Curl Command
curl -G -d "option=quis%20officia%20in%20reprehenderit"
-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/groups/:groupId/lock_settings
Postman Collection Item JSON
{
"name": "Get locked settings",
"request": {
"auth": {
"type": "oauth2"
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/lock_settings?option=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit",
"description": "Optional query parameters: \n* `meeting_security` — Use this query parameter to view the meeting security settings applied to the user's account."
}
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) Id of the group."
}
]
},
"description": "Retrieve a [group's](https://support.zoom.us/hc/en-us/articles/204519819-Group-Management-) locked settings. If you lock a setting, the group members will not be able to modify it individually. <p style=\"background-color:#FEEFB3; color:#9F6000\"><br>Note:</b> The `force_pmi_jbh_password` field under meeting settings is planned to be deprecated on September 22, 2019. This field will be replaced by another field that will provide the same functionality.</p>\n\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**Status Code:** `200`<br>\nLocked settings of group returned.\n",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"url": {
"raw": "{{baseUrl}}/groups/:groupId/lock_settings?option=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) Id of the group."
}
]
}
},
"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\": true,\n \"join_before_host\": true,\n \"force_pmi_jbh_password\": true,\n \"require_password_for_scheduling_new_meetings\": true,\n \"require_password_for_instant_meetings\": false,\n \"require_password_for_pmi_meetings\": true,\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 \"private_chat\": true,\n \"auto_saving_chat\": true,\n \"entry_exit_chime\": 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 \"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 \"screen_sharing\": true,\n \"waiting_room\": true,\n \"show_browser_join_link\": true,\n \"show_a_join_from_your_browser_link\": true,\n \"allow_live_streaming\": true,\n \"webinar_live_streaming\": true,\n \"webinar_chat\": true,\n \"webinar_question_answer\": true,\n \"save_caption\": true,\n \"slide_control\": true,\n \"meeting_survey\": true,\n \"webinar_polling\": true,\n \"webinar_survey\": true\n },\n \"email_notification\": {\n \"cloud_recording_available_reminder\": 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\": false,\n \"cloud_recording\": false,\n \"auto_recording\": false,\n \"cloud_recording_download\": false,\n \"account_user_access_recording\": false,\n \"host_delete_cloud_recording\": false,\n \"auto_delete_cmr\": false\n },\n \"telephony\": {\n \"third_party_audio\": false\n },\n \"other_options\": {\n \"blur_snapshot\": true\n },\n \"audio_conferencing\": {\n \"toll_call\": true\n }\n}"
},
{
"name": "**Status Code:** `404`<br>\nNot found.<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/lock_settings?option=quis officia in reprehenderit",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"lock_settings"
],
"query": [
{
"key": "option",
"value": "quis officia in reprehenderit"
}
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) Id of the group."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
