action zoom_get_acommon_area_phone {
label: "Get common area phone details"
description: "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 get details on a specific [common area phone](https://support.zoom.us/hc/en-us/articles/360028516231-Managing-Common-Area-Phones) in an account.
For the `commonAreaPhoneId`, use the unique identifier or the Mac address of the common area phone. The Mac address can be hyphenated (00-04-f2-5e-ec-3c) or not hyphenated (0004f25eec3c).
**Prerequisites:**
\n* Pro or a higher account with Zoom Phone license.\n* Account owner or admin permissions.\n* [Supported device](https://support.zoom.us/hc/en-us/articles/360001299063-Zoom-Voice-Supported-Devices)
\n**Scopes:** `phone:read:admin`
\n\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
provider: zoom
method: GET
path: "/phone/common_area_phones/{commonAreaPhoneId}"
encoding: json
input: {
type: "object"
properties: {
commonAreaPhoneId: {
type: "string"
}
}
required: ["commonAreaPhoneId"]
additionalProperties: false
}
output: {
type: "object"
properties: {
device_type: {
type: "string"
description: "Type of device (manufacturer name + model name)."
}
id: {
type: "string"
description: "Unique Identifier of the common area phone."
}
mac_address: {
type: "string"
description: " Mac address or serial number."
}
name: {
type: "string"
description: "Display name of the common area phone."
}
provision: {
type: "object"
description: "Provisioning information of the common area phone."
properties: {
sip_accounts: {
type: "array"
description: "SIP Account details registered during the device provisioning process. This object will only be returned if manual provisioning was used for the device. "
items: {
type: "object"
properties: {
authorization_id: {
type: "string"
description: "Authorization ID of the SIP account provided in the provisioning process."
}
outbound_proxy: {
type: "string"
description: "Outbound proxy provided in the provisioning process."
}
password: {
type: "string"
description: "Password entered during the provisioning process. "
}
sip_domain: {
type: "string"
description: "SIP Domain provided in the provisioning process.
\n "
}
user_name: {
type: "string"
description: "User name of the SIP account provided in the provisioning process."
}
}
}
}
type: {
type: "string"
description: "[Provisioning type](https://support.zoom.us/hc/en-us/articles/360033223411). The value can be one of the following:\n\n* `ztp` : Zero touch provisioning.\n* `assisted`: Assisted provisioning.\n* `manual`: Manual provisioning. \n\n"
enum: ["assisted", "ztp", "manual"]
}
url: {
type: "string"
description: "Provisioning URL. This field will only be returned for devices that were provisioned via `assisted` provisioning type."
}
}
}
site: {
type: "object"
properties: {
id: {
type: "string"
description: "Unique identifier of the [site](https://support.zoom.us/hc/en-us/articles/360020809672-Managing-Multiple-Sites) to which the common area desk phone is assigned."
}
name: {
type: "string"
description: "Name of the site."
}
}
}
status: {
type: "string"
description: "Status of the common area phone. It can be either `online` or `offline`."
}
}
}
}