callstats-sipjs
v1.1.2
Published
SIP.js interface for callstats.io
Downloads
6
Readme
callstats-sipjs
SIP.js interface to callstats.io.
Currently supported SIP.js library
- [x] Version 0.13.1
- [x] Version 0.13.0
- [x] Version 0.12.0
- [x] Version 0.11.2
- [x] Version 0.11.1
- [x] Version 0.11.0
- [x] Version 0.10.0
- [x] Version 0.7.8
Install
- Adding a
<script>tag in the HTML.
In case no module loaded is used, a global window.callstatssipjs is exposed.
NOTE: This library does not include the callstats.io library (it must be added separetely).
Documentation
- Read the full documentation in the docs folder.
Usage example
In the HTML:
<!DOCTYPE html>
<html>
<head>
<!-- Load callstats.io library (it provides window.callstats -->
<script src="https://api.callstats.io/static/callstats.min.js"></script>
<!-- Load SIPjs library -->
<script src="js/sipjs.js"></script>
<!-- Load callstats-sipjs library (it provides window.callstatssipjs) -->
<script src="js/callstats-sipjs.js"></script>
<!-- Load our app code -->
<script src="js/app.js"></script>
</head>
<body>
<!-- your stuff -->
</body>
</html>In app.js:
// Create a SIP.UA instance
var ua = new SIP.UA(config);
// Run the callstats-sipjs library for this UA
var callStats = callstatssipjs(ua, AppID, AppSecret);Development (TODO)
When using Bower or a <script> tag, the provided library is built with browserify, which means that it can be used with any kind of JavaScript module loader system (AMD, CommonJS, etc) or,
- Using NPM:
$ npm install callstats-sipjs - Using Bower:
$ bower install callstats-sipjs
Install NPM development dependencies:
$ npm installInstall gulp-cli globally (which provides the gulp command):
$ npm install -g gulpjsgulp prodgenerates a production/minifieddist/callstats-sipjs.min.jsbundle.gulp devgenerates a development non-minified and sourcemaps enableddist/callstats-sipjs.jsbundle.
Authors
Karthik BR (https://callstats.io), Dan Jenkins at Nimble Ape Ltd (https://nimblea.pe).