获取子帐户详细信息

检索有关主账户的子账户的信息。

Zoom仅允许已批准的伙伴使用主账号api 和创建子账号。有关合作伙伴计划的信息，请发送电子邮件至合作伙伴团队，地址为 partner-success@zoom.us。

** 先决条件 **

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

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

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

返回响应

🟢200** HTTP状态代码 **: '200' 返回了Account对象。

application/json

Body

owner_email

string <email>

可选

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

示例值:

jchill@example.com

account_number

integer

帐户的帐号。

可选

示例值:

123456789

account_type

enum<string>

可选

帐户类型。

“免费”

'Pro'

'企业'

“Api合作伙伴”

“教育”

“业务”

'免费审'

'批量许可证'

'缩放的空间'

“缩放视频sdk”

'缩放电话'

枚举值:

FreeProEnterpriseAPI PartnerEducationBusinessFree TrialBulk LicenseZoom RoomsZoom Video SDKZoom Phone

示例值:

Pro

owner_id

string

帐户所有者ID。

可选

示例值:

654321FEDCBA

account_name

string

帐户的名称。

可选

示例值:

Account1

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

created_at

string <date-time>

可选

帐户的创建日期和时间。

示例值:

2021-07-21T17:32:28Z

string

帐户ID。

可选

示例值:

ABCDEF123456

vanity_url

string <url>

可选

帐户的 vanity URL。

示例值:

https://vanity.example.com

seats

integer

可选

帐户的付费席位的最大数量。

示例值:

subscription_end_time

string <date-time>

可选

帐户的订阅结束日期和时间。此字段仅在存在订阅结束日期和时间时返回。

示例值:

2022-07-21T17:32:28Z

subscription_start_time

string <date-time>

可选

帐户的订阅开始日期和时间。如果没有订阅开始日期和时间，则返回空字符串值。

示例值:

2021-07-21T17:32:28Z

示例

{
    "owner_email": "jchill@example.com",
    "account_number": 123456789,
    "account_type": "Free",
    "owner_id": "654321FEDCBA",
    "account_name": "Account1",
    "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
    },
    "created_at": "2021-07-21T17:32:28Z",
    "id": "ABCDEF123456",
    "vanity_url": "https://vanity.example.com",
    "seats": 1,
    "subscription_end_time": "2022-07-21T17:32:28Z",
    "subscription_start_time": "2021-07-21T17:32:28Z"
}

🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '2001' <br> 帐户不存在: $ subAccountId <br>

请求参数

示例代码

返回响应