Query Status

Query the current status of the Webex RoomOS Device.

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

The target device is queried for statuses according to the expression in the name parameter.

See the xAPI Guide for a description of status expressions.

GET/v1/xapi/status
Query Parameters
deviceId
stringrequired

The unique identifier for the Webex RoomOS Device.

name
stringrequired

Status expression used to query the Webex RoomOS Device.

Response Properties
deviceId
string

The unique identifier for the Webex RoomOS Device.

result
object

xAPI status result

Audio
object
Volume
number
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/xapi/status{?deviceId,name}
Log in to try the API.
Header
Query Parameters
  • The unique identifier for the Webex RoomOS Device.
  • Status expression used to query the Webex RoomOS Device.
https://api.ciscospark.com/v1/xapi?deviceId=Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM&name=audio.volume
{
  "deviceId": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM",
  "result": {
    "Audio": {
      "Volume": 75
    }
  }
}