获取活动/非活动主机报告

如果用户在 “从” 和 “到” 范围中指定的月份期间主持了至少一个会议，则该用户被认为是该月份期间的活动主持人。如果用户在此期间未主持任何会议，则认为该用户处于非活动状态。
“活动主持人” 报告显示特定时间范围 (最多一个月) 内的会议、参与者和会议记录的列表。该月应在最近六个月内。
“非活动主机” 报告将提取在特定时间段内不活动的用户列表。
使用此API检索指定时间段内的活动或非活动主机报告。报告的时间范围限于一个月，并且该月应在过去六个月内。
使用查询参数指定报表类型和日期范围。

** 先决条件: **

Pro或更高的计划。

** 范围: ** '报告: master'

** [速率限制标签](https://marketplace.zoom.us/docs/api参考/速率限制 # 速率限制):** “沉重”

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

活动或非活动主机。
“活动”-活动主机。
“不活动”-不活动的主机。

from

string

必需

以 'yyyy-mm-d' 格式的开始日期。“从” 和 “到” 参数定义的日期范围应该只有一个月，因为报告一次只包括一个月的数据。

string

结束日期。

必需

page_size

integer

可选

单个API调用中返回的记录数。

page_number

integer

可选

返回记录中当前页面的页码。

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

group_id

string

可选

组ID。要获取组ID，请使用 [** 列出组 **](/api-reference/zoom-api/methops # operation/groups) api。

** 注意: ** API响应仅包含查询的group ID的成员用户。

返回响应

🟢200** HTTP状态代码: ** '200' 返回活动或非活动主机报告。这仅适用于付费帐户: {accountId}。

application/json

Body

page_number

integer

当前结果的页码。

可选

默认值:

示例值:

next_page_token

string

可选

下一页标记用于通过大型结果集进行分页。每当可用结果集超过当前页面大小时，将返回下一页令牌。此令牌的有效期为15分钟。

示例值:

w7587w4eiyfsudgk

total_participants

integer

此范围的参与者数。

可选

示例值:

total_records

integer

可选

跨页可用的所有记录的总数。

示例值:

850

from

string <date>

此报告的开始日期。

可选

示例值:

2022-03-01

total_meetings

integer

此范围的会议数。

可选

示例值:

string <date>

此报告的结束日期。

可选

示例值:

2022-03-25

total_meeting_minutes

integer

可选

此范围的会议分钟数。

示例值:

345

page_count

integer

可选

为发出的请求返回的页数。

示例值:

users

array [object {9}]

用户对象数组。

可选

meeting_minutes

integer

用户的会议分钟数。

可选

示例值:

342

user_name

string

用户显示名称。

可选

示例值:

Jill Chill

meetings

integer

用户的会议数。

可选

示例值:

dept

string

用户部门。

可选

示例值:

string

用户ID。

可选

示例值:

2pyjK5VNQHadb2BY6Z4GbA

type

integer

用户类型。

可选

示例值:

string

用户电子邮件。

可选

示例值:

jchill@example.com

custom_attributes

object

可选

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

participants

integer

可选

用户参加会议的人数。

示例值:

page_size

integer

可选

通过单个API调用返回的记录数。

<= 300

默认值:

示例值:

示例

{
    "page_number": 1,
    "next_page_token": "w7587w4eiyfsudgk",
    "total_participants": 56,
    "total_records": 850,
    "from": "2022-03-01",
    "total_meetings": 34,
    "to": "2022-03-25",
    "total_meeting_minutes": 345,
    "page_count": 30,
    "users": [
        {
            "meeting_minutes": 342,
            "user_name": "Jill Chill",
            "meetings": 45,
            "dept": "HR",
            "id": "2pyjK5VNQHadb2BY6Z4GbA",
            "type": 1,
            "email": "jchill@example.com",
            "custom_attributes": {
                "name": "age",
                "value": "18",
                "key": "4444AAAiAAAAAiAiAiiAii=="
            },
            "participants": 56
        }
    ],
    "page_size": 30
}

🟠400** HTTP状态代码: ** '400' <br> 错误的请求 ** 错误代码: ** '200' <br> 没有权限。<br> '

获取活动/非活动主机报告

请求参数

示例代码

返回响应