WhosOn Developer Docs

WhosOn is an on-premises or cloud based website live chat solution for businesses of any size. See: WhosOn.com for more information.

WhosOn provides developer API’s for the operator client, chat window & backend chat data integration.

Client API

The Client API is designed to create desktop, product embedded or browser-based WhosOn Operator Client applications or to add WhosOn Operator functionality to existing applications. Using this interface, it is possible to create your own WhosOn Operator Client applications using any developer platform that supports WebSockets.

Use Cases

  • Create WhosOn Operator Client applications with a much or as little functionality as you need, on any platform using any development tool.

  • Embed WhosOn Operator functionality into existing in house applications.

  • Create real-time dashboard views of visitor & chat activity.

Chat API

The Chat API is designed to create custom desktop, product embedded or browser-based visitor facing WhosOn Chat applications. Using this interface, it is possible to completely replace the standard WhosOn Chat Window with your own using any developer platform that supports WebSockets.

Use Cases

  • Create your own custom chat window using familiar web design tools and existing company styles.

  • Embed chat into existing applications.

  • Easily create custom mobile applications to provide to your customers for chat.

Backend Data API

The Backend Data API enables developers and system integrators to access completed WhosOn Chats as self-contained JSON objects via the WhosOn Server 'Chat Archiving' feature. Once the Chat Archiving feature is enabled, the WhosOn Server will output chat JSON objects automatically as chats complete. The chat JSON can then be used to integrate with other applications, to provide custom reporting, or simply as a secure archive. Chats can be archived to: Microsoft Azure Cosmos DB, Custom Webhook or local folder.

Use Cases

Integration

The Archive can be used to integrate chat data with other applications. Using Azure Cosmos you can create Azure functions that trigger automatically when new chat documents are added. Azure functions can be used to automate integration tasks easily.

Reporting

You can create your own reports and dashboards that query the archive. This would execute independently from the WhosOn Server and therefore not affect server performance. A number of 3rd party reporting solutions are already available that work with Azure Cosmos DB, including Microsoft Power BI, Qlik Sense. Cosmos DB provides a SQL API allowing data to be queried using any development tool.

Performance

Once archiving is enabled it is then possible to remove chats from the local WhosOn SQL database faster. For example, chats could be removed after 3 months instead of 3 years. This improves the performance and storage requirements of the local database.

Compliance

The Azure Cosmos Database provides a trusted, secure, globally distributed database service. To help customers meet their own compliance obligations across regulated industries and markets worldwide, Azure maintains the largest compliance portfolio in the industry in terms of both breadth (total number of offerings) and depth (number of customer-facing services in assessment scope).