POST /phone/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 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
Servers
- https://api.zoom.us/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
extension_number |
Integer | Yes |
Extension number assigned to the common area phone. If site code is enabled, provide the short extension number instead. |
time_zone |
String | No |
Timezone ID for the common area phone. |
site_id |
String | No |
Unique identifier of the site. This can be retrieved from the List Phone Sites API. |
description |
String | No |
Description for the common area phone. |
display_name |
String | Yes |
Display name of the Common area phone. |
type |
String | Yes |
Phone device manufacturer name. Refer to the "Manufacturer Name" field in this table. |
mac_address |
String | Yes |
Mac Address (serial number) of the common area desk phone. These examples show the formats supported: |
model |
String | No |
Device Model name. Refer to the "Model Name" field in this table. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.