Execute Command
Executes a command on the Webex RoomOS Device. Specify the command to execute in the commandName URI parameter.
See the xAPI section of the Device Developers Guide for a description of command expressions.
POST/v1/xapi/command/{commandName}
URI Parameters
commandName
stringrequired
Command to execute on the Webex RoomOS Device.
Body Parameters
deviceId
stringrequired
The unique identifier for the Webex RoomOS Device.
arguments
objectrequired
xAPI command arguments
Level
number
body
object
xAPI command body, as a complex JSON object or as a string, for example: import xapi from 'xapi';\n\nconsole.log('Hello, World!');\n
Booking
object
Id
string
Title
string
Protocol
string
Time
object
StartTime
string
Duration
number
Organizer
object
Name
string
Number
string
Response Properties
deviceId
string
The unique identifier for the Webex RoomOS Device.
arguments
object
xAPI command arguments
Level
number
result
object
xAPI command results
Booking
object
Id
string
Title
string
Protocol
string
Time
object
StartTime
string
Duration
number
Organizer
object
Name
string
Number
string
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. |
POST
/v1/xapi/command/
Log in to try the API.
Header
Body
- The unique identifier for the Webex RoomOS Device.
- xAPI command arguments
- xAPI command body, as a complex JSON object or as a string, for example: `import xapi from 'xapi';\n\nconsole.log('Hello, World!');\n`
https://webexapis.com/v1/xapi/command/Audio.Volume.Set
{
"deviceId": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM",
"arguments": {
"Level": null
},
"body": {
"Booking": {
"Id": "foo",
"Title": "Booking Title",
"Protocol": "SIP",
"Time": {
"StartTime": "2020-07-01T13:00:00Z",
"Duration": null
},
"Organizer": {
"Name": "John Doe"
},
"Number": "number@example.com"
}
}
}200 / OK
{
"deviceId": "Y2lzY29zcGFyazovL3VzL0RFVklDRS8wNTVkYThiNy02NWI2LTQ5NjgtOTg1ZC02ZmFjODcwOWMyMDM",
"arguments": {
"Level": 50
},
"result": {
"Booking": {
"Id": "foo",
"Title": "Booking Title",
"Protocol": "SIP",
"Time": {
"StartTime": "2020-07-01T13:00:00Z",
"Duration": 60
},
"Organizer": {
"Name": "John Doe"
},
"Number": "number@example.com"
}
}
}