Zoom API
  1. Users
Zoom API
  • Accounts
    • List sub accounts
      GET
    • Create a sub account
      POST
    • Disassociate a sub account
      DELETE
    • Get sub account details
      GET
    • Get locked settings
      GET
    • Update locked settings
      PATCH
    • Get managed domains
      GET
    • Update options
      PATCH
    • Update the account owner
      PUT
    • Get settings
      GET
    • Update settings
      PATCH
    • Delete virtual background files
      DELETE
    • Upload virtual background files
      POST
    • Get trusted domains
      GET
  • Billing
    • Get billing information
    • Update billing information
    • List billing invoices
    • Get invoice details
    • Get plan Information
    • Subscribe plans
    • Subscribe additional plan
    • Update an additional plan
    • Cancel additional plans
    • Update a base plan
    • Cancel a base plan
    • Get plan usage
    • Download an invoice file
  • Phone
    • Update BYOC settings
    • Set up a Zoom Phone account
    • Assign SIP trunks
    • Update SIP trunk details
    • Add BYOC phone numbers
    • Get account's call logs
    • List calling plans
    • Change main company number
    • List phone numbers
    • Get phone number details
    • Update phone number details
    • Get call recordings
    • List setting templates
    • Add a setting template
    • Get setting template details
    • Update a setting template
    • List BYOC SIP trunks
    • List phone users
    • Get user's profile
    • Update user's profile
    • Get user's call logs
    • Delete a user's call log
    • Assign calling plan to a user
    • Unassign user's calling plan
    • Assign phone number to user
    • Unassign phone number
    • Get user's recordings
    • Get user's settings
    • Remove shared access
    • Update shared access
    • Set up shared access
    • Get user's voicemails
    • Delete a voicemail
  • Cloud Recording
    • List recordings of an account
    • List archived files
    • Delete meeting recordings
    • Get meeting recordings
    • List recording registrants
    • Create a recording registrant
    • Get registration questions
    • Update registration questions
    • Update registrant's status
    • Get meeting recording settings
    • Update meeting recording settings
    • Recover meeting recordings
    • Delete a meeting recording file
    • Recover a single recording
    • List all recordings
  • SIP Connected Audio
    • List internal call-out countries
    • Add internal call-out countries
    • Delete internal call-out country
    • List internal numbers
    • Add internal numbers
    • Delete an internal number
    • Delete all numbers
    • Assign numbers
    • Assign SIP trunk configuration
    • List SIP trunks
    • Assign SIP trunks
    • Delete a SIP trunk
    • List SIP trunk numbers
  • Users
    • Switch a user's account
      PUT
    • List users
      GET
    • Create users
      POST
    • Check a user email
      GET
    • Get user's ZAK
      GET
    • Check a user's PM room
      GET
    • Delete a user
      DELETE
    • Get a user
      GET
    • Update a user
      PATCH
    • Delete user assistants
      DELETE
    • List user assistants
      GET
    • Add assistants
      POST
    • Delete a user assistant
      DELETE
    • Update a user's email
      PUT
    • Update a user's password
      PUT
    • Get user permissions
      GET
    • Upload a user's profile picture
      POST
    • Update a user's presence status
      PUT
    • Delete user schedulers
      DELETE
    • List user schedulers
      GET
    • Delete a scheduler
      DELETE
    • Get user settings
      GET
    • Update user settings
      PATCH
    • Delete virtual background files
      DELETE
    • Upload virtual background files
      POST
    • Update user status
      PUT
    • Revoke a user's SSO token
      DELETE
    • Get a user token
      GET
  • Chat Channels
    • Delete a channel
    • Get a channel
    • Update a channel
    • Leave a channel
    • Join a channel
    • Remove a member
    • List user's channels
    • Create a channel
  • Contacts
    • List user's contacts
    • Get user's contact details
    • Search company contacts
  • Chat Channels (Account-level)
    • Delete a channel
    • Get a channel
    • Update a channel
    • List channel members
    • Invite channel members
    • Remove a member
  • Chat Messages
    • List user's chat messages
    • Send a chat message
    • Delete a message
    • Update a message
  • Groups
    • List groups
    • Create a group
    • Delete a group
    • Get a group
    • Update a group
    • Get locked settings
    • Update locked settings
    • List group members
    • Add group members
    • Delete a group member
    • Update a group member
    • Get a group's settings
    • Update a group's settings
    • Delete virtual background files
    • Upload virtual background files
  • Devices
    • List H.323/SIP devices
    • Create a H.323/SIP device
    • Delete a H.323/SIP device
    • Update a H.323/SIP device
  • Chatbot Messages
    • Send chatbot messages
    • Delete a chatbot message
    • Edit a chatbot message
  • IM Chat
    • Get IM chat sessions
    • Get IM chat messages
    • Send IM messages
    • Get user’s IM messages
  • IM Groups
    • List IM directory groups
    • Create an IM directory group
    • Delete an IM directory group
    • Retrieve an IM directory group
    • Update an IM directory group
    • List IM directory group members
    • Add IM directory group members
    • Delete an IM directory group member
  • Meetings
    • Use in-Meeting recording controls
    • Delete a meeting
    • Get a meeting
    • Update a meeting
    • Perform batch poll creation
    • Get meeting invitation
    • Get live stream details
    • Update a live stream
    • Update Live Stream Status
    • List meeting polls
    • Create a meeting poll
    • Delete a meeting poll
    • Get a meeting poll
    • Update a meeting poll
    • List meeting registrants
    • Add meeting registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a meeting registrant
    • Update meeting status
    • List ended meeting instances
    • List past meeting's poll results
    • Get past meeting details
    • Get past meeting participants
    • List meeting templates
    • List meetings
    • Create a meeting
  • Dashboards
    • List Zoom meetings client feedback
    • Get zoom meetings client feedback
    • List client meeting satisfaction
    • Get CRC port usage
    • Get IM metrics
    • Get top 25 Zoom Rooms with issues
    • Get issues of Zoom Rooms
    • List meetings
    • Get meeting details
    • List meeting participants
    • List meeting participants QoS
    • Get post meeting feedback
    • Get sharing/recording details
    • Get meeting participant QoS
    • List webinars
    • Get webinar details
    • Get webinar participants
    • List webinar participant QoS
    • Get post webinar feedback
    • Get sharing/recording details
    • Get webinar participant QoS
    • List Zoom Rooms
    • Get top 25 issues of Zoom Rooms
    • Get Zoom Rooms details
    • List call logs
    • Get call QoS
    • Get call details from call log
  • Deprecated API Endpoints
    • List past meeting's files
    • List past webinar files
  • Webinars
    • Get webinar absentees
    • List past webinar instances
    • List webinar participants
    • List past webinar poll results
    • List Q&A of past webinar
    • List webinar templates
    • List webinars
    • Create a webinar
    • Delete a webinar
    • Get a webinar
    • Update a webinar
    • Perform batch registration
    • Remove panelists
    • List panelists
    • Add panelists
    • Remove a panelist
    • List a webinar's polls
    • Create a webinar's poll
    • Delete a webinar poll
    • Get a webinar poll
    • Update a webinar poll
    • List webinar registrants
    • Add a webinar registrant
    • List registration questions
    • Update registration questions
    • Update registrant's status
    • Delete a webinar registrant
    • Get a webinar registrant
    • Update webinar status
    • Get webinar tracking sources
  • Phone Auto Receptionists
    • Add an auto receptionist
    • Update auto receptionist details
    • Unassign all phone numbers
    • Assign phone numbers
    • Unassign a phone number
  • Phone Blocked List
    • List blocked lists
    • Create a blocked list
    • Delete a blocked list
    • Get blocked list details
    • Update a blocked list
  • Phone Call Queues
    • List call queues
    • Create a call queue
    • Delete a call queue
    • Get call queue details
    • Update call queue details
    • Change call queue manager
    • Unassign all members
    • Add members to a call queue
    • Unassign a member
    • Unassign all phone numbers
    • Assign numbers to a call queue
    • Unassign a phone number
    • Get call queue recordings
  • Common Area Phones
    • List common area phones
    • Add a common area phone
    • Delete a common area phone
    • Get common area phone details
    • Update common area phone
  • Phone Devices
    • List devices
    • Add a device
    • Delete a device
    • Get device details
    • Update a device
  • Phone Reports
    • Get operation logs report
  • Phone Shared Line Groups
    • List shared line groups
    • Create a shared line group
    • Delete a shared line group
    • Get a shared line group
    • Update a shared line group
    • Unassign members of a shared line group
    • Add members to a shared line group
    • Unassign a member from a shared line group
    • Assign phone numbers
    • Unassign a phone number
  • Phone Site
    • List phone sites
    • Create a phone site
    • Delete a phone site
    • Get phone site details
    • Update phone site details
  • Reports
    • Get sign In / sign out activity report
    • Get cloud recording usage report
    • Get daily usage report
    • Get meeting detail reports
    • Get meeting participant reports
    • Get meeting poll reports
    • Get operation logs report
    • Get telephone reports
    • Get active/inactive host reports
    • Get meeting reports
    • Get webinar detail reports
    • Get webinar participant reports
    • Get webinar poll reports
    • Get webinar Q&A report
  • Roles
    • List roles
    • Create a role
    • Delete a role
    • Get role information
    • Update role information
    • List members in a role
    • Assign a role
    • Unassign a role
  • Rooms
    • List Zoom Rooms
    • Add a Zoom Room
    • List digital signage contents
    • Update E911 digital signage
    • Check-in or check-out of a Zoom Room
    • Delete a Zoom Room
    • Get Zoom Room profile
    • Update a Zoom Room profile
    • List Zoom Room devices
    • Change a Zoom Room's location
    • Get Zoom Room settings
    • Update Zoom Room settings
  • Rooms Account
    • Get Zoom Room account profile
    • Update Zoom Room account profile
    • Get Zoom Room account settings
    • Update Zoom Room account settings
  • Rooms Location
    • List Zoom Room locations
    • Add a location
    • Get Zoom Room location structure
    • Update Zoom Rooms location structure
    • Get Zoom Room location profile
    • Update Zoom Room location profile
    • Change the assigned parent location
    • Get location settings
    • Update location settings
  • Rooms Devices
    • Change Zoom Rooms' app version
  • SIP Phone
    • List SIP phones
    • Enable SIP phone
    • Delete SIP phone
    • Update SIP phone
  • TrackingField
    • List tracking fields
    • Create a tracking field
    • Delete a tracking field
    • Get a tracking field
    • Update a tracking field
  • TSP
    • Get account's TSP information
    • Update account's TSP information
    • List user's TSP accounts
    • Add a user's TSP account
    • Set global dial-in URL for a TSP user
    • Delete a user's TSP account
    • Get a user's TSP account
    • Update a TSP account
  • PAC
    • List a user's PAC accounts
  • Data Compliance
  • Webhooks
  • master account APIs
  1. Users

Get user settings

GET
/users/{userId}/settings
Users
Retrieve a user's settings.

Scopes: user:read:admin user:read
Rate Limit Label: Medium
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://api.zoom.us/v2/users//settings'
响应示例响应示例
200 - response
{
  "email_notification": {
    "alternative_host_reminder": false,
    "cancel_meeting_reminder": false,
    "jbh_reminder": false,
    "schedule_for_reminder": false
  },
  "feature": {
    "cn_meeting": true,
    "in_meeting": false,
    "large_meeting": false,
    "meeting_capacity": 100,
    "webinar": false,
    "zoom_phone": false
  },
  "in_meeting": {
    "allow_live_streaming": false,
    "annotation": true,
    "attendee_on_hold": false,
    "auto_saving_chat": false,
    "breakout_room": false,
    "chat": true,
    "closed_caption": true,
    "co_host": false,
    "custom_data_center_regions": true,
    "data_center_regions": [
      "AU",
      "CN",
      "EU",
      "HK",
      "LA",
      "TY",
      "US"
    ],
    "e2e_encryption": false,
    "entry_exit_chime": "all",
    "far_end_camera_control": false,
    "feedback": true,
    "group_hd": false,
    "non_verbal_feedback": false,
    "polling": true,
    "private_chat": true,
    "record_play_voice": false,
    "remote_control": true,
    "remote_support": false,
    "show_meeting_control_toolbar": false,
    "virtual_background": true,
    "waiting_room": false
  },
  "recording": {
    "auto_delete_cmr": false,
    "auto_recording": "none",
    "cloud_recording": true,
    "local_recording": true,
    "record_audio_file": true,
    "record_gallery_view": false,
    "record_speaker_view": true,
    "recording_audio_transcript": true,
    "recording_password_requirement": {
      "have_letter": true,
      "have_number": true,
      "have_special_character": true,
      "length": 8,
      "only_allow_numeric": false
    },
    "save_chat_text": true,
    "show_timestamp": false
  },
  "schedule_meeting": {
    "audio_type": "both",
    "embed_password_in_join_link": false,
    "force_pmi_jbh_password": true,
    "host_video": true,
    "join_before_host": false,
    "meeting_password_requirement": {
      "have_letter": true,
      "have_number": false,
      "have_special_character": false,
      "length": 6,
      "only_allow_numeric": false
    },
    "not_store_meeting_topic": false,
    "participants_video": false,
    "pmi_password": "98654",
    "pstn_password_protected": false,
    "require_password_for_pmi_meetings": "all",
    "require_password_for_scheduling_new_meetings": false,
    "use_pmi_for_instant_meetings": true,
    "use_pmi_for_scheduled_meetings": false
  },
  "telephony": {
    "audio_conference_info": "",
    "show_international_numbers_link": false,
    "third_party_audio": false
  },
  "tsp": {
    "call_out": true,
    "call_out_countries": [
      "USA"
    ],
    "show_international_numbers_link": false
  }
}

请求参数

Path 参数
userId
string 
必需
The user ID or email address of the user. For user-level apps, pass me as the value for userId.
Query 参数
login_type
enum<string> 
可选
0 - Facebook.
1 - Google.
99 - API.
100 - Zoom.
101 - SSO.
枚举值:
0199100101
option
enum<string> 
可选
meeting_authentication: Use this query parameter to view meeting authentication configuration applied on the user's account.
recording_authentication: Use this query parameter to view recording authentication configuration applied on the user's account.
meeting_security: Use this query parameter to view meeting security settings applied on the user's account.
枚举值:
meeting_authenticationrecording_authentication
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**HTTP Status Code:** `200`<br> User settings returned.
application/json
Body
可选
One of
email_notification
object 
User settings: Notification settings
可选
feature
object 
User settings: Feature settings
可选
in_meeting
object 
User settings: Meeting settings
可选
profile
object 
Profile
可选
recording
object 
User settings: Recording settings
可选
schedule_meeting
object 
User settings: Meeting settings
可选
telephony
object 
User settings: Meeting settings
可选
tsp
object 
User settings: TSP settings
可选
Account Settings: TSP.
🟠400**HTTP Status Code:** `400` **Bad Request**<br> **Error Code:** `1120`<br> A valid invitation to join the Zoom account was not found for this user. <br> This error is thrown if you added a user in your account but the user did not accept the invitation o
🟠404**HTTP Status Code:** `404` **Not Found**<br><br> **Error Code:** `1001`<br> User does not exist: $userId.

【Zoom】API开发者 微信交流群

用微信扫右侧二维码,加入【Zoom】API开发者 交流群,互助沟通

扫码加入交流群
上一页
Delete a scheduler
下一页
Update user settings
Built with