Qodex.ai

List devices

GET {{baseUrl}}/phone/devices?type=assigned&assignee_type=user&next_page_token=BJLYC6PABbAHdjwSkGVQeeR6B1juwHqj3G2&page_size=30

List all the desk phone devices that are configured with Zoom Phone on an account.

Scopes: phone:read:admin
Rate Limit Label: Medium

Prerequisites:

  • Pro or a higher account with Zoom Phone license
  • Account owner or admin permissions

Request Params

KeyDatatypeRequiredDescription
typestring(Required) Device status: assigned or unassigned to list device status in Zoom account.
assignee_typestringType of the assignee. Available if type = assigned. Unavailable if the account has not enabled the common area feature. Returns devices of the specified assignee_type. If unspecified, returns all assigned devices.
next_page_tokenstringThe 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_sizenumberThe number of records returned within a single API call.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"devices":[{"assignee":{"extension_number":123,"id":"-tDdYIstSumpA0L13GztIQ","name":"Pooja","extension_type":"user"},"assignees":[{"extension_number":123,"id":"-tDdYIstSumpA0L13GztIQ","name":"Pooja","extension_type":"user","extension_id":"MjGXQfCxShapaxJDka7"},{"extension_number":123,"id":"-tDdYIstSumpA0L13GztIQ","name":"Pooja","extension_type":"user","extension_id":"MjGXQfCxShapaxJDka7"}],"device_type":"AudioCodes405","display_name":"Pooja's Phone","id":"-tDdYIstSumpA0L13GztIQ","mac_address":"203a07240534","site":{"id":"NjHmTu16Qfe8yOiNJuekXA","name":"HQ site"},"status":"online","provision_template_id":"Ke5Ghevvoo001hr"},{"assignee":{"extension_number":123,"id":"-tDdYIstSumpA0L13GztIQ","name":"Pooja","extension_type":"user"},"assignees":[{"extension_number":123,"id":"-tDdYIstSumpA0L13GztIQ","name":"Pooja","extension_type":"user","extension_id":"MjGXQfCxShapaxJDka7"},{"extension_number":123,"id":"-tDdYIstSumpA0L13GztIQ","name":"Pooja","extension_type":"user","extension_id":"MjGXQfCxShapaxJDka7"}],"device_type":"AudioCodes405","display_name":"Pooja's Phone","id":"-tDdYIstSumpA0L13GztIQ","mac_address":"203a07240534","site":{"id":"NjHmTu16Qfe8yOiNJuekXA","name":"HQ site"},"status":"online","provision_template_id":"Ke5Ghevvoo001hr"}],"next_page_token":"felbo4ib","page_size":30,"total_records":1}