Package Exports
- sip.js
- sip.js/lib/api/exceptions/session-description-handler
- sip.js/lib/api/exceptions/session-description-handler.js
- sip.js/lib/api/invitation
- sip.js/lib/api/invitation.js
- sip.js/lib/api/inviter
- sip.js/lib/api/inviter.js
- sip.js/lib/api/message
- sip.js/lib/api/message.js
- sip.js/lib/api/messager
- sip.js/lib/api/messager.js
- sip.js/lib/api/registerer
- sip.js/lib/api/registerer-state
- sip.js/lib/api/registerer-state.js
- sip.js/lib/api/registerer.js
- sip.js/lib/api/session-state
- sip.js/lib/api/session-state.js
- sip.js/lib/api/transport-state
- sip.js/lib/api/transport-state.js
- sip.js/lib/api/user-agent
- sip.js/lib/api/user-agent-state
- sip.js/lib/api/user-agent-state.js
- sip.js/lib/api/user-agent.js
- sip.js/lib/core
- sip.js/lib/core/index.js
- sip.js/lib/core/log/levels
- sip.js/lib/core/log/levels.js
- sip.js/lib/core/messages/methods/constants
- sip.js/lib/core/messages/methods/constants.js
- sip.js/lib/core/messages/parser
- sip.js/lib/core/messages/parser.js
- sip.js/lib/grammar/uri
- sip.js/lib/grammar/uri.js
- sip.js/lib/index.js
- sip.js/lib/platform/web
- sip.js/lib/platform/web/index.js
- sip.js/lib/platform/web/modifiers
- sip.js/lib/platform/web/modifiers/index.js
- sip.js/lib/platform/web/modifiers/modifiers
- sip.js/lib/platform/web/modifiers/modifiers.js
- sip.js/lib/platform/web/session-description-handler
- sip.js/lib/platform/web/session-description-handler/index.js
- sip.js/lib/platform/web/session-description-handler/media-stream-factory-default
- sip.js/lib/platform/web/session-description-handler/media-stream-factory-default.js
- sip.js/lib/platform/web/session-description-handler/peer-connection-configuration-default
- sip.js/lib/platform/web/session-description-handler/peer-connection-configuration-default.js
- sip.js/lib/platform/web/session-description-handler/session-description-handler
- sip.js/lib/platform/web/session-description-handler/session-description-handler-options
- sip.js/lib/platform/web/session-description-handler/session-description-handler-options.js
- sip.js/lib/platform/web/session-description-handler/session-description-handler.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (sip.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme

SIP Library for JavaScript
- Create real-time peer-to-peer audio and video sessions via WebRTC
- Utilize SIP in your web application via SIP over WebSocket
- Send instant messages and view presence
- Support early media, hold and transfers
- Send DTMF RFC 2833 or SIP INFO
- Share your screen or desktop
- Written in TypeScript
- Runs in all major web browsers
- Compatible with standards compliant servers including Asterisk and FreeSWITCH
Demo
Want see it in action? The project website, sipjs.com, has a live demo.
Looking for code to get started with? This repository includes demonstrations which run in a web browser.
Usage
To place a SIP call, either utilize the SimpleUser class...
import { Web } from "sip.js";
// Helper function to get an HTML audio element
function getAudioElement(id: string): HTMLAudioElement {
  const el = document.getElementById(id);
  if (!(el instanceof HTMLAudioElement)) {
    throw new Error(`Element "${id}" not found or not an audio element.`);
  }
  return el;
}
// Options for SimpleUser
const options: Web.SimpleUserOptions = {
  aor: "sip:alice@example.com", // caller
  media: {
    constraints: { audio: true, video: false }, // audio only call
    remote: { audio: getAudioElement("remoteAudio") } // play remote audio
  }
};
// WebSocket server to connect with
const server = "wss://sip.example.com";
// Construct a SimpleUser instance
const simpleUser = new Web.SimpleUser(server, options);
// Connect to server and place call
simpleUser.connect()
  .then(() => simpleUser.call("sip:bob@example.com"))
  .catch((error: Error) => {
    // Call failed
  });Or, alternatively, use the full API framework...
import { Inviter, SessionState, UserAgent } from "sip.js";
// Create user agent instance (caller)
const userAgent = new UserAgent({
  uri: UserAgent.makeURI("sip:alice@example.com"),
  transportOptions: {
    server: "wss://sip.example.com"
  },
});
// Connect the user agent
userAgent.start().then(() => {
  // Set target destination (callee)
  const target = UserAgent.makeURI("sip:bob@example.com");
  if (!target) {
    throw new Error("Failed to create target URI.");
  }
  // Create a user agent client to establish a session
  const inviter = new Inviter(userAgent, target, {
    sessionDescriptionHandlerOptions: {
      constraints: { audio: true, video: false }
    }
  });
  // Handle outgoing session state changes
  inviter.stateChange.addListener((newState) => {
    switch (newState) {
      case SessionState.Establishing:
        // Session is establishing
        break;
      case SessionState.Established:
        // Session has been established
        break;
      case SessionState.Terminated:
        // Session has terminated
        break;
      default:
        break;
    }
  });
  // Send initial INVITE request
  inviter.invite()
    .then(() => {
      // INVITE sent
    })
    .catch((error: Error) => {
      // INVITE did not send
    });
});Installation
Node module
npm install sip.jsUMD bundle
- Download sipjs.com/download
- CDN jsDelivr.com
Building, Development and Testing
Clone this repository, then...
npm install
npm run build-and-testFor more info please see the Documentation.
Support
- For migration guides and API reference please see the Documentation.
- For bug reports and feature requests please open a GitHub Issue.
- For questions or usage problems please use the Google Group.
- For more information see the project website at SIPjs.com.