Managing and retrieving user settings

[Meditec]

Hi, I’m Michel from Meditec, I have some questions about licensed users’ settings

Description
We recently started testing Zoom APIs, we created an array of licensed users within our account and we would like to know which endpoints should we use in order to:

1. update the user’s settings, either meeting’s or webinar’s capacities and other related info
2. how to retrieve (get) the data to confirm these changes

Endpoints
We tried doing so with these two endpoints:

• GET /users/{userId}/settings
• PATCH /users/{userId}/settings

They both give us a 200/204 OK, but as of now we don’t know for sure what are these endpoints doing, we may have misunderstood how to use them - in that case I’d like to ask where should start looking to get the data we need and which endpoints to call.

Thank you,

Michel

[gianni.zoom (Gianni)]

Hi @Meditec ,

Those endpoints are correct – with GET /users/{userId}/settings, you should receive a response body that contains an object with the user settings along with the 200 response code.

Are you not seeing that? What tool are you using to test the API endpoints?

Thank you,
Gianni

[Meditec]

No, there’s no response body. I’m using Postman and I tried with these URL and query parameters:

{{baseUrl}}/users/{{userid}}/settings?login_type=21&option=meeting_authentication

Could I be missing something?

[gianni.zoom (Gianni)]

Hi @Meditec ,

Do you mind sharing a screenshot of your query params, headers and body tab on Postman?

And I’m assuming you have the authorization set up on that endpoint or inherited from auth if you set authorization at the macro folder level?

Thanks

[Meditec]

Hello Gianni, this morning I tried running a few more tests, these are the results.
(PS. I tried uploading the images directly, but it looks like I’m missing the authorization or trust level to do it - I posted the images on this google drive folder for convenience - Screenshots - Google Drive)

GET

• I managed to get a body with GET /users/{userId}/settings, but it doesn’t tell me much about the settings I can change with PATCH
  Screenshots are on Google Drive.

PATCH

• I sent for testing this body; we were trying to see if we could update the licensed user’s meetings capacity up to 250
  {
  “schedule_meeting”: {
  “host_video”: false,
  “participants_video”: false,
  “audio_type”: “both”,
  “join_before_host”: false,
  “use_pmi_for_scheduled_meetings”: false,
  “use_pmi_for_instant_meetings”: false,
  “enforce_login_with_domains”: false,
  “enforce_login_domains”: “”,
  “not_store_meeting_topic”: false,
  “force_pmi_jbh_password”: false,
  “require_password_for_scheduling_new_meetings”: true,
  “require_password_for_instant_meetings”: true,
  “require_password_for_pmi_meetings”: “all”,
  “pmi_password”: “324325”,
  “pstn_password_protected”: false
  },

  “in_meeting”: {
  “e2e_encryption”: false,
  “chat”: true,
  “private_chat”: true,
  “auto_saving_chat”: false,
  “entry_exit_chime”: “none”,
  “record_play_voice”: false,
  “feedback”: true,
  “co_host”: false,
  “polling”: false,
  “attendee_on_hold”: false,
  “show_meeting_control_toolbar”: false,
  “annotation”: true,
  “remote_control”: true,
  “non_verbal_feedback”: false,
  “breakout_room”: true,
  “breakout_room_schedule”: true,
  “remote_support”: false,
  “closed_caption”: false,
  “group_hd”: false,
  “virtual_background”: true,
  “far_end_camera_control”: false,
  “waiting_room”: false,
  “allow_live_streaming”: false,
  “show_a_join_from_your_browser_link”: true,
  “join_from_mobile”: true,
  “join_from_desktop”: true,
  “webinar_live_streaming”: {
  “enable”: true,
  “live_streaming_service”: [
  “facebook”,
  “workplace_by_facebook”,
  “youtube”,
  “custom_live_streaming_service”
  ],
  “custom_service_instructions”: “specific instructions”,
  “live_streaming_reminder”: true
  },
  “webinar_chat”: {
  “enable”: true,
  “allow_panelists_chat_with”: 1,
  “allow_attendees_chat_with”: 1,
  “default_attendees_chat_with”: 1,
  “allow_panelists_send_direct_message”: true,
  “allow_users_save_chats”: 1,
  “allow_auto_save_local_chat_file”: 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”: true,
  “cloud_recording”: true,
  “record_speaker_view”: true,
  “record_gallery_view”: false,
  “record_audio_file”: true,
  “record_audio_file_each_participant”: true,
  “save_chat_text”: true,
  “show_timestamp”: false,
  “recording_audio_transcript”: false,
  “auto_recording”: “none”,
  “auto_delete_cmr”: false
  },
  “feature”: {
  “meeting_capacity”: 250,
  “large_meeting”: false,
  “webinar”: true,
  “cn_meeting”: true,
  “in_meeting”: false
  },
  “integration”: {
  “linkedin_sales_navigator”: false
  }
  }

• URL , endpoint and headers can be seen on Google Drive

Most of all, we would like to know how should we proceed to retrieve from the user’s:

• ability/license to host
• meetings/webinar capacities
• how to get the URL to join the user’s meeting - since we are using the users as persistent “classrooms” that people may join with a password

About Authentication: we’re using “Bearer Token” with JWT and no authentication problems arise during my tests as of now.

Hope I’ve been clearer this time and that I’m not asking too much.
Thank you for your time.

Michel

[donte.zoom (Donte)]

Hi, @Meditec,

Thank you for your questions. I noticed 21 was entered as the login method, please note that this method is only available in China.

@Meditec

GET

• I managed to get a body with GET /users/{userId}/settings , but it doesn’t tell me much about the settings I can change with PATCH
  Screenshots are on Google Drive.

→ You can make updates to those settings with PATCH request via the “meeting_authentication”,
“recording_authentication”, or “meeting_secuirty” objects:

@Meditec

Most of all, we would like to know how should we proceed to retrieve from the user’s:

• ability/license to host
• meetings/webinar capacities

→ The Get user Settings response payload includes information pertaining to the user’s features.
Ex.

@Meditec

• how to get the URL to join the user’s meeting - since we are using the users as persistent “classrooms” that people may join with a password

→ If you intend to enable registration for your meetings, you can use Get a meeting registrant API to get details on a specific user who has registered for the meeting. The user’s unique join_url can be found in the response payload :