Guides

Receive a Call

Overview

This guide uses the full SIP.js API. The SIP.js Simple API is intended to help get beginners up and running quickly.

HTML

Create an HTML file. You could include the SIP.js library, as well as any other javascript that will be used. We are assuming SIP.js is imported as a node module for this demo;

A <video> element is need to display the video stream. The <video> element adds a standard way for browsers to display video over the internet without additional plugins. This makes <video> elements perfect for WebRTC.

Within the <body> tags, there is a remoteVideo <video> element, to display the video of the person being called. There is also a localVideo <video> element, to display the video stream that is being sent to the person being called. The local video stream should always be muted to prevent feedback.

<html>
  <head>
    <link rel="stylesheet" href="my-styles.css">
  </head>
  <body>
    <video id="remoteVideo"></video>
    <video id="localVideo" muted="muted"></video>

    <script src="my-javascript.js"></script>
  </body>
</html>

Javascript

Creating a User Agent

In order to receive messages, create a SIP user agent. You will need a registered user agent to receive an initial request. Replace the information below with your own information.

/* could also be 
var SIP = require("sip.js");
var UA = SIP.UA;
*/

var userAgent = new UA({
  uri: 'test@example.com',
  authorizationUser: 'test',
  password: 'password'
});

Accept a Call

Finally, To accept a call that is being received, catch the invite event. This event is emitted with a session that the .accept() method must be called on.

userAgent.on('invite', (session) => session.accept());

Attaching Media

Please see the attach media guide.

Ending a Session

To end a session, simply call the terminate method on the session to send a bye.

session.terminate();