Webchat

Beta Access

The Webchat is not a production product at this time and should not be used in a production situation until we have officially released it. However if you are interested in accessing it ahead of time we have made that option available to you. In order to access the beta release of the Webchat you will need to point your integration to our staging environment ( again not meant for production use ).

Do note you will have to submit a request for your account to be enabled in our staging environment in order for this to work.

Overview

Webchat is a multi-user group chat video chat experience. Webchat provides a multi-room tabbed chat experience allowing your users to interact in multiple rooms simultaneously, and engage with one room via audio and video.

Example

<script type="text/javascript" src="http://cdn.stage.userplane.com/release/sdk/userplane.js"></script>
<script>
   // Embed the Userplane SDK and provide the general configuration for your account.
   up.init({
      siteId:"YOUR_SITE_ID",
      token: "YOUR_SSO_TOKEN",
      lang: "en-us"
   });

   // Add an onReady handler to launch the Webchat experience once the Userplane SDK is available.
   onReady = function () {
   var roomsList = [ {roomId:"lobby", roomName:"Lobby"}];
   up.api.require("Webchat",{ roomsList:roomsList, containerId: "chat-container-div" } );
  }
  up.api.addEventListener(up.api.events.READY,onReady);

</script>

<div id="chat-container-div"></div>

Properties