Test Environment. You are currently using the Webex for Developers test environment. Apps created here will not be available for use with Webex Teams. Please visit Webex for Developers to manage your apps.

Get Device Details

Shows details for a device, by ID.

Specify the device ID in the deviceId parameter in the URI.

GET/v1/devices/{deviceId}
URI Parameters
deviceId
stringrequired

A unique identifier for the device.

Response Properties
id
string

A unique identifier for the device.

displayName
string

A friendly name for the device.

placeId
string

The place associated with the device.

personId
string

The person associated with the device.

orgId
string

The organization associated with the device.

capabilities
array

The capabilities of the device.

permissions
array

The permissions the user has for this device. For example, xapi means this user is entitled to using the xapi against this device.

connectionStatus
Device Connection Status

The connection status of the device.

product
string

The product name.

tags
array

Tags assigned to the device.

ip
string

The current IP address of the device.

activeInterface
Network Connectivty Type

The current network connectivty for the device.

mac
string

The unique address for the network adapter.

primarySipUrl
string

The primary SIP address to dial this device.

sipUrls
array

All SIP addresses to dial this device.

serial
string

Serial number for the device.

software
string

The operating system name data and version tag.

upgradeChannel
string

The upgrade channel the device is assigned to.

created
string

The date and time that the device was registered, in ISO8601 format.

Response Codes

The list below describes the common success and error responses you should expect from the API.

CodeStatusDescription
200OKSuccessful request with body content.
204No ContentSuccessful request without body content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedAuthentication credentials were missing or incorrect.
403ForbiddenThe request is understood, but it has been refused or access is not allowed.
404Not FoundThe 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.
405Method Not AllowedThe request was made to a resource using an HTTP request method that is not supported.
409ConflictThe 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.
415Unsupported Media TypeThe request was made to a resource without specifying a media type or used a media type that is not supported.
429Too Many RequestsToo 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.
500Internal Server ErrorSomething went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502Bad GatewayThe server received an invalid response from an upstream server while processing the request. Try again later.
503Service UnavailableServer is overloaded with requests. Try again later.
GET
/v1/devices/
Log in to try the API.
Header
https://api.ciscospark.com/v1/devices/Y2lzY29zcGFyazovL3VzL0RFVklDRVMvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3
{
  "id": "Y2lzY29zcGFyazovL3VzL0RFVklDRVMvNTEwMUIwN0ItNEY4Ri00RUY3LUI1NjUtREIxOUM3QjcyM0Y3",
  "displayName": "SFO12-3-PanHandle",
  "placeId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
  "personId": "Y2lzY29zcGFyazovL3VzL1BFT1BMRS83MTZlOWQxYy1jYTQ0LTRmZWQtOGZjYS05ZGY0YjRmNDE3ZjU",
  "orgId": "Y2lzY29zcGFyazovL3VzL09SR0FOSVpBVElPTi85NmFiYzJhYS0zZGNjLTExZTUtYTE1Mi1mZTM0ODE5Y2RjOWE",
  "capabilities": [
    {}
  ],
  "permissions": [
    {}
  ],
  "connectionStatus": "connected",
  "product": "Cisco Webex DX80",
  "tags": [
    "First Tag",
    "Second Tag"
  ],
  "ip": "100.110.120.130",
  "activeInterface": "wired",
  "mac": "11:22:33:44:AA:FF",
  "primarySipUrl": "sample_device@sample_placename.orgname.org",
  "sipUrls": [
    "sample_device@sample_placename.orgname.org",
    "another_device@sample_placename.orgname.org"
  ],
  "serial": "FOC1923NVVN",
  "software": "RoomOS 2018-06-01 608dcdbb6e1",
  "upgradeChannel": "beta",
  "created": "2016-04-21T17:00:00.000Z"
}