创建子账户 - Zoom API 中文版

使用此API在主账号下创建子账号。新的子帐户将收到确认电子邮件。

Zoom只允许经过审核的伙伴使用主账号api 和管理子账号。有关详细信息，请联系 Zoom Partners team，地址为 partner-success@zoom.us。

** 先决条件: **

启用主帐户选项的Pro或更高付费帐户。

** 范围: ** '帐户: master'

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

请求参数

Body 参数application/json

新的子帐户的信息。子账户的所有者是创建子账户或为其创建账户的用户。有关Zoom帐户结构的更多信息，请阅读我们的 [Zoom帐户结构](https://medium.com/zoom-开发者-博客/a-brief-look-at-zoom-account-structures-1d19c745bf8a) 文档。

sub_reseller_id

string

可选

子经销商的ID。创建三级子账号，需要传入二级主账号的ID。

如果您不提供此字段，则将为调用API的账户创建一个新的子账户。

示例值:

ABCDEF12345

password

string

必需

子帐户的密码。

** 注意: ** 如果帐户所有者或管理员已启用 [增强密码要求](https://support.zoom.us/hc/en-us/articles/360034675592-Advanced-security-settings # h_fa9186e4-6818-4f7a-915c-2e25c19f0acd)，此字段中提供的值必须满足这些要求。您可以通过 [** 获取帐户设置 **](/docs/api-reference/zoom-api/ma # operation/accountSettings) api获取这些要求。在API响应的 “security” 对象中引用 “password_requirement” 对象。

示例值:

if42!LfH@

account_name

string

可选

子帐户的名称。如果不传递此值，则帐户名称将是 “first_name” 和 “last_name” 参数的串联。

<= 64 字符

示例值:

jchill

options

object

可选

有关帐户选项的信息。

pay_mode

enum<string>

可选

帐户的收款人:

'master'-主帐户持有人付款。

'sub'-子帐户持有人付款。

此值默认为 “master”。

枚举值:

mastersub

默认值:

master

示例值:

master

room_connector_list

array[string]

可选

与子帐户共享的VRC IP地址的逗号分隔列表。如果您没有为此字段提供值，则主账户的所有vrc都将与子账户共享。

** 注意: ** 只有当 “share_rc” 值为 “true” 时，才能使用此字段。

billing_auto_renew

boolean

是否开启自动续费。

可选

示例值:

false

share_rc

boolean

可选

是否启用子账户使用主账户的共享 [虚拟房间连接器 (VRC)] 的选项 (https://support.zoom.us/hc/en-us/articles/202134758-部署虚拟房间连接器)。Vrc仅适用于内部部署帐户。

此值默认为 “false”。

默认值:

false

示例值:

false

meeting_connector_list

array[string]

可选

与子帐户共享的会议连接器IP地址的逗号分隔列表。如果您没有为此字段提供值，则主账户的所有会议连接器都将与子账户共享。

** 注意: ** 只有当 “share_mc” 值为 “true” 时，才能使用此字段。

share_mc

boolean

可选

是否启用子账户使用主账户的共享 [会议连接器] 的选项 (https://support.zoom.us/hc/en-us/articles/201363093)。会议连接器仅适用于内部部署帐户。

此值默认为 “false”。

默认值:

false

示例值:

false

last_name

string

用户的姓氏。

必需

<= 64 字符

示例值:

Chill

transfer_code

string

可选

将帐户转移到活期分户的帐户转移代码

<= 512 字符

示例值:

AIr7emjkNxUD4O5Q73H-Jr8ZmVGHMOsSAOps9B6-bB4.AG.hCTluR6maAXj8CZ9Bs7xm1eDfqT5Lct4WczDkqIahVK7BdMfR8Ps7_JDRtfZr-6Hci7IOyDVCc_5xTkdVrdl50NNgfZcl4NflffxgoYNMQ34Sr_vKYGvJ3eNmnv2i-qp7c24c1b6lU3APJqtxwKkm8CKmc7iyu6WlcLLILSgAlDifo4SjBVfiSC-.z_WNrlV6aXoeWpc7pKJnfA.50Jl_yAYazRkzoVR

first_name

string

用户的名字。

必需

<= 64 字符

示例值:

Jill

string

必需

用户的电子邮件地址。

<= 128 字符

示例值:

jchill@example.com

示例

{
    "sub_reseller_id": "ABCDEF12345",
    "password": "if42!LfH@",
    "account_name": "jchill",
    "options": {
        "pay_mode": "master",
        "room_connector_list": [
            "[\"192.0.2.1\",\"198.51.100.1\"]"
        ],
        "billing_auto_renew": false,
        "share_rc": false,
        "meeting_connector_list": [
            "203.0.113.1"
        ],
        "share_mc": false
    },
    "last_name": "Chill",
    "transfer_code": "AIr7emjkNxUD4O5Q73H-Jr8ZmVGHMOsSAOps9B6-bB4.AG.hCTluR6maAXj8CZ9Bs7xm1eDfqT5Lct4WczDkqIahVK7BdMfR8Ps7_JDRtfZr-6Hci7IOyDVCc_5xTkdVrdl50NNgfZcl4NflffxgoYNMQ34Sr_vKYGvJ3eNmnv2i-qp7c24c1b6lU3APJqtxwKkm8CKmc7iyu6WlcLLILSgAlDifo4SjBVfiSC-.z_WNrlV6aXoeWpc7pKJnfA.50Jl_yAYazRkzoVR",
    "first_name": "Jill",
    "email": "jchill@example.com"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢201帐户已成功创建。

application/json

Body

创建的子账号信息。

owner_email

string <email>

可选

子账户的所有者电子邮件地址的电子邮件地址。

示例值:

admin@example.com

owner_id

string

帐户所有者的ID。

可选

示例值:

tsmith@example.com

created_at

string <date-time>

可选

子帐户的创建日期和时间。

示例值:

2021-07-21T17:32:28Z

string

子账户的ID。

可选

示例值:

NfIX2NPgQ-mLjHOybvftuv

示例

{
    "owner_email": "admin@example.com",
    "owner_id": "tsmith@example.com",
    "created_at": "2021-07-21T17:32:28Z",
    "id": "NfIX2NPgQ-mLjHOybvftuv"
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误代码: ** '300' * 您的请求无法完成，因为名称包含无效的单词: {name} * 您的请求未被接受，因为 “{field}” 包含特殊字符。 ** 错误代码: ** '1107' 电子邮件域被阻止。 ** 错误代码: ** '1111' * 密码不应包含重复的字符，如 “aaaaaa”。 * 密码不应包含连续字符，如 “abc” 或 “123”。 ** 错误码: *

🟠409** HTTP状态代码: ** '409' 冲突 ** 错误码: ** '1005' 电子邮件 “$ Email” 已被使用。