purecloud-webrtc-sdk

PureCloud WebRTC SDK

Overview

The PureCloud WebRTC SDK is a client library for connecting to PureCloud WebRTC services. Supported WebRTC Features:

• WebRTC SoftPhone (Authenticated Business User/Agent Telephony - inbound/outbound, etc)
• WebRTC Screen Share (Unauthenticated User/Guest)

Demo: https://sdk-cdn.mypurecloud.com/webrtc-sdk/demo/webpack/

• Demo requires PureCloud Credentials for video. Organization id and security key are required for unauthenticated screen share.

Not yet supported:

• WebRTC Video
• WebRTC Screen Share (Authenticated Business User/Agent Telephony)
• WebRTC Screen Recording
• WebRTC Click-to-Call (Unauthenticated user SoftPhone, Telephony)

Usage

Module import:

• npm install --save purecloud-webrtc-sdk

const PureCloudWebrtcSdk = require('purecloud-webrtc-sdk');
const sdk = new PureCloudWebrtcSdk({
  accessToken: 'your-access-token'
});
sdk.initialize();

Or via global module

<script src="https://sdk-cdn.mypurecloud.com/webrtc-sdk/latest/purecloud-webrtc-sdk.bundle.min.js"></script>
<script>
  const sdk = new window.PureCloudWebrtcSdk({
    accessToken: 'your access token'
  });
  sdk.initialize();
</script>

Documentation

Documentation is in doc/documentation.md and available on the PureCloud Developer Center at DeveloperCenter and in the documentation in this repo.

Contributing

This repo uses typescript semistandard for code style and Jest for tests and code coverage.

To get started in development:

npm install
npm run watch-tests

Test will rebuild as source or tests change. All linting (semistandard) and tests must pass 100%, and coverage should remain at 100%.

Testing

Run the tests using npm test in the command line