Get common area phone details

GET

/phone/common_area_phones/{commonAreaPhoneId}

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 get details on a specific common area phone 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:

Pro or a higher account with Zoom Phone license.

Account owner or admin permissions.

Supported device
Scopes: phone:read:admin

Rate Limit Label: Light

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/phone/common_area_phones/'

响应示例

200 - response

{
  "device_type": "Cisco cp7821",
  "display_name": "testcommonareaphone",
  "id": "d6dfgdfgfdgiglw",
  "mac_address": "105f11123456",
  "provision": {
    "sip_accounts": [
      {
        "authorization_id": "1234567894",
        "outbound_proxy": "abcd.zoom.us:1001",
        "password": "SomeRandomPasswordValue",
        "sip_domain": "abc.zoomcloudpbx.com",
        "user_name": "71600000002730"
      }
    ],
    "type": "manual"
  },
  "site": {
    "id": "CEdfdfgdgixWA",
    "name": "Main Site"
  },
  "status": "offline"
}

请求参数

Path 参数

commonAreaPhoneId

string

必需

Unique Identifier of the Common Area Phone. 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). You can retrieved this from the List Common Area Phones API.

返回响应

🟢200**HTTP Status Code:** `200` **OK**<br> Common Area Phone details returned successfully.

application/json

Body

device_type

string

可选

Type of device (manufacturer name + model name).

string

可选

Unique Identifier of the common area phone.

mac_address

string

可选

Mac address or serial number.

name

string

可选

Display name of the common area phone.

provision

object

可选

Provisioning information of the common area phone.

sip_accounts

array [object {5}]

可选

SIP Account details registered during the device provisioning process. This object will only be returned if manual provisioning was used for the device.

type

enum<string>

可选

Provisioning type. The value can be one of the following:

ztp : Zero touch provisioning.

assisted: Assisted provisioning.

manual: Manual provisioning.

枚举值:

assistedztpmanual

url

string

可选

Provisioning URL. This field will only be returned for devices that were provisioned via assisted provisioning type.

site

object

可选

string

可选

Unique identifier of the site to which the common area desk phone is assigned.

name

string

可选

Name of the site.

status

string

可选

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

🟠400**HTTP Status Code:** `400` **Bad Request**<br> **Error Code:** `400`<br> Device does not exist in the system.

修改于 2024-04-24 09:06:48

Delete a common area phone

Update common area phone