检索IM目录组 - Zoom API 中文版

请求参数

Path 参数

groupId

string

必需

组ID。

通过调用 [** List groups **](/docs/api-reference/zoom-api/methdos # operation/groups) 接口进行检索。

accountId

string

帐户的唯一标识符。

必需

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

返回响应

🟢200** HTTP状态代码: ** '200' 返回IM组对象。 ** 错误代码: ** '200' 仅适用于付费帐户:{accountId}。

application/json

Body

IM组对象。

search_by_ma_account

boolean

可选

会员可以搜索同一主账户下的其他人-包括所有子账户。

示例值:

true

name

string

组名称。

可选

示例值:

Developers

total_members

integer

此组中的成员总数。

可选

示例值:

200

id

string

组ID。

可选

示例值:

MIuNMURBTkuwfZ20jteRJg

search_by_account

boolean

可选

会员可以在同一帐户下搜索其他人。

示例值:

true

type

enum<string>

可选

IM组类型:
“正常”-只有成员才能看到组中的其他成员。其他人可以搜索组中的成员。
“共享”-帐户中的每个人都可以看到组和成员。
“受限制”-除组成员外，任何人都无法查看该组或搜索其他组成员。

枚举值:

normalsharedrestricted

默认值:

normal

示例值:

normal

search_by_domain

boolean

可选

会员可以搜索同一电子邮件域中的其他人。

示例值:

true

示例

{
    "search_by_ma_account": true,
    "name": "Developers",
    "total_members": 200,
    "id": "MIuNMURBTkuwfZ20jteRJg",
    "search_by_account": true,
    "type": "normal",
    "search_by_domain": true
}

🟠404** HTTP状态代码: ** '404' <br> 未找到 ** 错误代码: ** '4130' <br> 组不存在:{groupId}。