List common area phones

A common area phone can be provisioned by a Zoom account owner or a Zoom admin so that anyone in an organization can use it. For example, if your office has shared desks that don't belong to a specific employees, you could add a common area phone so that any person can use it.
Use this API to list all common area phone in an account.

Prerequisites:

Pro or a higher account with Zoom Phone license.

Account owner or admin permissions.

Supported device

Scope: phone:read:admin

Rate Limit Label: Medium

{ "common_area_phones": [ { "calling_plans": [ { "name": "string", "type": "string" } ], "device_type": "string", "display_name": "string", "id": "string", "mac_address": "string", "phone_numbers": [ { "id": "string", "number": "string", "source": "string" } ], "site": { "id": "string", "name": "string" }, "status": "string" } ], "next_page_token": "string", "page_size": "integer", "total_records": "integer" }

请求参数

Query 参数

page_size

integer

可选

The total number of records returned from a single API call.

<= 100

默认值:

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**<br> List of Common Area Phones retrieved successfully.

application/json

Body

common_area_phones

array [object {8}]

可选

calling_plans

array [object {2}]

可选

device_type

string

可选

Type of device (manufacturer name + model name). Refer to the table here for a list of supported devices.

display_name

string

可选

Display name of the common area phone.

string

可选

Unique Identifier of the common area phone.

mac_address

string

可选

Mac address or serial number.

phone_numbers

array [object {3}]

可选

site

object

可选

status

string

可选

Status of the common area phone. It can be either online or offline.

next_page_token

string

可选

page_size

integer

可选

Total number of records returned from a single API call.

total_records

integer

可选

Total number of records found for this query.

<= 100

默认值: