列出会议

列出指定时间段内发生的所有实时会议或过去的会议。此概述将显示会议中是否使用了音频、视频、屏幕共享和录制等功能。您还可以查看帐户中每个用户的许可证类型。
您可以使用 “从” 和 “到” 查询参数为仪表板数据指定每月日期范围。该月应在最近六个月内。

** 先决条件: **

业务或更高的计划。

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

请求参数

Path 参数

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

指定一个值以获取相应会议类型的响应。

“过去”-已在指定日期范围内发生的会议。
“过去”-过去只有一个用户参加的会议。
“Live”-实时会议。

如果您不提供此字段，则默认值将为 “实时”，并且API将仅查询实时会议的响应。

from

string

必需

“Yyyy-mm-dd HH: MM: ss” 格式的开始日期。“从” 和 “到” 参数定义的日期范围应该只有一个月，因为报告一次只包括一个月的数据。

string

必需

结束日期 “yyyy-mm-dd HH: MM: ss” 格式。

page_size

integer

可选

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

next_page_token

string

可选

使用next page标记对大型结果集进行分页。只要可用结果集超过当前页面大小时，就会返回下一页令牌。此令牌的有效期为15分钟。

group_id

string

可选

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

** 注意: ** API响应仅包含主机是查询的group ID的成员的会议。

include_fields

string

可选

如果要在响应中包含每个会议的跟踪字段，请将此字段的值设置为 “tracking_fields”。

query_date_type

string

可选

要查询的日期类型。仅当 'type' 为 'past' 时才支持此字段。

'start_time'-按调用开始时间查询。

'end_time'-按呼叫结束时间查询。

此值默认为 “start_time”。

返回响应

🟢200** HTTP状态代码: ** '200' 会议回来了。此API仅适用于已启用仪表板功能的ZMP和企业或更高版本帐户。

application/json

Body

分页对象。

next_page_token

string

可选

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

示例值:

Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3

total_records

integer

可选

跨页可用的所有记录数。

示例值:

from

string <date>

可选

此报告的开始日期，格式为 'yyyy-mm-dd-'。

示例值:

2022-04-01

meetings

array [object {28}]

会议对象的数组。

可选

has_automated_captions

boolean

可选

指示会议中是否启用了自动标题。

示例值:

true

audio_quality

enum<string>

可选

会议的音频质量分数。

'好'-音频几乎完美无瑕，质量非常好。

'公平'-音频偶尔会出现失真，噪音和其他问题，但内容基本上是连续的。参与者可以正常交流。

“差”-音频经常有失真，噪音和其他问题，但内容基本上是连续的。参与者可以正常交流。

“坏”-声音质量极差，音频内容几乎听不见。

枚举值:

goodfairpoorbad

示例值:

good

has_voip

boolean

可选

指示会议中是否使用了VoIP。

示例值:

true

custom_keys

array [object {2}]

可选

分配给会议的自定义键和值。

has_recording

boolean

可选

指示会议中是否使用了录制功能。

示例值:

true

uuid

string

可选

会议UUID。如果UUID以 “/” 开头或其中包含 “//”，请在将其用于API调用时对UUID进行双重编码。

示例值:

gm8s9L+PTEC+FG3sFbd1Cw==

has_video

boolean

可选

指示会议中是否使用了视频。

示例值:

true

duration

string

可选

会议持续时间。格式为hh:mm:ss，例如: '16:08' 16分8秒。

示例值:

00:56

user_type

string

用户的许可证类型。

可选

示例值:

Licensed

host

string

主机显示名称。

可选

示例值:

Jill Chill

session_key

string

可选

视频SDK自定义会话ID。

示例值:

ABC36jaBI145

integer <int64>

可选

会议ID: 会议的唯一标识符，格式为 “** long **” (在JSON中表示为int64数据类型)，也称为会议编号。

示例值:

93201235621

has_3rd_party_audio

boolean

可选

表示会议中是否使用了第三方音频。

示例值:

true

string

可选

主机的电子邮件地址。

示例值:

jchill@example.com

participants

integer

会议参与者计数。

可选

示例值:

has_archiving

boolean

可选

会议中是否使用了存档功能。

示例值:

true

has_pstn

boolean

可选

指示会议中是否使用了PSTN。

示例值:

true

in_room_participants

integer

可选

会议中Zoom Room参与者的数量。

示例值:

video_quality

enum<string>

可选

会议的视频质量分数。

'好'-视频几乎完美无瑕，质量非常好。

'公平'-视频清晰度很高，偶尔会卡住，快或慢，或其他问题，但频率很低，视频质量很好。

'poor'-视频清晰度不高，但不存在很多问题。视频质量一般。

“坏”-图片非常模糊，经常被卡住。

枚举值:

goodfairpoorbad

示例值:

good

end_time

string <date-time>

会议结束时间。

可选

示例值:

2022-01-04T07:50:47Z

dept

string

部门的主机。

可选

示例值:

Developers

has_manual_captions

boolean

可选

指示会议中是否启用了手动标题。

示例值:

true

has_screen_share

boolean

可选

指示会议中是否使用了screenshare功能。

示例值:

true

start_time

string <date-time>

会议开始时间。

可选

示例值:

2022-01-04T08:04:27Z

tracking_fields

array [object {2}]

可选

跟踪分配给会议的字段和值。

topic

string

会议主题。

可选

示例值:

Share Now

has_sip

boolean

可选

指示是否有人使用SIP加入了会议。

示例值:

true

screen_share_quality

enum<string>

可选

会议的屏幕共享质量分数。

'好'-视频几乎完美无瑕，质量非常好。

'公平'-视频清晰度很高，偶尔会卡住，快或慢，或其他问题，但频率很低，视频质量很好。

'poor'-视频清晰度不高，但不存在很多问题。视频质量一般。

“坏”-图片非常模糊，经常被卡住。

枚举值:

goodfairpoorbad

示例值:

good

string <date>

可选

此报告的结束日期，格式为 'yyyy-mm-dd-'。

示例值:

2022-04-07

page_count

integer

可选

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

示例值:

page_size

integer

可选

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

<= 300

默认值:

示例值:

示例

{
    "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
    "total_records": 1,
    "from": "2022-04-01",
    "meetings": [
        {
            "has_automated_captions": true,
            "audio_quality": "good",
            "has_voip": true,
            "custom_keys": [
                {
                    "value": "US",
                    "key": "Host Nation"
                }
            ],
            "has_recording": true,
            "uuid": "gm8s9L+PTEC+FG3sFbd1Cw==",
            "has_video": true,
            "duration": "00:56",
            "user_type": "Licensed",
            "host": "Jill Chill",
            "session_key": "ABC36jaBI145",
            "id": 93201235621,
            "has_3rd_party_audio": true,
            "email": "jchill@example.com",
            "participants": 2,
            "has_archiving": true,
            "has_pstn": true,
            "in_room_participants": 2,
            "video_quality": "good",
            "end_time": "2022-01-04T07:50:47Z",
            "dept": "Developers",
            "has_manual_captions": true,
            "has_screen_share": true,
            "start_time": "2022-01-04T08:04:27Z",
            "tracking_fields": [
                {
                    "field": "Meeting purpose.",
                    "value": "Support"
                }
            ],
            "topic": "Share Now",
            "has_sip": true,
            "screen_share_quality": "good"
        }
    ],
    "to": "2022-04-07",
    "page_count": 1,
    "page_size": 30
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误码: ** '12700' 此帐户无法按 “end_time” 查询会议。 ** 错误代码: ** '400' 此API仅适用于已启用仪表板功能的ZMP和企业或更高版本帐户。

请求参数

示例代码

返回响应