获取用户

GET

/accounts/{accountId}/users/{userId}

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

** 注意 ** 尚未激活其帐户的用户将处于 “待定” 状态。这些用户的 “created_at” 时间戳还将显示进行API调用的时间，** 而不是 ** 帐户的创建日期。

** 注意: ** 'user_info:read' 范围仅在为' $ userId' 值传递 'me' 值时可用。

** 范围: ** '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'-支付宝。

encrypted_email

string

可选

为 “userid” 值传递的电子邮件地址是否为加密的电子邮件地址。

'true'-电子邮件地址已加密。

'false'-电子邮件地址未加密。

如果不查询此参数，则此值默认为null ('false')。

search_by_unique_id

string

可选

查询的 “userid” 值是否为员工唯一ID。

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

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

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200** HTTP状态码: ** '200' ** 确定 ** 返回用户对象。

application/json

Body

user对象表示Zoom上的特定用户。

personal_meeting_url

string

可选

用户的个人会议url。

示例值:

example.com

account_number

integer <int64>

用户的帐号。

可选

示例值:

10009239

cluster

string

用户的集群。

可选

示例值:

us04

im_group_ids

array[string]

可选

用户所属的组的IM id。

last_login_time

string <date-time>

用户上次登录时间。

可选

示例值:

2021-05-05T20:40:30Z

jid

string

可选

示例值:

jchill@example.com

timezone

string

用户的时区。

可选

示例值:

Asia/Shanghai

created_at

string <date-time>

已废弃

创建此用户的最新登录类型的日期和时间。

示例值:

2018-10-31T04:32:37Z

language

string

可选

Zoom Web门户的默认语言。

示例值:

en-US

type

enum<integer>

必需

用户的计划类型:
'1'-基本。
“2”-许可。
'99' - None (这只能用 'ssoCreate' 设置)。

枚举值:

1299

示例值:

pmi

integer <int64>

可选

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

示例值:

3542471135

custom_attributes

array [object {3}]

可选

已分配给用户的自定义属性。

name

string

自定义属性的名称。

可选

示例值:

value

string

自定义属性的值。

可选

示例值:

key

string

可选

自定义特性的标识符。

示例值:

cbf_cywdkexrtqc73f97gd4w6g

role_id

string

可选

用户分配的 [角色] 的唯一标识符 (/docs/api-reference/zoom-api/方法 # 操作/角色)。

示例值:

group_ids

array[string]

可选

用户所属的web组的id。

last_client_version

string

可选

用户上次登录的客户端版本。

示例值:

5.9.6.4993(mac)

phone_country

string

已废弃

** 注意: ** 此字段已 ** 弃用 **，以后将不再支持。使用 ** phone_numbers ** 字段而不是此字段。
公司电话号码的用户所在国家/地区。

示例值:

company

string

用户的公司。

可选

示例值:

Jill

string

用户ID。

可选

示例值:

zJKyaiAyTNC-MWjiWC18KQ

vanity_url

string

可选

个人会议室URL (如果用户有)。

示例值:

example.com

first_name

string

用户的名字。

可选

<= 64 字符

示例值:

Jill

job_title

string

用户的职位。

可选

示例值:

API Developer

string

可选

用户的电子邮件地址。

示例值:

jchill@example.com

pronouns_option

enum<integer>

可选

用户的显示代词设置。

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

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

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

枚举值:

123

示例值:

manager

string <email>

可选

用户的manager。

示例值:

thill@example.com

use_pmi

boolean

可选

如果用户为即时会议启用了 [个人会议ID (PMI)](https://developers.zoom.us/docs/api/rest/using-zoop-api/# 理解-个人会议id-pmi)，则显示 “true”，否则为 “假”。

默认值:

false

示例值:

false

user_created_at

string <date-time>

可选

创建此用户的日期和时间。

示例值:

2018-10-31T04:32:37Z

cms_user_id

string

可选

用户的CMS ID。仅对Kaltura集成启用。

示例值:

KDcuGIm1QgePTO8WbOqwIQ

verified

integer

可选

显示用户是否已验证。

'1'-帐户已验证。

“0”-未验证帐户。

示例值:

last_name

string

用户的姓氏。

可选

<= 64 字符

示例值:

Chill

dept

string

部。

可选

示例值:

Developers

display_name

string

用户的显示名称。

可选

<= 128 字符

示例值:

Jill Chill

employee_unique_id

string

可选

员工的唯一ID。此字段仅在以下情况下返回:

已启用SAML单点登录 (SSO)。

“login_type” 值为 “101” (SSO)。

示例值:

HqDyI037Qjili1kNsSIrIg

role_name

string

可选

用户的角色名称。

示例值:

Admin

phone_numbers

array [object {5}]

可选

country

string

可选

电话号码的 [国家ID](https://developers.zoom.us/docs/api/rest/其他-参考/缩写-列表/# 国家)。例如，如果 “number” 字段包含基于巴西的数字，则该值为 “br”。

示例值:

number

string

用户的电话号码。

可选

示例值:

800000000

code

string

可选

电话号码的ISO国家/地区代码。例如，“美国电话号码” 的值将为 “1”。

示例值:

verified

boolean

可选

Zoom是否已验证电话号码。

示例值:

true

label

enum<string>

可选

电话号码的标签。

'移动'

“办公室”

“家”

'Fax'

枚举值:

MobileOfficeHomeFax

示例值:

Mobile

account_id

string

用户的帐户ID。

可选

示例值:

q6gBJVO5TzexKYTb_I2rpg

zoom_one_type

integer

可选

用户的 “缩放一个计划” 选项。
'4'-放大一个企业。
'8'-放大一个企业增强版。
'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帐户的 “缩放一个计划” 选项:
'4'-放大一个企业。
'8'-放大一个企业增强版。
'16'-放大一个商业加。

教育帐户的 “缩放一个计划” 选项:
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。

示例值:

location

string

可选

Theser的位置.

示例值:

Paris

phone_number

string

已废弃

** 注意: ** 此字段已 ** 弃用 **，以后将不再支持。使用 ** phone_numbers ** 字段而不是此字段。
用户的电话号码。

示例值:

+1 800000000

pronouns

string

用户的代词。

可选

示例值:

3123

pic_url

string

可选

用户的个人资料图片的URL。

示例值:

example.com

plan_united_type

enum<string>

可选

如果用户在 Zoom United 计划中注册，则返回此字段。许可证选项:

'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。

枚举值:

12481632641282565121024204840968192163843276865536131072

示例值:

login_types

array[integer]

可选

用户的登录方法。

“0”-Facebook OAuth。
'1' - Google OAuth。
'24'-苹果OAuth。
'27' - Microsoft OAuth。
“97”-移动设备。
'98 '-环中央OAuth。
'99'-API用户。
“100”-缩放工作电子邮件。
“101”-单点登录 (SSO)。

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

'11'-电话号码。
'21'-微信。
'23'-支付宝。

枚举值:

011121232427979899100101

status

enum<string>

用户帐户的状态。

可选

枚举值:

pendingactiveinactive

示例值:

pending

示例

{
    "personal_meeting_url": "example.com",
    "account_number": 10009239,
    "cluster": "us04",
    "im_group_ids": [
        "t-_-d56CSWG-7BF15LLrOw"
    ],
    "last_login_time": "2021-05-05T20:40:30Z",
    "jid": "jchill@example.com",
    "timezone": "Asia/Shanghai",
    "created_at": "2018-10-31T04:32:37Z",
    "language": "en-US",
    "type": 1,
    "pmi": 3542471135,
    "custom_attributes": [
        {
            "name": "A1",
            "value": "1",
            "key": "cbf_cywdkexrtqc73f97gd4w6g"
        }
    ],
    "role_id": "0",
    "group_ids": [
        "RSMaSp8sTEGK0_oamiA2_w"
    ],
    "last_client_version": "5.9.6.4993(mac)",
    "phone_country": "US",
    "company": "Jill",
    "id": "zJKyaiAyTNC-MWjiWC18KQ",
    "vanity_url": "example.com",
    "first_name": "Jill",
    "job_title": "API Developer",
    "email": "jchill@example.com",
    "pronouns_option": 1,
    "manager": "thill@example.com",
    "use_pmi": false,
    "user_created_at": "2018-10-31T04:32:37Z",
    "cms_user_id": "KDcuGIm1QgePTO8WbOqwIQ",
    "verified": 1,
    "last_name": "Chill",
    "dept": "Developers",
    "display_name": "Jill Chill",
    "employee_unique_id": "HqDyI037Qjili1kNsSIrIg",
    "role_name": "Admin",
    "phone_numbers": [
        {
            "country": "US",
            "number": "800000000",
            "code": "+1",
            "verified": true,
            "label": "Mobile"
        }
    ],
    "account_id": "q6gBJVO5TzexKYTb_I2rpg",
    "zoom_one_type": 4,
    "location": "Paris",
    "phone_number": "+1 800000000",
    "pronouns": "3123",
    "pic_url": "example.com",
    "plan_united_type": "1",
    "login_types": [
        0
    ],
    "status": "pending"
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '1120' 找不到此用户加入Zoom帐户的有效邀请。 如果您在帐户中添加了用户，但该用户未按时接受邀请且邀请已过期，则会引发此错误-从而使用户id无效。

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

修改于 2023-10-31 06:13:33

更新用户

删除用户