Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/versatica/JsSIP
JsSIP, the JavaScript SIP library
https://github.com/versatica/JsSIP
Last synced: 9 days ago
JSON representation
JsSIP, the JavaScript SIP library
- Host: GitHub
- URL: https://github.com/versatica/JsSIP
- Owner: versatica
- License: other
- Created: 2012-07-09T07:16:01.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2024-06-21T20:29:04.000Z (5 months ago)
- Last Synced: 2024-10-17T21:29:48.069Z (17 days ago)
- Language: JavaScript
- Homepage: https://jssip.net
- Size: 12.7 MB
- Stars: 2,417
- Watchers: 157
- Forks: 743
- Open Issues: 29
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- starred-awesome - JsSIP - JsSIP, the JavaScript SIP library (JavaScript)
README
[](https://travis-ci.com/versatica/JsSIP)
[](https://lgtm.com/projects/g/versatica/JsSIP/context:javascript)
[](https://lgtm.com/projects/g/versatica/JsSIP/alerts)
## Overview
* Runs in the browser and Node.js.
* SIP over [WebSocket](https://jssip.net/documentation/misc/sip_websocket/) (use real SIP in your web apps)
* Audio/video calls ([WebRTC](https://jssip.net/documentation/misc/webrtc)) and instant messaging
* Lightweight!
* Easy to use and powerful user API
* Works with OverSIP, Kamailio, Asterisk. Mobicents and repro (reSIProcate) servers ([more info](https://jssip.net/documentation/misc/interoperability))
* Written by the authors of [RFC 7118 "The WebSocket Protocol as a Transport for SIP"](https://tools.ietf.org/html/rfc7118) and [OverSIP](http://oversip.net)
## NOTE
Starting from 3.0.0, JsSIP no longer includes the [rtcninja](https://github.com/eface2face/rtcninja.js/) module. However, the [jssip-rtcninja](https://www.npmjs.com/package/jssip-rtcninja) package is based on the `2.0.x` branch, which does include `rtcninja`.
## Support
* For questions or usage problems please use the **jssip** [public Google Group](https://groups.google.com/forum/#!forum/jssip).
* For bug reports or feature requests open an [Github issue](https://github.com/versatica/JsSIP/issues).
## Getting Started
The following simple JavaScript code creates a JsSIP User Agent instance and makes a SIP call:
```javascript
// Create our JsSIP instance and run it:
var socket = new JsSIP.WebSocketInterface('wss://sip.myhost.com');
var configuration = {
sockets : [ socket ],
uri : 'sip:[email protected]',
password : 'superpassword'
};
var ua = new JsSIP.UA(configuration);
ua.start();
// Register callbacks to desired call events
var eventHandlers = {
'progress': function(e) {
console.log('call is in progress');
},
'failed': function(e) {
console.log('call failed with cause: '+ e.data.cause);
},
'ended': function(e) {
console.log('call ended with cause: '+ e.data.cause);
},
'confirmed': function(e) {
console.log('call confirmed');
}
};
var options = {
'eventHandlers' : eventHandlers,
'mediaConstraints' : { 'audio': true, 'video': true }
};
var session = ua.call('sip:[email protected]', options);
```
Want to see more? Check the full documentation at https://jssip.net/documentation/.
## Online Demo
Check our **Tryit JsSIP** online demo:
* [tryit.jssip.net](https://tryit.jssip.net)
## Website and Documentation
* [jssip.net](https://jssip.net/)
## Download
* As Node module: `$ npm install jssip`
* Manually: [jssip.net/download](https://jssip.net/download/)
## Authors
#### José Luis Millán
* Main author. Core Designer and Developer.
* (Github [@jmillan](https://github.com/jmillan))
#### Iñaki Baz Castillo
* Core Designer and Developer.
* (Github [@ibc](https://github.com/ibc))
#### Saúl Ibarra Corretgé
* Core Designer.
* (Github [@saghul](https://github.com/saghul))
## License
JsSIP is released under the [MIT license](https://jssip.net/license).