获取会议详细信息

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

** 先决条件: **

业务或更高的计划。

** 范围: ** 'dashboard_meetings:master'

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

请求参数

Path 参数

meetingId

string

必需

会议的ID或通用唯一ID (UUID)。

如果您提供会议ID，API将返回最新会议实例的响应。

如果您提供的会议UUID以 “/” 字符开头或包含 “//” 字符，您必须 ** [double encode](https://marketplace.zoom.us/docs/api-reference/using-zoom-apis/# meeting-id-and-uuid) 会议UUID才能发起api请求。

accountId

string

帐户的唯一标识符。

必需

Query 参数

type

string

可选

要查询的会议类型:

“过去”-所有过去的会议。

“过去”-所有过去的单用户会议。

'live'-所有实时会议。

此值默认为 “live”。

返回响应

🟢200** HTTP状态代码: ** '200' 会议回来了。仅适用于已启用仪表板功能的付费帐户。

application/json

Body

会议度量详细信息。

has_automated_captions

boolean

可选

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

示例值:

true

has_archiving

boolean

可选

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

示例值:

true

has_pstn

boolean

可选

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

示例值:

true

has_voip

boolean

可选

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

示例值:

true

in_room_participants

integer

可选

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

示例值:

end_time

string <date-time>

会议结束时间。

可选

示例值:

2022-03-01T10:17:35Z

custom_keys

array [object {2}]

可选

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

<= 10 items

value

string

可选

与会议关联的自定义键的值。

<= 256 字符

示例值:

key

string

可选

与会议关联的自定义键。

<= 64 字符

示例值:

Host Nation

dept

string

部门的主机。

可选

示例值:

Developers

has_recording

boolean

可选

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

示例值:

true

has_manual_captions

boolean

可选

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

示例值:

true

uuid

string

可选

会议UUID。[双重编码](https://marketplace.zoom.us/docs/api-reference/using-zoom-api/# meeting-id-and-uuid) 如果UUID以 “/” 开头或包含 “//”，则在将其用于API调用时，您的UUID。

示例值:

gaqOKVN9RAaDHKYWEcASXg==

has_video

boolean

可选

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

示例值:

true

has_screen_share

boolean

可选

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

示例值:

true

duration

string

会议持续时间。

可选

示例值:

02:21

start_time

string <date-time>

会议开始时间。

可选

示例值:

2022-03-01T10:15:14Z

user_type

string

用户的许可证类型。

可选

示例值:

Licensed

host

string

主机显示名称。

可选

示例值:

API

topic

string

会议主题。

可选

示例值:

API Meeting

has_sip

boolean

可选

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

示例值:

true

integer <int64>

可选

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

示例值:

575734086

has_3rd_party_audio

boolean

可选

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

示例值:

true

string

可选

主机的电子邮件地址。

示例值:

user@example.com

participants

integer

会议参与者计数。

可选

示例值:

示例

{
    "has_automated_captions": true,
    "has_archiving": true,
    "has_pstn": true,
    "has_voip": true,
    "in_room_participants": 2,
    "end_time": "2022-03-01T10:17:35Z",
    "custom_keys": [
        {
            "value": "US",
            "key": "Host Nation"
        }
    ],
    "dept": "Developers",
    "has_recording": true,
    "has_manual_captions": true,
    "uuid": "gaqOKVN9RAaDHKYWEcASXg==",
    "has_video": true,
    "has_screen_share": true,
    "duration": "02:21",
    "start_time": "2022-03-01T10:15:14Z",
    "user_type": "Licensed",
    "host": "API",
    "topic": "API Meeting",
    "has_sip": true,
    "id": 575734086,
    "has_3rd_party_audio": true,
    "email": "user@example.com",
    "participants": 2
}

🟠400** HTTP状态代码: ** '400' 错误的请求 ** 错误码: ** '12702' 无法访问一年前的会议。

🟠404** HTTP状态代码: ** '404' 未找到 ** 错误代码: ** '3001' 会议ID无效或会议尚未结束。 此会议的详细信息不可用。

请求参数

示例代码

返回响应