Chilkat Online Tools

Unicode C++ / Zoom API / Get a group's settings

Back to Collection Items

void ChilkatSample(void)
    {
    queryParams.UpdateString(L"option",L"meeting_authentication");    http.put_AuthToken(L"<access_token>");    resp->GetBodySb(sbResponseBody);    jResp.LoadSb(sbResponseBody);    jResp.put_EmitCompact(false);    jResp.put_I(i);    strVal = jResp.stringOf(L"in_meeting.webinar_live_streaming.live_streaming_service[i]");    i = i + 1;    i = 0;    count_i = jResp.SizeOfArray(L"audio_conferencing.toll_free_and_fee_based_toll_call.numbers");    jResp.put_I(i);    code = jResp.stringOf(L"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].code");    country_code = jResp.stringOf(L"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_code");    country_name = jResp.stringOf(L"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].country_name");    v_number = jResp.stringOf(L"audio_conferencing.toll_free_and_fee_based_toll_call.numbers[i].number");    display_number = jResp.stringOf(L"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": ""
    }
  ]
}