SQL Server / Zoom API / Get locked settings
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @queryParams int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @queryParams OUT
EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'option', 'quis officia in reprehenderit'
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://api.zoom.us/v2/groups/:groupId/lock_settings', @queryParams
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
RETURN
END
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @resp, 'GetBodySb', @success OUT, @sbResponseBody
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @resp, 'StatusCode', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @resp, 'Header', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
EXEC @hr = sp_OADestroy @resp
-- 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
DECLARE @Host_video int
EXEC sp_OAMethod @jResp, 'BoolOf', @Host_video OUT, 'schedule_meeting.host_video'
DECLARE @Participant_video int
EXEC sp_OAMethod @jResp, 'BoolOf', @Participant_video OUT, 'schedule_meeting.participant_video'
DECLARE @Audio_type int
EXEC sp_OAMethod @jResp, 'BoolOf', @Audio_type OUT, 'schedule_meeting.audio_type'
DECLARE @Join_before_host int
EXEC sp_OAMethod @jResp, 'BoolOf', @Join_before_host OUT, 'schedule_meeting.join_before_host'
DECLARE @Force_pmi_jbh_password int
EXEC sp_OAMethod @jResp, 'BoolOf', @Force_pmi_jbh_password OUT, 'schedule_meeting.force_pmi_jbh_password'
DECLARE @Require_password_for_scheduling_new_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Require_password_for_scheduling_new_meetings OUT, 'schedule_meeting.require_password_for_scheduling_new_meetings'
DECLARE @Require_password_for_instant_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Require_password_for_instant_meetings OUT, 'schedule_meeting.require_password_for_instant_meetings'
DECLARE @Require_password_for_pmi_meetings int
EXEC sp_OAMethod @jResp, 'BoolOf', @Require_password_for_pmi_meetings OUT, 'schedule_meeting.require_password_for_pmi_meetings'
DECLARE @Pstn_password_protected int
EXEC sp_OAMethod @jResp, 'BoolOf', @Pstn_password_protected OUT, 'schedule_meeting.pstn_password_protected'
DECLARE @Mute_upon_entry int
EXEC sp_OAMethod @jResp, 'BoolOf', @Mute_upon_entry OUT, 'schedule_meeting.mute_upon_entry'
DECLARE @Upcoming_meeting_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Upcoming_meeting_reminder OUT, 'schedule_meeting.upcoming_meeting_reminder'
DECLARE @E2e_encryption int
EXEC sp_OAMethod @jResp, 'BoolOf', @E2e_encryption OUT, 'in_meeting.e2e_encryption'
DECLARE @Chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Chat OUT, 'in_meeting.chat'
DECLARE @Private_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Private_chat OUT, 'in_meeting.private_chat'
DECLARE @Auto_saving_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_saving_chat OUT, 'in_meeting.auto_saving_chat'
DECLARE @Entry_exit_chime int
EXEC sp_OAMethod @jResp, 'BoolOf', @Entry_exit_chime OUT, 'in_meeting.entry_exit_chime'
DECLARE @Feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Feedback OUT, 'in_meeting.feedback'
DECLARE @Post_meeting_feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Post_meeting_feedback OUT, 'in_meeting.post_meeting_feedback'
DECLARE @Co_host int
EXEC sp_OAMethod @jResp, 'BoolOf', @Co_host OUT, 'in_meeting.co_host'
DECLARE @Polling int
EXEC sp_OAMethod @jResp, 'BoolOf', @Polling OUT, 'in_meeting.polling'
DECLARE @Attendee_on_hold int
EXEC sp_OAMethod @jResp, 'BoolOf', @Attendee_on_hold OUT, 'in_meeting.attendee_on_hold'
DECLARE @Show_meeting_control_toolbar int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_meeting_control_toolbar OUT, 'in_meeting.show_meeting_control_toolbar'
DECLARE @Allow_show_zoom_windows int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_show_zoom_windows OUT, 'in_meeting.allow_show_zoom_windows'
DECLARE @Annotation int
EXEC sp_OAMethod @jResp, 'BoolOf', @Annotation OUT, 'in_meeting.annotation'
DECLARE @Whiteboard int
EXEC sp_OAMethod @jResp, 'BoolOf', @Whiteboard OUT, 'in_meeting.whiteboard'
DECLARE @Remote_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Remote_control OUT, 'in_meeting.remote_control'
DECLARE @Non_verbal_feedback int
EXEC sp_OAMethod @jResp, 'BoolOf', @Non_verbal_feedback OUT, 'in_meeting.non_verbal_feedback'
DECLARE @Breakout_room int
EXEC sp_OAMethod @jResp, 'BoolOf', @Breakout_room OUT, 'in_meeting.breakout_room'
DECLARE @Remote_support int
EXEC sp_OAMethod @jResp, 'BoolOf', @Remote_support OUT, 'in_meeting.remote_support'
DECLARE @Closed_caption int
EXEC sp_OAMethod @jResp, 'BoolOf', @Closed_caption OUT, 'in_meeting.closed_caption'
DECLARE @Far_end_camera_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Far_end_camera_control OUT, 'in_meeting.far_end_camera_control'
DECLARE @Group_hd int
EXEC sp_OAMethod @jResp, 'BoolOf', @Group_hd OUT, 'in_meeting.group_hd'
DECLARE @Virtual_background int
EXEC sp_OAMethod @jResp, 'BoolOf', @Virtual_background OUT, 'in_meeting.virtual_background'
DECLARE @Alert_guest_join int
EXEC sp_OAMethod @jResp, 'BoolOf', @Alert_guest_join OUT, 'in_meeting.alert_guest_join'
DECLARE @Auto_answer int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_answer OUT, 'in_meeting.auto_answer'
DECLARE @Sending_default_email_invites int
EXEC sp_OAMethod @jResp, 'BoolOf', @Sending_default_email_invites OUT, 'in_meeting.sending_default_email_invites'
DECLARE @Use_html_format_email int
EXEC sp_OAMethod @jResp, 'BoolOf', @Use_html_format_email OUT, 'in_meeting.use_html_format_email'
DECLARE @Stereo_audio int
EXEC sp_OAMethod @jResp, 'BoolOf', @Stereo_audio OUT, 'in_meeting.stereo_audio'
DECLARE @Original_audio int
EXEC sp_OAMethod @jResp, 'BoolOf', @Original_audio OUT, 'in_meeting.original_audio'
DECLARE @Screen_sharing int
EXEC sp_OAMethod @jResp, 'BoolOf', @Screen_sharing OUT, 'in_meeting.screen_sharing'
DECLARE @Waiting_room int
EXEC sp_OAMethod @jResp, 'BoolOf', @Waiting_room OUT, 'in_meeting.waiting_room'
DECLARE @Show_browser_join_link int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_browser_join_link OUT, 'in_meeting.show_browser_join_link'
DECLARE @Show_a_join_from_your_browser_link int
EXEC sp_OAMethod @jResp, 'BoolOf', @Show_a_join_from_your_browser_link OUT, 'in_meeting.show_a_join_from_your_browser_link'
DECLARE @Allow_live_streaming int
EXEC sp_OAMethod @jResp, 'BoolOf', @Allow_live_streaming OUT, 'in_meeting.allow_live_streaming'
DECLARE @Webinar_live_streaming int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_live_streaming OUT, 'in_meeting.webinar_live_streaming'
DECLARE @Webinar_chat int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_chat OUT, 'in_meeting.webinar_chat'
DECLARE @Webinar_question_answer int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_question_answer OUT, 'in_meeting.webinar_question_answer'
DECLARE @Save_caption int
EXEC sp_OAMethod @jResp, 'BoolOf', @Save_caption OUT, 'in_meeting.save_caption'
DECLARE @Slide_control int
EXEC sp_OAMethod @jResp, 'BoolOf', @Slide_control OUT, 'in_meeting.slide_control'
DECLARE @Meeting_survey int
EXEC sp_OAMethod @jResp, 'BoolOf', @Meeting_survey OUT, 'in_meeting.meeting_survey'
DECLARE @Webinar_polling int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_polling OUT, 'in_meeting.webinar_polling'
DECLARE @Webinar_survey int
EXEC sp_OAMethod @jResp, 'BoolOf', @Webinar_survey OUT, 'in_meeting.webinar_survey'
DECLARE @Cloud_recording_available_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording_available_reminder OUT, 'email_notification.cloud_recording_available_reminder'
DECLARE @Jbh_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Jbh_reminder OUT, 'email_notification.jbh_reminder'
DECLARE @Cancel_meeting_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cancel_meeting_reminder OUT, 'email_notification.cancel_meeting_reminder'
DECLARE @Alternative_host_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Alternative_host_reminder OUT, 'email_notification.alternative_host_reminder'
DECLARE @Schedule_for_reminder int
EXEC sp_OAMethod @jResp, 'BoolOf', @Schedule_for_reminder OUT, 'email_notification.schedule_for_reminder'
DECLARE @Local_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Local_recording OUT, 'recording.local_recording'
DECLARE @Cloud_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording OUT, 'recording.cloud_recording'
DECLARE @Auto_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_recording OUT, 'recording.auto_recording'
DECLARE @Cloud_recording_download int
EXEC sp_OAMethod @jResp, 'BoolOf', @Cloud_recording_download OUT, 'recording.cloud_recording_download'
DECLARE @Account_user_access_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Account_user_access_recording OUT, 'recording.account_user_access_recording'
DECLARE @Host_delete_cloud_recording int
EXEC sp_OAMethod @jResp, 'BoolOf', @Host_delete_cloud_recording OUT, 'recording.host_delete_cloud_recording'
DECLARE @Auto_delete_cmr int
EXEC sp_OAMethod @jResp, 'BoolOf', @Auto_delete_cmr OUT, 'recording.auto_delete_cmr'
DECLARE @Third_party_audio int
EXEC sp_OAMethod @jResp, 'BoolOf', @Third_party_audio OUT, 'telephony.third_party_audio'
DECLARE @Blur_snapshot int
EXEC sp_OAMethod @jResp, 'BoolOf', @Blur_snapshot OUT, 'other_options.blur_snapshot'
DECLARE @Toll_call int
EXEC sp_OAMethod @jResp, 'BoolOf', @Toll_call OUT, 'audio_conferencing.toll_call'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @queryParams
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
