macide213 / telnyx-rtc-sipjs

Telnyx JavaScript library for building WebRTC apps with SIP.js

Telnyx WebRTC SIP JavaScript library

The Telnyx SIP-based WebRTC JS library powers up your web application with the ability to make and receive phone calls directly in the browser.

Check out the library in action in this web dialer demo.

Looking for more WebRTC features, JSON-RPC support or need to quickly get spun up with a React app? Telnyx also has a robust WebRTC SDK available as a separate npm module.

Installation

Install this package with npm:

$ npm install --save @telnyx/rtc-sipjs

or using yarn:

$ yarn add @telnyx/rtc-sipjs

Usage

Import TelnyxDevice in the module where you need it.

import { TelnyxDevice } from '@telnyx/rtc-sipjs';

Example config and initiation

let config = {
  host: 'sip.telnyx.com',
  port: '7443',
  wsServers: 'wss://sip.telnyx.com:7443',
  displayName: 'Phone User',
  username: 'testuser',
  password: 'testuserPassword',
  stunServers: 'stun:stun.telnyx.com:3478',
  turnServers: {
    urls: ['turn:turn.telnyx.com:3478?transport=tcp'],
    username: 'turnuser',
    password: 'turnpassword',
  },
  registrarServer: 'sip:sip.telnyx.com:7443',
};

let device = new TelnyxDevice(config);

Example phone call

let activeCall = device.initiateCall('1235556789');

activeCall.on('connecting', () => {
  console.log("it's connecting!");
});
activeCall.on('accepted', () => {
  console.log("We're on a phone call!");
});

See the TelnyxDevice and TelnyxCall for more details.

Development

Building the package

When working on the package directly, please use yarn instead of npm.

$ yarn build
# Or to watch for changes to files:
$ yarn start

Running tests

$ yarn test

Generating Docs

We use jsdoc-to-markdown to generate GitHub friendly docs.

$ yarn docs