Get Zoom Room profile

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 get detailed information on a specific Zoom Room in a Zoom account.

Prerequisites:

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

{ "basic": { "activation_code": "12345", "hide_room_in_contacts": false, "name": "MytestbRoom", "required_code_to_ext": true, "room_passcode": "1234", "support_email": "abcdfdjorjggr@gh.123", "support_phone": "00001111" } }

返回响应

🟢200**HTTP Status Code:** `200` **OK** Zoom Room profile returned successfully.

application/json

Body

basic

object

可选

activation_code

string

可选

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

hide_room_in_contacts

boolean

可选

Hide this Zoom Room from your Contact List.

name

string

可选

Name of the Zoom Room.

required_code_to_ext

boolean

可选

Require code to exit out of 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. This code must be entered on your Zoom Room Controller to change settings or sign out.

>= 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.

🟠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:** `1012` Room not found:{roomId}.

Get Zoom Room profile

请求参数

返回响应