List Zoom Rooms

GET

/rooms

Zoom Rooms is a software-based room system that provides an integrated experience for audio conferencing, wireless screen sharing and video conferencing. Use this API to list all the existing Zoom Rooms in a Zoom account.

Prerequisites:

Pro or a higher plan with Zoom Room license.
Scopes: room:read:admin
Rate Limit Label: Medium

响应示例

{
    "page_size": 30,
    "rooms": [
        {
            "activation_code": "1200",
            "id": "387434ryewr334",
            "name": "testZoomRooms",
            "status": "Available"
        },
        {
            "activation_code": "eu34355empor",
            "id": "4ryewr33sjfkds",
            "name": "MyZoomRooms",
            "status": "Offline"
        }
    ]
}

请求参数

Query 参数

status

enum<string>

可选

The status of the Zoom Room.

枚举值:

OfflineAvailableInMeetingUnderConstruction

type

enum<string>

可选

Type of the Zoom Rooms.

枚举值:

ZoomRoomSchedulingDisplayOnlyDigitalSignageOnly

unassigned_rooms

boolean

可选

Use this query parameter with a value of true if you would like to see Zoom Rooms in your account that have not been assigned to anyone yet.

默认值:

false

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

location_id

string

可选

Parent location ID of the Zoom Room.

返回响应

🟢200**HTTP Status Code:** `200`<br> A list of Zoom Rooms returned successfully.

application/json

Body

next_page_token

string

可选

page_size

integer

可选

The number of records returned within a single API call.

rooms

array [object {6}]

可选

List of existing Zoom Rooms.

activation_code

string

可选

Activation Code is the code that is used to complete the setup of the Zoom Room.

string

可选

Unique Identifier of the Zoom Room.

location_id

string

可选

Unique Identifier of the location of the room.

name

string

可选

Name of the Zoom Room.

room_id

string

可选

Globally unique identifier of the Zoom Room. Use this ID for the Dashboard Zoom Room APIs.

status

enum<string>

可选

Status of the Zoom Room.

枚举值:

OfflineAvailableInMeetingUnderConstruction

修改于 2024-04-24 09:06:48

Unassign a role

Add a Zoom Room