Navigation: Schema: Users > Tables

UsersByUserIdSettings

Retrieve a user's settingsRetrieve a user's settings

Catalog: Zoom

Schema: Users

This is a read-only table function. The Zoom API may not support changing the data or the Invantive SQL driver for Zoom does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Zoom API.

Select Zoom API URL: /users/{userId}/settings

Insert Zoom API URL: /users/{userId}/settings

Update Zoom API URL: /users/{userId}/settings

Delete Zoom API URL: /users/{userId}/settings

Field Selection Method: NotRequired

Select Zoom API Operation: get /users/{userId}/settings

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function UsersByUserIdSettings. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Default Value	Documentation
login_type	string	☐		Values: 0, 1, 99, 100, 101.
userId	string	☑		The user ID or email address

Table Function Columns

The columns of the table function UsersByUserIdSettings are shown below. Each column has an SQL data type.

Name	Data Type	Required	Documentation
email_notification_alternative_host_reminder	boolean	☐	When an alternative host is set or removed from a meeting
email_notification_cancel_meeting_reminder	boolean	☐	When a meeting is cancelled
email_notification_jbh_reminder	boolean	☐	When attendees join meeting before host
feature_cn_meeting	boolean	☐	CN meeting feature
feature_in_meeting	boolean	☐	IN meeting feature
feature_large_meeting_capacity	int64	☐	Large meeting capacity, can be 100, 200, 300 or 500, depends on if having related large meeting capacity plan subscription or not
feature_large_meeting	boolean	☐	Large meting feature
feature_meeting_capacity	int64	☐	User’s meeting capacity
feature_webinar_capacity	int64	☐	Webinar capacity, can be 100, 500, 1000, 3000, 5000 or 10000, depends on if having related webinar capacity plan subscription or not
feature_webinar	boolean	☐	Webinar feature
in_meeting_allow_live_streaming	boolean	☐	Allow live streaming
in_meeting_annotation	boolean	☐	Annotation
in_meeting_attendee_on_hold	boolean	☐	Allow host to put attendee on hold
in_meeting_attention_tracking	boolean	☐	Attention tracking
in_meeting_auto_saving_chat	boolean	☐	Auto saving chats
in_meeting_breakout_room	boolean	☐	Breakout room
in_meeting_chat	boolean	☐	Chat
in_meeting_closed_caption	boolean	☐	Closed caption
in_meeting_co_host	boolean	☐	Co-host
in_meeting_custom_live_streaming	boolean	☐	Custom live streaming
in_meeting_custom_service_instructions	string	☐	Custom service instructions
in_meeting_e2e_encryption	boolean	☐	End-to-end encryption
in_meeting_entry_exit_chime	string	☐	Play sound on join/leave
in_meeting_far_end_camera_control	boolean	☐	Far end camera control
in_meeting_feedback	boolean	☐	Feedback to Zoom
in_meeting_file_transfer	boolean	☐	File transfer
in_meeting_group_hd	boolean	☐	Group HD video
in_meeting_non_verbal_feedback	boolean	☐	Non-verbal feedback
in_meeting_polling	boolean	☐	Polling
in_meeting_private_chat	boolean	☐	Private chat
in_meeting_record_play_voice	boolean	☐	Record and play their own voice
in_meeting_remote_control	boolean	☐	Remote control
in_meeting_remote_support	boolean	☐	Remote support
in_meeting_share_dual_camera	boolean	☐	Share dual camera (Deprecated)
in_meeting_virtual_background	boolean	☐	Virtual background
in_meeting_waiting_room	boolean	☐	Waiting room
in_meeting_workplace_by_facebook	boolean	☐	Workplace by facebook
recording_auto_delete_cmr_days	int64	☐	A specified number of days of auto delete cloud recordings
recording_auto_delete_cmr	boolean	☐	Auto delete cloud recordings
recording_auto_recording	string	☐	Automatic recording
recording_cloud_recording	boolean	☐	Cloud recording
recording_local_recording	boolean	☐	Local recording
recording_record_audio_file	boolean	☐	Record an audio only file
recording_record_gallery_view	boolean	☐	Record the gallery view
recording_record_speaker_view	boolean	☐	Record the active speaker view
recording_recording_audio_transcript	boolean	☐	Audio transcript
recording_save_chat_text	boolean	☐	Save chat text from the meeting
recording_show_timestamp	boolean	☐	Show timestamp on video
schedule_meeting_audio_type	string	☐	Determine how participants can join the audio portion of the meeting
schedule_meeting_force_pmi_jbh_password	boolean	☐	Require a password for Personal Meetings if attendees can join before host
schedule_meeting_host_video	boolean	☐	Host video
schedule_meeting_join_before_host	boolean	☐	Join before host
schedule_meeting_participants_video	boolean	☐	Participants video
schedule_meeting_pstn_password_protected	boolean	☐	Generate and require password for participants joining by phone
telephony_audio_conference_info	string(2048)	☐	3rd party audio conference info
telephony_show_international_numbers_link	boolean	☐	Show international numbers link on the invitation email
telephony_third_party_audio	boolean	☐	3rd party audio conference

16-06-2022 17:21 Version 22.1.46-BETA+3385

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.

Please enable JavaScript to view this site.

Zoom API Data Model

UsersByUserIdSettings

Parameters of Table Function

Table Function Columns

Important Safety and Usage Information