Get locked settings

Account Locked Settings allow you turn settings on or off for all users in your account. No user except the account admin or account owner can change these settings. With lock settings, you force the settings on for all users.
Use this API to retrieve an account's locked settings.

Note: This API can be used by Zoom Accounts that are on a Pro or a higher plan as well accounts that have master and sub accounts options enabled.

Prerequisites:

Pro or a higher paid account.

Scope: account:read:admin.

Rate Limit Label: Medium

Scope: account:read:admin

{ "email_notification": { "alternative_host_reminder": true, "cancel_meeting_reminder": true, "cloud_recording_available_reminder": true, "jbh_reminder": true, "schedule_for_host_reminder": true }, "in_meeting": { "alert_guest_join": true, "allow_show_zoom_windows": true, "annotation": true, "anonymous_question_answer": true, "attendee_on_hold": false, "auto_answer": true, "auto_saving_chat": true, "breakout_room": true, "chat": true, "closed_caption": true, "co_host": true, "custom_data_center_regions": true, "dscp_marking": true, "e2e_encryption": true, "entry_exit_chime": "string", "far_end_camera_control": true, "feedback": true, "file_transfer": true, "group_hd": true, "original_audio": true, "polling": true, "post_meeting_feedback": true, "private_chat": true, "remote_control": true, "request_permission_to_unmute": true, "screen_sharing": true, "sending_default_email_invites": true, "show_meeting_control_toolbar": true, "stereo_audio": true, "use_html_format_email": true, "virtual_background": true, "webinar_question_answer": true, "whiteboard": true }, "recording": { "account_user_access_recording": true, "auto_delete_cmr": true, "auto_recording": "string", "cloud_recording": true, "cloud_recording_download": true, "host_delete_cloud_recording": true, "ip_address_access_control": { "enable": true, "ip_addresses_or_ranges": "string" }, "local_recording": true, "prevent_host_access_recording": true, "recording_authentication": "string" }, "schedule_meeting": { "audio_type": true, "embed_password_in_join_link": true, "enforce_login": true, "enforce_login_domains": "string", "enforce_login_with_domains": true, "host_video": true, "join_before_host": true, "meeting_authentication": true, "not_store_meeting_topic": true, "participant_video": true, "require_password_for_instant_meetings": true, "require_password_for_pmi_meetings": true, "require_password_for_scheduling_new_meetings": true }, "telephony": { "telephony_regions": true, "third_party_audio": true }, "tsp": { "call_out": true, "show_international_numbers_link": true } }

请求参数

Path 参数

accountId

string

必需

Unique Identifier of the account. To retrieve locked settings of the master account or a regular account, provide "me" as the value of this field.
To retrieve locked settings of a sub account, provide the Account ID of the sub account in this field.

Query 参数

option

string

可选

meeting_security: Use this query parameter to view meeting security settings applied on the account.

custom_query_fields

string

可选

Provide the name of the field by which you would like to filter the response. For example, if you provide "host_video" as the value of this field, you will get a response similar to the following:

{
"schedule_meeting": {
"host_video": false
}
}

You can provide multiple values by separating them with commas(example: "host_video,participant_video”).

返回响应

🟢200**Error Code:** `200`<br> Only available for paid account:$accountId. **HTTP Status Code:** `200`<br> Locked settings for the Account returned.

application/json

Body

可选

One of

object

Meeting/Webinar Security Settings

email_notification

object

可选

in_meeting

object

可选

recording

object

可选

schedule_meeting

object

可选

telephony

object

可选

tsp

object

可选

🟠400**HTTP Status Code:** `400`<br> **Error Code:** `2001`<br> Account does not exist: $subAccountId.