Read the List of Supported Devices
Gets the list of supported devices for an organization.
Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.
Query Parameters
List supported devices for an organization.
List supported devices that allow the user to configure the layout.
List supported devices of a specific type. To excluded device types from a request or query, add type=not:DEVICE_TYPE. For example, type=not:MPP.
Response Properties
List of supported devices.
Model name of the device.
Display name of the device.
Type of the device.
Cisco Multiplatform Phone
Analog Telephone Adapters
GENERIC Session Initiation Protocol
Esim Supported Webex Go
Desk Phone
Manufacturer of the device.
Devices manufactured by Cisco.
Devices manufactured by a third-party that are approved by a Cisco account manager to be enabled for provisioning in the control hub.
Users who manage the device.
Devices managed by Cisco.
Devices managed by a customer that are approved by a Cisco account manager to be enabled for provisioning in the control hub.
List of places the device is supported for.
Onboarding method.
Enables / Disables layout configuration for devices.
Number of port lines.
If true, KEM is supported.
Module count.
Enables / disables Kem lines support.
Key expansion module type of the device.
Extension module has 14 line keys that can be configured.
Extension module has 18 line keys that can be configured.
Extension module has 20 line keys that can be configured.
Enables / Disables the upgrade channel.
The default upgrade channel.
Enables / disables the additional primary line appearances.
Enables / disables the additional shared line appearances.
Enables / disables Basic emergency nomadic.
Enables / disables customized behavior support on devices.
Enables / disables configuring port support on device.
Enables / disables customizable line label.
Enables / disables support line port reordering.
Enables / disables port number support.
Enables / disables T.38.
Enables / disables call declined.
Supports touch screen on device.
Number of line key buttons for a device.
Device settings configuration.
Devices which supports Webex Calling Device Settings Configuration.
Devices which supports Webex Device Settings Configuration.
Devices does not support any configuration.
Enables / disables hoteling host.
Device log collection configuration.
Devices which does not support log collection.
Devices which supports Cisco PRT log collection.
Devices which supports Cisco RoomOS log collection.
Enables / disables apply changes.
Enables / disables configure lines.
Enables / disables configure phone settings.
Enables / disables hotline support.
Supports hot desk only.
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
- List supported devices for an organization.
- List supported devices that allow the user to configure the layout.
- List supported devices of a specific type. To excluded device types from a request or query, add `type=not:DEVICE_TYPE`. For example, `type=not:MPP`.
{
"devices": [
{
"model": "2N Customer Managed",
"displayName": "2N Customer Managed",
"type": "GENERIC_SIP",
"manufacturer": "THIRD_PARTY",
"managedBy": "CUSTOMER",
"supportedFor": [
"PEOPLE",
"PLACE"
],
"onboardingMethod": [
"MAC_ADDRESS"
],
"allowConfigureLayoutEnabled": false,
"numberOfLinePorts": 20,
"kemSupportEnabled": true,
"kemModuleCount": 1,
"kemModuleType": [
"KEM_20_KEYS"
],
"upgradeChannelEnabled": false,
"additionalPrimaryLineAppearancesEnabled": false,
"additionalSecondaryLineAppearancesEnabled": false,
"basicEmergencyNomadicEnabled": false,
"customizedBehaviorsEnabled": false,
"allowConfigurePortsEnabled": false,
"customizableLineLabelEnabled": false,
"supportsLinePortReorderingEnabled": false,
"t38Enabled": false,
"callDeclinedEnabled": false,
"touchScreenPhone": false,
"deviceSettingsConfiguration": "NONE",
"allowHotelingHostEnabled": false,
"supportsLogCollection": "NONE",
"supportsApplyChangesEnabled": false,
"allowConfigureLinesEnabled": true,
"allowConfigurePhoneSettingsEnabled": false,
"supportsHotlineEnabled": false,
"supportsHotDeskOnly": false
}
]
}