Get Webex Calling Device Details
Not supported for Webex for Government (FedRAMP)
Retrieves Webex Calling device details that include information needed for third-party device management.
Webex calling devices are associated with a specific user Workspace or Virtual Line. Webex Calling devices share the location with the entity that owns them.
Person or workspace to which the device is assigned. Its fields point to a primary line/port of the device.
Requires a full, location, user, or read-only admin auth token with the scope of spark-admin:telephony_config_read.
URI Parameters
Unique identifier for the device.
Query Parameters
ID of the organization in which the device resides.
Response Properties
Manufacturer of the device.
Device manager(s).
A unique identifier for the device.
The current IP address of the device.
The unique address for the network adapter.
A model type of the device.
Activation state of the device. This field is only populated for a device added by a unique activation code generated by Control Hub for use with Webex.
Device is activating using an activation code.
Device has been activated using an activation code.
Device has not been activated using an activation code.
Comma-separated array of tags used to describe the device.
Enabled / disabled status of the upgrade channel.
SIP authentication user name for the owner of the device.
Identifies a device endpoint in standalone mode or a SIP URI public identity in IMS mode.
Outgoing server which the phone should use for all SIP requests. Not set if the response has no body.
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
- ID of the organization in which the device resides.
{
"managedBy": "CUSTOMER",
"owner": {
"sipUserName": "392829",
"linePort": "i6i1ar1v29@98079822.int10.bcld.webex.com"
},
"proxy": {
"outboundProxy": "hs17.hosted-int.bcld.webex.com"
},
"manufacturer": "THIRD_PARTY",
"id": "Y2lzY29zcGFyazovL3VybjpURUFNOnVzLWVhc3QtMV9pbnQxMy9ERVZJQ0UvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
"ip": "100.110.120.130",
"mac": "11223344AAFF",
"model": "DMS Cisco 8811",
"activationState": "activated",
"description": [
"your tag",
"device tag"
],
"upgradeChannelEnabled": "true"
}