List devices

GET

/phone/devices

Phone Devices

List all the desk phone devices that are configured with Zoom Phone on an account. To view devices that have not yet been assigned to a user, set the value of the type query parameter as unassigned and to view devices that have been assigned, set the value as assigned.

Scopes: phone:read:admin

Prerequisites:

Pro or a higher account with Zoom Phone license

Account owner or admin permissions

Rate Limit Label: Medium

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://api.zoom.us/v2/phone/devices?type'

响应示例

{
  "devices": [
    {
      "assignee": {
        "extension_number": 123,
        "id": "i242djsgrg",
        "name": "Pooja"
      },
      "device_type": "AudioCodes405",
      "display_name": "Pooja's Phone",
      "id": "1234324",
      "mac_address": "203a07240534",
      "site": {
        "id": "sdfdgdg32",
        "name": "HQ site"
      },
      "status": "online"
    }
  ],
  "next_page_token": "proident in o",
  "page_size": 80839828,
  "total_records": "qui sunt esse"
}

请求参数

Query 参数

type

enum<string>

必需

State of the device. The value should be either assigned to list devices that have been assigned to user(s) or unassigned to list devices that have not yet been assigned to any user in the Zoom account.

枚举值:

assignedunassigned

next_page_token

string

可选

The next page token is used to paginate through large result sets. A next page token will be returned whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes.

page_size

integer

可选

The number of records returned within a single API call.

<= 300

默认值:

返回响应

🟢200**HTTP Status Code:** `200`<br> Devices listed successfully.

application/json

Body

devices

array [object {7}]

可选

assignee

object

可选

device_type

string

可选

Includes manufacturer name and the model name.

display_name

string

可选

Display name of the device.

string

可选

Device ID - Unique Identifier of the Device.

mac_address

string

可选

MAC address or serial number of the device.

site

object

可选

status

enum<string>

可选

Status of the device. The value is either online or offline.

枚举值:

onlineoffline

next_page_token

string

可选

page_size

integer

可选

The number of records returned with a single API call.

total_records

string

可选

The total number of records found for the query across all pages.

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

Update common area phone

Add a device