Qodex.ai

Webex Devices /xAPI

Number of APIs: 19

The xAPI allows developers to programmatically invoke commands and query the status of devices that run Webex RoomOS software: - Executing commands requires an auth token with the spark:xapicommands scope. - Querying devices requires an auth token with the spark:xapistatuses scope.

To manage Devices, see the Devices API. xAPI commands and statuses are described in the Cisco Collaboration Endpoint Software API Reference Guide. For more information about xAPI, see the xAPI Guide.

https://developer.webex.com/docs/api/v1/xapi

Quick start - add an access_token to your environment - start with the init folder in order to setup your environment with the first device your token has access to

Environment variables: - [required] access_token: bot token who has been granted xAPI access (R/O or R/W) via the Webex Control Hub

Dynamically variables (computed via tests scripts): - _deviceId: device identifier accessible from the access token - _callId: id of the call just initiated (in order to end the call essentially)

  1. init - List Devices (xAPI enabled) GET {{WEBEXAPI}}/devices?permissions=xapi

  2. init - Get my Details GET {{WEBEXAPI}}/people/me

  3. status - Get Device Status (all) GET {{WEBEXAPI}}/xapi/status?deviceId={{_deviceId}}&name=*

  4. room analytics - Deactivate Standby POST {{WEBEXAPI}}/xapi/command/Standby.Deactivate

  5. httpclient - Post Request (Webex - Create Room) POST {{WEBEXAPI}}/xapi/command/Httpclient.Post

  6. mute - Unmute Microphone POST {{WEBEXAPI}}/xapi/command/Audio.Microphones.Unmute

  7. mute - Mute Microphone POST {{WEBEXAPI}}/xapi/command/Audio.Microphones.Mute

  8. mute - Toggle Mute POST {{WEBEXAPI}}/xapi/command/Audio.Microphones.ToggleMute

  9. alert - Send Alert Message POST {{WEBEXAPI}}/xapi/command/UserInterface.Message.Alert.Display

  10. alert - Clear Alert Message POST {{WEBEXAPI}}/xapi/command/UserInterface.Message.Alert.Clear