Zoom Public API Documentation
List devices
GET {{baseUrl}}/phone/devices?type=assigned&assignee_type=commonArea&device_source=haas&location_status=unknownAddress&site_id=<string>&device_type=yealink&keyword=<string>&next_page_token=<string>&page_size=30
Lists all the desk phone devices that are configured with Zoom Phone on an account. Prerequisites: Scopes: Granular Scopes: Rate Limit Label:
phone:read:adminphone:read:list_devices:adminMEDIUM
Body
PARAM
| Key | Datatype | Required | Description |
type
|
string | (Required) The device status: `assigned` or `unassigned` to list device status in Zoom account. | |
assignee_type
|
string | The type of the assignee. It's available if `type = assigned`. It's unavailable if the account has not enabled the common area feature. It also returns devices of the specified `assignee_type`. If unspecified, it returns all assigned devices. | |
device_source
|
string | The device source. `hotDesking` is only available when `type = assigned`. | |
location_status
|
string | The status of device location. It's available if `type = assigned`. | |
site_id
|
string | The site of the assignee. | |
device_type
|
string | The manufacturer name or device type. | |
keyword
|
string | The user, extension, MAC address, or IP address to filter the results. | |
next_page_token
|
string | The next page token paginates through a large set of results. A next page token returns whenever the set of available results exceeds the current page size. The expiration period for this token is 15 minutes. | |
page_size
|
number | The number of records returned within a single API call. |
HEADERS
| Key | Datatype | Required | Description |
Accept
|
string |
RESPONSES
status OK
| {
"devices": [
{
"assignee": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"extension_type": "user"
},
"assignees": [
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"extension_type": "user",
"extension_id": "<string>"
},
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"extension_type": "commonArea",
"extension_id": "<string>"
}
],
"device_type": "<string>",
"display_name": "<string>",
"id": "<string>",
"mac_address": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"status": "offline",
"provision_template_id": "<string>"
},
{
"assignee": {
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"extension_type": "commonArea"
},
"assignees": [
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"extension_type": "user",
"extension_id": "<string>"
},
{
"extension_number": "<long>",
"id": "<string>",
"name": "<string>",
"extension_type": "user",
"extension_id": "<string>"
}
],
"device_type": "<string>",
"display_name": "<string>",
"id": "<string>",
"mac_address": "<string>",
"site": {
"id": "<string>",
"name": "<string>"
},
"status": "offline",
"provision_template_id": "<string>"
}
],
"next_page_token": "<string>",
"page_size": "<integer>",
"total_records": "<integer>"
} |
Curl
curl -X GET 'https://api.zoom.us/v2/phone/devices?type=assigned&assignee_type=commonArea&device_source=haas&location_status=unknownAddress&site_id=<string>&device_type=yealink&keyword=<string>&next_page_token=<string>&page_size=30?type=assigned&assignee_type=commonArea&device_source=haas&location_status=unknownAddress&site_id=<string>&device_type=yealink&keyword=<string>&next_page_token=<string>&page_size=30' -H 'Accept: application/json'
ENDPOINTS