更新用户 - Zoom API 中文版

更新用户的 Zoom profile 信息。对于用户级应用，传递 ['me' 值](h https://developers.zoom.us/docs/api/rest/using-zoom-api/# the-me-关键字) 而不是 'userId' 参数。

** 范围: ** 'user:master'

** [速率限制标签](https://marketplace.zoom.us/docs/api-reference/Rate-limits # 速率限制):** 'LIGHT'

请求参数

Path 参数

userId

string

必需

用户的用户ID或电子邮件地址。对于用户级应用，传递 “我” 值。

accountId

string

帐户的唯一标识符。

必需

Query 参数

login_type

integer

可选

用户的登录方法。

'0' - Facebook OAuth。

'1' - Google OAuth。

'24'-苹果OAuth。

'27' - Microsoft OAuth。

'97'-移动设备。

'98 '-环中央OAuth。

'99'-API用户。

'100'-缩放工作电子邮件。

'101'-单点登录 (SSO)。

这些登录方法仅在中国可用。

'11'-电话号码。

'21'-微信。

'23'-支付宝。

remove_tsp_credentials

string

可选

是否删除用户的TSP凭据。

'true'-查询的ID是员工的唯一ID。

'false'-查询的ID不是员工的唯一ID。

此值默认为 'false' (null)。

Body 参数application/json

timezone

string

可选

用户的 [时区](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 时区)

示例值:

America/Chicago

language

string

用户的语言。

可选

示例值:

English

type

enum<integer>

可选

[用户] 的类型 (https://support.zoom.us/hc/en-us/articles/201363173-缩放-用户-类型-角色)。

'1'-基本。

'2'-许可。

'4'-无会议许可证。

'99'-没有。只有在 [** 创建用户 **](/docs/api-reference/zoom-api/methods # 中使用 'action' 参数的 'ssoCreate' 值创建用户时，才能设置此值操作/用户创建) API。

枚举值:

1299

示例值:

pmi

integer

可选

用户的 [个人会议ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoop-api/# 了解-个人会议id-pmi)。

示例值:

1234567890

custom_attributes

array [object {3}]

可选

用户分配的自定义属性。

name

string

自定义属性的名称。

可选

示例值:

value

string

自定义属性的值

可选

示例值:

key

string

自定义属性的键。

可选

示例值:

cbf_cywdkexrtqc73f97gd4w6g

about_me

string

可选

用户的自我介绍。此字段中不允许使用超链接或HTML代码。

<= 150 字符

示例值:

I'm a Zoom lover!

host_key

string

用户的主机密钥。

可选

>= 6 字符<= 10 字符

示例值:

4692486817

feature

object

可选

有关用户功能的信息。

zoom_phone

boolean

可选

用户是否启用了 ** Zoom Phone ** 功能。

示例值:

true

phone_country

string

已废弃

** 注意 ** 此字段已 ** 弃用 **，以后将不再支持。使用 “phone_numbers” 对象的 “country” 字段选择电话号码国家。

用户的电话号码 [国家ID](https://marketplace.zoom.us/docs/api-参考/其他-参考/缩写-列出 # 个国家)。

示例值:

company

string

用户的公司。

可选

<= 255 字符

示例值:

Example, Inc.

first_name

string

可选

用户的名字。此值不能包含五个以上的中文字符。

<= 64 字符

示例值:

Jill

job_title

string

用户的职位。

可选

<= 128 字符

示例值:

Developer

pronouns_option

enum<integer>

可选

用户的显示代词设置。

'1'-每次加入会议和网络研讨会时询问用户。

'2'-在会议和网络研讨会中始终显示代词。

'3'-不要在会议和网络研讨会中显示代词。

枚举值:

123

示例值:

vanity_name

string

可选

用户的个人会议室名称。

示例值:

My Meeting Room

manager

string <email>

用户的指定管理员。

可选

示例值:

Tara Smith

use_pmi

boolean

可选

即时会议是否使用 [个人会议ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoop-api/# 了解-personal-meeting-id-pmi)。

默认值:

false

示例值:

false

cms_user_id

string

可选

Kaltura用户ID。

示例值:

KDcuGIm1QgePTO8WbOqwIQ

last_name

string

可选

用户的姓氏。此值不能包含五个以上的中文字符。

<= 64 字符

示例值:

Chill

dept

string

用户分配的部门。

可选

示例值:

Developers

display_name

string

可选

用户的显示名称。此值不能包含十个以上的中文字符。

<= 128 字符

示例值:

Jill Chill

phone_numbers

array [object {4}]

可选

有关用户分配的电话号码的信息。

country

string

可选

电话号码的 [国家ID](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 国家)。

示例值:

number

string

电话号码。

可选

示例值:

5550100

code

string

可选

电话号码的国家代码。

示例值:

label

enum<string>

可选

电话号码的标签。

'移动'

“办公室”

“家”

'Fax'

枚举值:

MobileOfficeHomeFax

示例值:

Mobile

group_id

string

可选

提供要向其添加 [pending user](https://support.zoom.us/hc/en-us/articles/201363183-Managing-users # h_13c87a2a-ecd6-40ad-be61-a9935e660edb) 的组的唯一标识符。从 [** 列表组 **](/docs/api-reference/zoom-api/methss # operation/groups) 接口获取该字段的值。

示例值:

RSMaSp8sTEGK0_oamiA2_w

zoom_one_type

enum<integer>

可选

“缩放一个计划” 选项。
“0”-关闭 “缩放一个许可证”。
'16' - Zoom One Business Plus与US/CA Unlimited合作。
'32'-使用UK/IR Unlimited Zoom One Business Plus。
'64'-使用AU/NZ无限放大一个Business Plus。
'128' - Zoom One Business Plus与日本无限。
'33554432'-使用全局选择缩放One Business Plus。
'134217728' - Zoom One Enterprise Premier，US/CA Unlimited。

Gov帐户的 “缩放一个计划” 选项:
“0”-关闭 “缩放一个许可证”。
'16'-放大一个商业加。

教育帐户的 “缩放一个计划” 选项:
“0”-关闭 “缩放一个许可证”。
18014398509481984-为教育学校和校园放大一个。
'72057594037927936' - Zoom One for Education Enterprise Essentials。
'576460752303423488'-针对教育企业学生的Zoom One。
“144115188075855872”-为教育企业加号放大一个。
'137438953472' - Zoom One for Education School and Campus Plus，US/CA Unlimited。
'4294967296' - Zoom One for Education Enterprise Premier，US/CA Unlimited。

枚举值:

016326412833554432

示例值:

location

string

用户的位置。

可选

<= 256 字符

示例值:

San Jose

phone_number

string

已废弃

** 注意 ** 此字段已 ** 弃用 **，以后将不再支持。而是使用 “phone_numbers” 字段将电话号码分配给用户。

用户的电话号码。要更新电话号码，还必须提供 “phone_country” 字段。

示例值:

5550100

pronouns

string

用户的代词。

可选

示例值:

They/Them/Their

linkedin_url

string

可选

用户的LinkedIn链接。URL必须包含 “linkedin.Com”。

示例值:

https://www.linkedin.com/example

plan_united_type

enum<string>

可选

缩放联合类型和许可证。

'1' - Zoom United Pro-United与US/CA Unlimited。

'2' - Zoom United Pro-与UK/IR Unlimited联合。

'4' - Zoom United Pro-与AU/NZ Unlimited联合。

'8' - Zoom United Pro-与Global Select联合。

'16' - Zoom United Pro-与Zoom Phone Pro联合。

'32' - Zoom United Biz-与US/CA Unlimited联合。

'64' - Zoom United Biz-与UK/IR Unlimited联合。

'128' - Zoom United Biz-与AU/NZ Unlimited联合。

'256' - Zoom United Biz-与Global Select联合。

'512' - Zoom United Biz-与Zoom Phone Pro联合。

'1024' - Zoom United Ent-United与US/CA Unlimited。

'2048' - Zoom United Ent-United与UK/IR Unlimited。

'4096' - Zoom United ent-united与AU/NZ无限。

'8192' - Zoom United ent-united与全球选择。

'16384' - Zoom United Ent-与Zoom Phone Pro联合。

'32768' - Zoom United Pro-United与JP Unlimited。

'65536' - Zoom United Biz-与JP Unlimited联合。

'131072' - Zoom United-United与JP Unlimited。

'none'-关闭缩放联合类型。

枚举值:

12481632641282565121024204840968192163843276865536131072none

示例值:

示例

{
  "timezone": "America/Chicago",
  "language": "English",
  "type": 1,
  "pmi": 1234567890,
  "custom_attributes": [
    {
      "name": "A1",
      "value": "1",
      "key": "cbf_cywdkexrtqc73f97gd4w6g"
    }
  ],
  "about_me": "I'm a Zoom lover!",
  "host_key": "4692486817",
  "feature": {
    "zoom_phone": true
  },
  "phone_country": "US",
  "company": "Example, Inc.",
  "first_name": "Jill",
  "job_title": "Developer",
  "pronouns_option": 1,
  "vanity_name": "My Meeting Room",
  "manager": "Tara Smith",
  "use_pmi": false,
  "cms_user_id": "KDcuGIm1QgePTO8WbOqwIQ",
  "last_name": "Chill",
  "dept": "Developers",
  "display_name": "Jill Chill",
  "phone_numbers": [
    {
      "country": "US",
      "number": "5550100",
      "code": "+1",
      "label": "Mobile"
    }
  ],
  "group_id": "RSMaSp8sTEGK0_oamiA2_w",
  "zoom_one_type": 0,
  "location": "San Jose",
  "phone_number": "5550100",
  "pronouns": "They/Them/Their",
  "linkedin_url": "https://www.linkedin.com/example",
  "plan_united_type": "1"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢204** HTTP状态代码: ** '204' 用户已更新。

application/json

Body

object {0}

示例

{}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '200' * Zoom Room用户无法更改为免费用户类型: $ userId * Zoom Room用户无法更改为无会议许可证用户类型: $ userId。 * 您无法更改 “无会议许可证” 用户的PMI信息。 * 只有帐户管理员可以更改用户名。 * 只有帐户管理员可以更改主机密钥。 * 只有帐户管理员可以更改个人会议ID (PMI)。 * 只有帐户管理员可以更改虚名。 ** 错误代码: **

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '1001' 用户不存在: $ userId