genesys-cloud-webrtc-sdk

Genesys Cloud WebRTC SDK

Overview

The Genesys Cloud WebRTC SDK is a client library for connecting to Genesys Cloud 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 Genesys Cloud 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 genesys-cloud-webrtc-sdk

/* import */
import { GenesysCloudWebrtcSdk } from 'genesys-cloud-webrtc-sdk';
/* or require */
const { GenesysCloudWebrtcSdk } = require('genesys-cloud-webrtc-sdk');

const sdk = new GenesysCloudWebrtcSdk({
  accessToken: 'your-access-token'
});
sdk.initialize();

Or via global module

Note: /latest/ is no longer supported in the cdn url. By default, the latest version will also be used.

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

You can also use a specific version:

<script src="https://sdk-cdn.mypurecloud.com/webrtc-sdk/4.0.1/genesys-cloud-webrtc-sdk.bundle.min.js"></script>

Documentation

Documentation is in doc/documentation.md and available on the Genesys Cloud 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 test:watch

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

Testing

Run the tests using npm test in the command line