List Zoom Room locations

A Zoom account owner or a Zoom Room administrator can establish a location hierarchy to help manage Zoom Rooms that are spread among a variety of locations. Use this API to list the different location types used for Zoom Rooms in an account.

Prerequisites:

Account owner or admin permissions.

Zoom Rooms Version 4.0 or higher

Scopes: room:read:admin

Rate Limit Label: Medium

{ "page_size": 30, "next_page_token": "", "locations": [ { "id": "AAAAAAAAAA", "name": "Country/Region1", "parent_location_id": "I-qsfdUbbbbg", "type": "country" }, { "id": "BBBBBBBB", "name": "State1", "parent_location_id": "AAAAAAAAAA", "type": "state" }, { "id": "ccccddddd, "name": "City1", "parent_location_id": "BBBBBBBB", "type": "city" }, { "id": "fgaajfjfhgjgjgjg", "name": "Campus1", "parent_location_id": "ccccddddd, "type": "campus" }, { "id": "YQGK12344", "name": "Building1", "parent_location_id": "fgaajfjfhgjgjgjg", "type": "building" }, { "id": "uUbbbbbbbb", "name": "Floor1", "parent_location_id": "YQGK12344", "type": "floor" } ] }

请求参数

Query 参数

parent_location_id

string

可选

A unique identifier of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1. Use this parameter to filter the response by a specific location hierarchy level.

type

string

可选

Use this field to filter the response by the type of location. The value can be one of the following:
country, states, city, campus, building, floor.

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.

返回响应

🟢200**HTTP Status Code:** `200` **OK** Zoom Room locations listed successfully.

application/json

Body

locations

array [object {4}]

可选

string

可选

Unique Identifier of the location.

name

string

可选

Name of the location.

parent_location_id

string

可选

ID (Unique Identifier) of the parent location. For instance, if a Zoom Room is located in Floor 1 of Building A, the location of Building A will be the parent location of Floor 1 and the parent_location_id of Floor 1 will be the ID of Building A.

The value of parent_location_id of the top-level location (country) is the Account ID of the Zoom account.

type

enum<string>

可选

The type of location. The value can be one of the following:
country, states, city, campus, building, floor.

枚举值:

countrystatescitycampusbuildingfloor

next_page_token

string

可选

page_size

integer

可选

The number of records returned within a single API call.

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `200` Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. **Error Code:** `300` Location type not exist.

🟠404**HTTP Status Code:** `404` **Not Found** **Error Code:** `4801` Location not found:{parent_location_id}.