Chilkat Online Tools

Unicode C++ / Zoom API / Get locked settings

Back to Collection Items

void ChilkatSample(void)
    {
    queryParams.UpdateString(L"option",L"quis officia in reprehenderit");    http.put_AuthToken(L"<access_token>");    resp->GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);
    }

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": ""
    }
  ]
}