Update a user's presence status

PUT

/users/{userId}/presence_status

Users

Users in the Zoom desktop client and mobile apps are assigned with a presence status. The presence status informs users of their contact's availability. Users can also change their own presence status to be either "Away", "Do not disturb", or "Available".

Use this API to update a user's presence status. A user's status can not be updated more than once per minute, i.e., you can only submit a maximum of 1 update request/minute for a single user.
Note that a user's presence status can not be updated using this API if the user is not logged in to the Zoom client.

Scopes: user:write, user:write:admin
Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://api.zoom.us/v2/users//presence_status'

响应示例

204 - 示例 1

null

请求参数

Path 参数

userId

string

必需

Body 参数multipart/form-data

duration

integer

可选

If you're updating the status to Do_Not_Disturb, specify a duration in minutes for which the status should remain as Do_Not_Disturb.

The default value is 20 minutes and the maximum allowed value is 1440 minutes.

>= 20<= 1440

status

enum<string>

可选

Presence status of the user. The value can be set to one of the following:

Away

Do_Not_Disturb

Available

Users who are on Zoom Client with a version lower than 5.3.0 can update the status from:

Away to Do_Not_Disturb

Available to Do-Not_Disturb

Users who are on Zoom Client 5.3.0 or higher can update the status from:

Do_Not_Disturb to Away

Do_Not_Disturb to Available

Available to Away

Away to Available

枚举值:

Do_No_DisturbAwayAvailable

返回响应

🟢204**HTTP Status Code:** `204` Status updated succesfully.

application/json

Body

No schema defined

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `5301` Request to update the presence status of this user failed. **Error Code:** `5411` Unauthorized request. You do not have permission to update the presence status of this use

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `1001` User does not exist: {userId}.

🟠429**HTTP Status Code:** `429` **Too Many Requests** Too many requests submitted to update the presence status of this user. Please wait for the request to be processed and try again later.

修改于 2024-04-24 09:06:48

Upload a user's profile picture

Delete user schedulers