Various issues in GET User Settings API / API Documentation

API and Webhooks
1

Description
I’m currently developing an application that calls the Zoom API, and I’ve noticed some issues with both the API responses, and the API Documentation.

These issues are present when calling the GET /accounts/{accountId}/settings endpoint with no option query parameter.

Under “recording” - the field “recording_disclaimer” is always false, even though it is enabled in the UI.
Under “recording” - “required_password_for_shared_cloud_recordings” is missing from the API documentation. There is a similar field, “required_password_for_existing_cloud_recordings” that is present however.
Under “in_meeting” - there is no field in the API response that corresponds to the “Non-verbal feedback” option in the UI.
Under “in_meeting” - “request_permission_to_unmute” should be “request_permission_to_unmute_participants”.
Under “tsp” - there is just an empty JSON object. i.e: “tsp” : {}

These issues are present when calling the GET /accounts/{accountId}/settings endpoint with the “security” option query parameter.

“admin_change_user_info” is missing from documentation. There is “admin_change_name_pic” present in the documentation, but it looks like that is now a deprecated field.
“user_modifiable_info_by_admin” is missing from documentation, which is a string array that shows up when “admin_change_user_info” is true. The possible values are “name”, “profile_picture”, “sign_in_email” and “host_key”.

Which App Type (OAuth / Chatbot / JWT / Webhook)?
OAuth App

Which Endpoint/s?
https://marketplace.zoom.us/docs/api-reference/zoom-api/accounts/accountsettings

How To Reproduce (If applicable)
curl --location --request GET ‘https://api.zoom.us/v2/accounts/me/settings’
–header ‘Authorization: Bearer [access-token]’

Additional context
Currently using a paid account.

2

Hey @ns-rchang,

Are you able to share an example of the response you’re seeing here? I’ll use that to confirm the expected behavior here with our team.

Thanks,
Max

3

Hi Max,

This is the response I see when calling the GET account settings endpoint.

{
   "email_notification" : {
      "alternative_host_reminder" : false,
      "cancel_meeting_reminder" : false,
      "cloud_recording_available_reminder" : false,
      "jbh_reminder" : false,
      "schedule_for_reminder" : false
   },
   "feature" : {
      "meeting_capacity" : 300
   },
   "in_meeting" : {
      "alert_guest_join" : true,
      "allow_live_streaming" : true,
      "allow_participants_to_rename" : false,
      "allow_show_zoom_windows" : true,
      "annotation" : false,
      "attendee_on_hold" : false,
      "auto_answer" : true,
      "auto_saving_chat" : false,
      "breakout_room" : true,
      "chat" : false,
      "closed_caption" : true,
      "co_host" : true,
      "custom_data_center_regions" : false,
      "custom_live_streaming_service" : false,
      "dscp_audio" : 56,
      "dscp_marking" : false,
      "dscp_video" : 40,
      "e2e_encryption" : true,
      "entry_exit_chime" : "all",
      "far_end_camera_control" : true,
      "feedback" : false,
      "file_transfer" : false,
      "group_hd" : false,
      "live_streaming_facebook" : true,
      "live_streaming_youtube" : true,
      "meeting_reactions" : true,
      "p2p_connetion" : false,
      "p2p_ports" : false,
      "participants_to_place_in_waiting_room" : 0,
      "polling" : false,
      "ports_range" : "",
      "post_meeting_feedback" : false,
      "private_chat" : false,
      "record_play_own_voice" : true,
      "remote_control" : false,
      "request_permission_to_unmute_participants" : true,
      "screen_sharing" : true,
      "sending_default_email_invites" : true,
      "show_a_join_from_your_browser_link" : true,
      "show_meeting_control_toolbar" : false,
      "stereo_audio" : false,
      "use_html_format_email" : true,
      "virtual_background" : false,
      "virtual_background_settings" : {
         "enable" : false
      },
      "waiting_room" : true,
      "watermark" : true,
      "webinar_chat" : {},
      "webinar_live_streaming" : {},
      "whiteboard" : false,
      "who_can_share_screen" : "all",
      "who_can_share_screen_when_someone_is_sharing" : "all",
      "workplace_by_facebook" : true
   },
   "integration" : {
      "box" : true,
      "dropbox" : true,
      "google_calendar" : true,
      "google_drive" : true,
      "microsoft_one_drive" : true
   },
   "profile" : {
      "recording_storage_location" : {
         "allowed_values" : [
            "US",
            "AU",
            "CA",
            "DE",
            "SG",
            "BR",
            "JP"
         ],
         "value" : "US"
      }
   },
   "recording" : {
      "account_user_access_recording" : false,
      "allow_recovery_deleted_cloud_recordings" : false,
      "archive" : {
         "enable" : false
      },
      "auto_delete_cmr" : false,
      "auto_recording" : "cloud",
      "cloud_recording" : true,
      "cloud_recording_download" : false,
      "cloud_recording_download_host" : false,
      "host_delete_cloud_recording" : false,
      "ip_address_access_control" : {
         "enable" : false
      },
      "local_recording" : true,
      "prevent_host_access_recording" : true,
      "record_audio_file" : false,
      "record_gallery_view" : true,
      "record_speaker_view" : false,
      "recording_audio_transcript" : false,
      "recording_disclaimer" : false,
      "recording_password_requirement" : {
         "have_letter" : true,
         "have_number" : true,
         "have_special_character" : true,
         "length" : 8,
         "only_allow_numeric" : false
      },
      "required_password_for_shared_cloud_recordings" : false,
      "save_chat_text" : false,
      "show_timestamp" : true
   },
   "schedule_meeting" : {
      "audio_type" : "both",
      "embed_password_in_join_link" : true,
      "enforce_login" : true,
      "enforce_login_domains" : "",
      "enforce_login_with_domains" : false,
      "force_pmi_jbh_password" : true,
      "host_video" : true,
      "jbh_time" : 0,
      "join_before_host" : true,
      "meeting_password_requirement" : {
         "consecutive_characters_length" : 4,
         "have_letter" : true,
         "have_number" : true,
         "have_special_character" : true,
         "have_upper_and_lower_characters" : true,
         "length" : 6,
         "only_allow_numeric" : false,
         "weak_enhance_detection" : true
      },
      "mute_upon_entry" : true,
      "not_store_meeting_topic" : false,
      "participant_video" : true,
      "personal_meeting" : false,
      "require_password_for_pmi_meetings" : "all",
      "require_password_for_scheduled_meetings" : false,
      "require_password_for_scheduling_new_meetings" : true,
      "use_pmi_for_instant_meetings" : true,
      "use_pmi_for_scheduled_meetings" : false
   },
   "security" : {
      "admin_change_name_pic" : false,
      "hide_billing_info" : true,
      "import_photos_from_devices" : false,
      "password_requirement" : {
         "consecutive_characters_length" : 4,
         "have_special_character" : false,
         "minimum_password_length" : 9,
         "weak_enhance_detection" : true
      }
   },
   "telephony" : {
      "audio_conference_info" : "",
      "telephony_regions" : {
         "allowed_values" : [
            "CATB",
            "EUTB_FR",
            "EUTB_AM",
            "USTB",
            "AUTB",
            "EUTB"
         ],
         "selection_value" : "USTB"
      },
      "third_party_audio" : false
   },
   "tsp" : {},
   "zoom_rooms" : {
      "auto_start_stop_scheduled_meetings" : false,
      "cmr_for_instant_meeting" : true,
      "force_private_meeting" : false,
      "hide_host_information" : false,
      "list_meetings_with_calendar" : false,
      "start_airplay_manually" : false,
      "ultrasonic" : true,
      "upcoming_meeting_alert" : true,
      "weekly_system_restart" : true,
      "zr_post_meeting_feedback" : false
   }
}
4

Hey @ns-rchang,

Thanks for following up on this!

I reached out to our engineering team about this (ZOOM-309051). I’ll let you know when I hear more.

I created a ticket with our documentation team for these issues (DEVELOPERS-1820).

If you would like this feature to be considered for a future release, I recommend posting in the Feature Requests category.

I’ve reached out to our engineering team about this (ZOOM-309054)

I’ll get back to you as soon as I can!

Thanks,
Max

5

Hi @MaxM,

Are there any updates on ZOOM-309051 and ZOOM-309054?

In addition, could another ticket be created for this request:

Under “in_meeting” - there is no field in the API response that corresponds to the “Non-verbal feedback” option in the UI.

This seems to be a bug since the other fields are present in the API but this field is missing, so I don’t think this is a feature request.

Thanks,
Vinod

6

It looks like this field will only change in the API for enterprise or higher accounts. Our engineering team confirmed this.

It looks like TSP Audio will need to be enabled on the account first. Please send an email to developersupport@zoom.us with a link to this thread and the relevant account ID. I’ll use that to set it up.

You can set the non_verbal_feedback option in the Update User Settings API or at the account or group level. If you wanted the ability to set this at the meeting level, this would fall under a feature request for the API.

If you end up making one, please forward the link to me.

Here is more information on how that can be set up in the web portal:

https://support.zoom.us/hc/en-us/articles/115001286183-Nonverbal-Feedback-During-Meetings#h_6922651d-d279-44bd-b36a-cc2a30696c70

I hope that helps!

Thanks,
Max

7

Hi Max,

Thanks for the response - have some follow up comments here:

For ZOOM-309051:
I checked that even though I am able to change the setting from my Zoom account, the API response for “recording_disclaimer” is always false.

I also created a feature request for adding the non_verbal_feedback option to the API response here: Add non-verbal feedback enabled value in User Settings API response.

Thanks!
-Raymond

8

Hey @ns-rchang,

That’s correct, our team confirmed this is the expected behavior for plans lower than enterprise.

Thank you for providing that! This will allow our engineering team to consider the feature for a future release.

Thanks,
Max

9

This topic was automatically closed 30 days after the last reply. New replies are no longer allowed.