Interact with the API of a Webex Board, Room, or Desk Device over WebSocket

The WebSocket protocol is a protocol that allows full-duplex communication to be established between clients and the API connected to the board, room or desk device on a board, room, or desk. The API commands are communicated over WebSocket by using JSON-RPC objects.

You must set the NetworkServices > WebSocket setting to the FollowHTTPService in order to be able to use WebSockets. Additionally, because WebSocket relies on HTTP, you will need to set NetworkServices > HTTP > Mode to either HTTP+HTTPS or HTTPS in order to use WebSocket.

It is possible to change the configuration of the device both through the web interface and through the API of the device. Detailed information about accessing the web interface and using the API can be found in the Advanced Settings article.

In order to describe the native API that is found in a room or desk device, the term xAPI is often used.

To read more about setting up xAPI over WebSocket and how JSON-RPC objects can be used to transmit API commands, read the xAPI over WebSocket Guide.

In order to get a complete description of the xAPI itself, please refer to the API Reference Guide.