Get Zoom Room location profile

GET

/rooms/locations/{locationId}

Each location type of the Zoom Rooms location hierarchy has a profile page that includes information such as name of the location, address, support email, etc. Use this API to retrieve information about a specific Zoom Rooms location type such as information about the city where the Zoom Rooms is located.

Prerequisite:

Account owner or admin permission

Zoom Rooms version 4.0 or higher
Scopes: room:read:admin

Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/rooms/locations/'

响应示例

200 - response

{
    "basic": {
        "description": "This Zoom Rooms is located in Kathmandu.",
        "name": "Kathmandu",
        "required_code_to_ext": true,
        "room_passcode": "12234",
        "support_email": "abb123@123",
        "support_phone": "00222",
        "timezone": "Asia/Kathmandu"
    }
}

请求参数

Path 参数

locationId

string

必需

Unique identifier of the location type. This can be retrieved using the List Zoom Room Location API (Id property in the response).

返回响应

🟢200**HTTP Status Code:** `200` **OK** Zoom Rooms Location Profile returned successfully.

application/json

Body

basic

object

可选

address

string

Address

可选

description

string

可选

Description about the location.

name

string

可选

Name of the location type.

required_code_to_ext

boolean

可选

Require code to exit out of your Zoom Rooms application to switch between other apps.

room_passcode

string

可选

1-16 digit number or characters that is used to secure your Zoom Rooms application.

>= 1 字符<= 16 字符

support_email

string <email>

可选

The email address to be used for reporting Zoom Room issues.

support_phone

string

可选

The phone number to be used for reporting Zoom Room issues.

timezone

string

可选

Timezone (only returned for location type - city).

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `200` Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription. Access restricted.

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

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

Update Zoom Rooms location structure

Update Zoom Room location profile