Add a common area phone

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 add a common area phone.

Prerequisites:

Pro or a higher account with Zoom Phone license.

Account owner or admin permissions.

Supported device
Scope: phone:write:admin

Rate Limit Label: Light

curl --location --request POST 'http://api.zoom.us/v2/phone/common_area_phones' \ --header 'Content-Type: application/json' \ --data-raw '{ "description": "string", "display_name": "string", "extension_number": 0, "mac_address": "string", "model": "string", "site_id": "string", "time_zone": "string", "type": "string" }'

请求参数

Body 参数application/json

description

string

可选

Description for the common area phone.

display_name

string

必需

Display name of the Common area phone.

extension_number

integer

必需

Extension number assigned to the common area phone. If site code is enabled, provide the short extension number instead.

mac_address

string

必需

Mac Address (serial number) of the common area desk phone. These examples show the formats supported: 64-16-7f-37-90-92 or 64167f379092

model

string

可选

Device Model name. Refer to the "Model Name" field in this table.

>= 1 字符<= 50 字符

site_id

string

可选

Unique identifier of the site. This can be retrieved from the List Phone Sites API.

time_zone

string

可选

Timezone ID for the common area phone.

type

string

必需

Phone device manufacturer name. Refer to the "Manufacturer Name" field in this table.

>= 1 字符<= 50 字符

示例

返回响应

🟢201**HTTP Status Code:** `201` **Created** Common area phone added successfully.

application/json

Body

display_name

string

可选

Display name of the common area phone.

string

可选

Unique Identifier of the common area phone.

🟠400**HTTP Status Code:** `400` **Bad Request** **Error Code:** `300` Validation failed. * Phone manufacturer does not exist. * Phone model does not exist. * Phone manufacturer is not supported. **Error Code:** `400` The MAC Addres

🟠409**HTTP Status Code:** `409` **Error Code:** `409` The MAC Address already exists in the system.