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 https://support.zoom.us/hc/enus/articles/360028516231ManagingCommonAreaPhones#h_2d0da347c35a49939771e21aaa568deb .**Prerequisites:*** Pro or a higher account with Zoom Phone license.* Account owner or admin permissions.* Supported device https://support.zoom.us/hc/enus/articles/360001299063ZoomVoiceSupportedDevices **Scope:** phone:write:admin ** Rate Limit Label https://marketplace.zoom.us/docs/apireference/ratelimits#ratelimits :** Light

addCommonAreaPhone(
  site_id = NULL,
  display_name,
  description = NULL,
  extension_number,
  mac_address,
  type,
  model = NULL,
  time_zone = NULL,
  return_response = F
)

Arguments

site_id	Unique identifier of the site https://support.zoom.us/hc/enus/articles/360020809672 . This can be retrieved from List Sites API.
display_name	Display name of the Common area phone.
description	Description for the common area phone.
extension_number	Extension number assigned to the common area phone. If site code is enabled, provide the short extension number instead.
mac_address	Mac Address serial number of the common area desk phone. These examples show the formats supported: 64167f379092 or 64167f379092
type	Phone device manufacturer name. Refer to the "Manufacturer Name" field in this https://marketplace.zoom.us/docs/apireference/otherreferences/zoomphonesupporteddevice table.
model	Device Model name. Refer to the "Model Name" field in this https://marketplace.zoom.us/docs/apireference/otherreferences/zoomphonesupporteddevice table.
time_zone	Timezone ID https://marketplace.zoom.us/docs/apireference/otherreferences/abbreviationlists for the common area phone.
return_response	Whether to return the response instead of the response content. Defaults to FALSE.

Arguments

Contents