获取缩放房间详细信息

通过Zoom room控制面板指标，您可以了解Zoom room具有的配置类型以及在该会议室中举行的会议的详细信息。

使用此API检索有关特定房间的信息。

** 先决条件: **

商业，教育或API计划与缩放房间设置。

** 范围: ** 'dashboard_zr:master'

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

请求参数

Path 参数

zoomroomId

string

缩放房间ID。

必需

accountId

string

帐户的唯一标识符。

必需

Query 参数

from

string

必需

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

string

结束日期。

必需

page_size

integer

可选

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

next_page_token

string

可选

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

返回响应

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

application/json

Body

缩放房间。

account_type

string

可选

缩放会议室电子邮件类型。

示例值:

Work Email

live_meeting

object

会议指标

可选

会议度量详细信息。

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

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

会议参与者计数。

可选

示例值:

calender_name

string

缩放日历名称。

可选

示例值:

666555

health

string

可选

缩放房间的健康状况。

示例值:

critical

past_meetings

object

分页对象。

可选

next_page_token

string

可选

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

示例值:

Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3

total_records

integer

可选

跨页可用的所有记录数。

示例值:

from

string <date>

可选

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

示例值:

2022-04-07

meetings

array[object (会议指标) {23}]

会议对象的数组。

可选

string <date>

可选

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

示例值:

2022-04-08

page_count

integer

可选

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

示例值:

page_size

integer

可选

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

<= 300

默认值:

示例值:

issues

array[string]

可选

Zoom Room遇到的问题。

device_ip

string

缩放房间设备IP。

可选

示例值:

Computer : 10.100.93.138

room_name

string

缩放房间名称。

可选

示例值:

jchill room

speaker

string

可选

缩放房间扬声器。

** 注意: ** 此响应为 ** 不属于 ** 主机帐户的任何用户 (外部用户) 返回一个空字符串 ('“') 值。

示例值:

Built-in Output (Headphones)

location

string

缩放房间位置。

可选

示例值:

floor1

string

缩放房间ID。

可选

示例值:

_hjJhB0cQRi9Xm3HX64Ggw

camera

string

可选

变焦房间相机。

** 注意: ** 此响应为 ** 不属于 ** 主机帐户的任何用户 (外部用户) 返回一个空字符串 ('“') 值。

示例值:

FaceTime HD Camera

last_start_time

string

可选

缩放房间的最后开始时间。

示例值:

2020-11-04T01:06:41Z

microphone

string

可选

变焦室麦克风。

** 注意: ** 此响应为 ** 不属于 ** 主机帐户的任何用户 (外部用户) 返回一个空字符串 ('“') 值。

示例值:

Built-in Microphone (External Microphone)

string

缩放房间电子邮件。

可选

示例值:

user@example.com

status

string

缩放房间状态。

可选

示例值:

Offline

示例

{
    "account_type": "Work Email",
    "live_meeting": {
        "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
    },
    "calender_name": "666555",
    "health": "critical",
    "past_meetings": {
        "next_page_token": "Tva2CuIdTgsv8wAnhyAdU3m06Y2HuLQtlh3",
        "total_records": 1,
        "from": "2022-04-07",
        "meetings": [
            {
                "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
            }
        ],
        "to": "2022-04-08",
        "page_count": 1,
        "page_size": 30
    },
    "issues": [
        "Zoom room is offline"
    ],
    "device_ip": "Computer : 10.100.93.138",
    "room_name": "jchill room",
    "speaker": "Built-in Output (Headphones)",
    "location": "floor1",
    "id": "_hjJhB0cQRi9Xm3HX64Ggw",
    "camera": "FaceTime HD Camera",
    "last_start_time": "2020-11-04T01:06:41Z",
    "microphone": "Built-in Microphone (External Microphone)",
    "email": "user@example.com",
    "status": "Offline"
}

请求参数

示例代码

返回响应