Get Workspace Devices
Get all devices for a workspace.
This requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
URI Parameters
ID of the workspace for which to retrieve devices.
Query Parameters
Organization to which the workspace belongs.
Response Properties
Array of devices associated with a workspace.
Unique identifier for a device.
Comma separated array of tags used to describe device.
Identifier for device model.
MAC address of device.
IP address of device.
Indicates whether the person or the workspace is the owner of the device and points to a primary Line/Port of the device.
Indicates if the line is acting as a primary line or a shared line for this device.
Primary line for the member.
Shared line for the member. A shared line allows users to receive and place calls to and from another user's extension, using their own device.
Indicates Hoteling details of a device.
Enable/Disable hoteling Host. Enabling the device for hoteling means that a guest(end user) can log into this host(workspace device) and use this device
as if it were their own. This is useful when traveling to a remote office but still needing to place/receive calls with their telephone number and access features normally available to them on their office phone.
Enable limiting the time a guest can use the device. The time limit is configured via guestHoursLimit.
Time Limit in hours until hoteling is enabled. Mandatory if limitGuestUse is enabled.
Owner of the device.
Unique identifier of a person or a workspace.
Enumeration that indicates if the member is of type PEOPLE or PLACE.
Indicates the associated member is a person.
Indicates the associated member is a workspace.
Indicates the associated member is a virtual line.
First name of device owner.
Last name of device owner.
Activation state of a device.
Indicates a device is activating.
Indicates a device is activated.
Indicates a device is deactivated.
Maximum number of devices a workspace can be assigned to.
Response Codes
The list below describes the common success and error responses you should expect from the API:
| Code | Status | Description |
|---|---|---|
| 200 | OK | Successful request with body content. |
| 201 | Created | The request has succeeded and has led to the creation of a resource. |
| 202 | Accepted | The request has been accepted for processing. |
| 204 | No Content | Successful request without body content. |
| 400 | Bad Request | The request was invalid or cannot be otherwise served. An accompanying error message will explain further. |
| 401 | Unauthorized | Authentication credentials were missing or incorrect. |
| 403 | Forbidden | The request is understood, but it has been refused or access is not allowed. |
| 404 | Not Found | The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method. |
| 405 | Method Not Allowed | The request was made to a resource using an HTTP request method that is not supported. |
| 409 | Conflict | The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once. |
| 410 | Gone | The requested resource is no longer available. |
| 415 | Unsupported Media Type | The request was made to a resource without specifying a media type or used a media type that is not supported. |
| 423 | Locked | The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again. |
| 428 | Precondition Required | File(s) cannot be scanned for malware and need to be force downloaded. |
| 429 | Too Many Requests | Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made. |
| 500 | Internal Server Error | Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team. |
| 502 | Bad Gateway | The server received an invalid response from an upstream server while processing the request. Try again later. |
| 503 | Service Unavailable | Server is overloaded with requests. Try again later. |
| 504 | Gateway Timeout | An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it. |
Header
Query Parameters
- Organization to which the workspace belongs.
{
"devices": [
{
"id": "Y2lzY29zcGFyazovL3VzL0RFVklDRS81NzU2YWE1Yy1jODc4LTQ3MjQtOGQ3ZS03NDE1MGU3YjQ0YmQ",
"descriptions": [
"Your tag",
"John Doe (Cisco 8875)"
],
"model": "DMS Cisco 8875",
"mac": "52EAD324FD21",
"ipAddress": "10.201.128.187",
"displayName": "Cisco 8875",
"primaryOwner": true,
"type": "PRIMARY",
"hoteling": {
"enabled": true,
"limitGuestUse": true,
"guestHoursLimit": 24
},
"owner": {
"id": "Y2lzY29zcGFyazovL3VzL1BFUlNPTi81NzU2YWE1Yy03YjQ0LTQ3MjQtOGQ3ZS03NDE1MGVjODc4YmQ",
"type": "PEOPLE",
"firstName": "John",
"lastName": "Doe"
}
}
],
"maxDeviceCount": 1
}