react-native-xsip

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>Home - Documentation</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <input type="checkbox" id="nav-trigger" class="nav-trigger" /> <label for="nav-trigger" class="navicon-button x"> <div class="navicon"></div> </label> <label for="nav-trigger" class="overlay"></label> <nav> <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading">C<a href="module.exports.html">exports</a></li><li class="nav-heading">Events</li><li class="nav-heading">E<a href="Endpoint.html#event:call_changed">call_changed</a></li><li class="nav-heading">E<a href="Endpoint.html#event:call_received">call_received</a></li><li class="nav-heading">E<a href="Endpoint.html#event:call_screen_locked">call_screen_locked</a></li><li class="nav-heading">E<a href="Endpoint.html#event:call_terminated">call_terminated</a></li><li class="nav-heading">E<a href="Endpoint.html#event:connectivity_changed">connectivity_changed</a></li><li class="nav-heading">E<a href="Endpoint.html#event:message_received">message_received</a></li><li class="nav-heading">E<a href="Endpoint.html#event:registration_changed">registration_changed</a></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item">F<a href="global.html#_formatTime">_formatTime</a></li><li class="nav-item">F<a href="global.html#_normalize">_normalize</a></li><li class="nav-item">F<a href="global.html#_onCallChanged">_onCallChanged</a></li><li class="nav-item">F<a href="global.html#_onCallReceived">_onCallReceived</a></li><li class="nav-item">F<a href="global.html#_onCallScreenLocked">_onCallScreenLocked</a></li><li class="nav-item">F<a href="global.html#_onCallTerminated">_onCallTerminated</a></li><li class="nav-item">F<a href="global.html#_onConnectivityChanged">_onConnectivityChanged</a></li><li class="nav-item">F<a href="global.html#_onMessageReceived">_onMessageReceived</a></li><li class="nav-item">F<a href="global.html#_onRegistrationChanged">_onRegistrationChanged</a></li><li class="nav-item">F<a href="global.html#answerCall">answerCall</a></li><li class="nav-item">F<a href="global.html#changeNetworkConfiguration">changeNetworkConfiguration</a></li><li class="nav-item">F<a href="global.html#changeServiceConfiguration">changeServiceConfiguration</a></li><li class="nav-item">F<a href="global.html#createAccount">createAccount</a></li><li class="nav-item">F<a href="global.html#declineCall">declineCall</a></li><li class="nav-item">F<a href="global.html#deleteAccount">deleteAccount</a></li><li class="nav-item">F<a href="global.html#dtmfCall">dtmfCall</a></li><li class="nav-item">F<a href="global.html#getAccountId">getAccountId</a></li><li class="nav-item">F<a href="global.html#getAudioCount">getAudioCount</a></li><li class="nav-item">F<a href="global.html#getBody">getBody</a></li><li class="nav-item">F<a href="global.html#getCallId">getCallId</a></li><li class="nav-item">F<a href="global.html#getConnectDuration">getConnectDuration</a></li><li class="nav-item">F<a href="global.html#getContactParams">getContactParams</a></li><li class="nav-item">F<a href="global.html#getContactUri">getContactUri</a></li><li class="nav-item">F<a href="global.html#getContactUriParams">getContactUriParams</a></li><li class="nav-item">F<a href="global.html#getContentType">getContentType</a></li><li class="nav-item">F<a href="global.html#getDomain">getDomain</a></li><li class="nav-item">F<a href="global.html#getFormattedConnectDuration">getFormattedConnectDuration</a></li><li class="nav-item">F<a href="global.html#getFormattedTotalDuration">getFormattedTotalDuration</a></li><li class="nav-item">F<a href="global.html#getFromName">getFromName</a></li><li class="nav-item">F<a href="global.html#getFromNumber">getFromNumber</a></li><li class="nav-item">F<a href="global.html#getFromUri">getFromUri</a></li><li class="nav-item">F<a href="global.html#getId">getId</a></li><li class="nav-item">F<a href="global.html#getLastReason">getLastReason</a></li><li class="nav-item">F<a href="global.html#getLastStatusCode">getLastStatusCode</a></li><li class="nav-item">F<a href="global.html#getLocalContact">getLocalContact</a></li><li class="nav-item">F<a href="global.html#getLocalUri">getLocalUri</a></li><li class="nav-item">F<a href="global.html#getName">getName</a></li><li class="nav-item">F<a href="global.html#getPassword">getPassword</a></li><li class="nav-item">F<a href="global.html#getProxy">getProxy</a></li><li class="nav-item">F<a href="global.html#getReason">getReason</a></li><li class="nav-item">F<a href="global.html#getRegContactParams">getRegContactParams</a></li><li class="nav-item">F<a href="global.html#getRegHeaders">getRegHeaders</a></li><li class="nav-item">F<a href="global.html#getRegistration">getRegistration</a></li><li class="nav-item">F<a href="global.html#getRegServer">getRegServer</a></li><li class="nav-item">F<a href="global.html#getRegTimeout">getRegTimeout</a></li><li class="nav-item">F<a href="global.html#getRemoteAudioCount">getRemoteAudioCount</a></li><li class="nav-item">F<a href="global.html#getRemoteContact">getRemoteContact</a></li><li class="nav-item">F<a href="global.html#getRemoteFormattedNumber">getRemoteFormattedNumber</a></li><li class="nav-item">F<a href="global.html#getRemoteName">getRemoteName</a></li><li class="nav-item">F<a href="global.html#getRemoteNumber">getRemoteNumber</a></li><li class="nav-item">F<a href="global.html#getRemoteOfferer">getRemoteOfferer</a></li><li class="nav-item">F<a href="global.html#getRemoteUri">getRemoteUri</a></li><li class="nav-item">F<a href="global.html#getRemoteVideoCount">getRemoteVideoCount</a></li><li class="nav-item">F<a href="global.html#getState">getState</a></li><li class="nav-item">F<a href="global.html#getStateText">getStateText</a></li><li class="nav-item">F<a href="global.html#getStatus">getStatus</a></li><li class="nav-item">F<a href="global.html#getStatusText">getStatusText</a></li><li class="nav-item">F<a href="global.html#getTotalDuration">getTotalDuration</a></li><li class="nav-item">F<a href="global.html#getToUri">getToUri</a></li><li class="nav-item">F<a href="global.html#getTransport">getTransport</a></li><li class="nav-item">F<a href="global.html#getURI">getURI</a></li><li class="nav-item">F<a href="global.html#getUsername">getUsername</a></li><li class="nav-item">F<a href="global.html#getVideoCount">getVideoCount</a></li><li class="nav-item">F<a href="global.html#hangupCall">hangupCall</a></li><li class="nav-item">F<a href="global.html#holdCall">holdCall</a></li><li class="nav-item">F<a href="global.html#isActive">isActive</a></li><li class="nav-item">F<a href="global.html#makeCall">makeCall</a></li><li class="nav-item">F<a href="global.html#muteCall">muteCall</a></li><li class="nav-item">F<a href="global.html#redirectCall">redirectCall</a></li><li class="nav-item">F<a href="global.html#registerAccount">registerAccount</a></li><li class="nav-item">F<a href="global.html#start">start</a></li><li class="nav-item">F<a href="global.html#unholdCall">unholdCall</a></li><li class="nav-item">F<a href="global.html#unMuteCall">unMuteCall</a></li><li class="nav-item">F<a href="global.html#useEarpiece">useEarpiece</a></li><li class="nav-item">F<a href="global.html#useSpeaker">useSpeaker</a></li><li class="nav-item">F<a href="global.html#xferCall">xferCall</a></li><li class="nav-item">F<a href="global.html#xferReplacesCall">xferReplacesCall</a></li> </nav> <div id="main"> <section class="readme"> <article><h1>react-native-pjsip</h1>A <a href="http://www.pjsip.org/">PJSIP</a> module for React Native. <h2>Support</h2><ul> <li>Currently support for iOS and Android. </li> <li>Support video and audio communication.</li> <li>Ability to use Callkit and PushNotifications.</li> <li>You can use it to build an iOS/Android app that can communicate with SIP server.</li> <li>Android version is based on <a href="https://github.com/datso/react-native-pjsip-builder">react-native-pjsip-builder</a></li> <li>iOS version is based on <a href="https://github.com/VoIPGRID/Vialer-pjsip-iOS">Vialer-pjsip-iOS</a></li> </ul> <h2>Installation</h2><ul> <li><a href="https://github.com/datso/react-native-pjsip/blob/master/docs/installation_ios.md">iOS</a></li> <li><a href="https://github.com/datso/react-native-pjsip/blob/master/docs/installation_android.md">Android</a></li> </ul> <h2>Usage</h2>First of all you have to initialize module to be able to work with it. There are some interesting moment in initialization. When application goes to background, PJSIP module is still working and able to receive calls, but your javascipt is totally suspended. When User open your application, javascript start to work and now your js application need to know what status have your account or may be you have pending incoming call. So thats why first step should call start method for pjsip module. <pre class="prettyprint source lang-javascript"><code>import {Endpoint} from 'react-native-pjsip' let endpoint = new Endpoint(); let state = await endpoint.start(); // List of available accounts and calls when RN context is started, could not be empty because Background service is working on Android let {accounts, calls, settings, connectivity} = state; // Subscribe to endpoint events endpoint.on("registration_changed", (account) => {}); endpoint.on("connectivity_changed", (online) => {}); endpoint.on("call_received", (call) => {}); endpoint.on("call_changed", (call) => {}); endpoint.on("call_terminated", (call) => {}); endpoint.on("call_screen_locked", (call) => {}); // Android only</code></pre>Account creating is pretty strainghforward. <pre class="prettyprint source lang-javascript"><code>let configuration = { "name": "John", "username": "sip_username", "domain": "pbx.carusto.com", "password": "****", "proxy": null, "transport": null, // Default TCP "regServer": null, // Default wildcard "regTimeout": null // Default 3600 "regHeaders": { "X-Custom-Header": "Value" }, "regContactParams": ";unique-device-token-id=XXXXXXXXX" }; endpoint.createAccount().then((account) => { console.log("Account created", account); }); </code></pre>To be able to make a call first of all you should createAccount, and pass account instance into Endpoint.makeCall function. This function will return a promise that will be resolved when PjSIP initializes the call. <pre class="prettyprint source lang-javascript"><code>let options = { headers: { "P-Assserted-Identity": "Header example", "X-UA": "React native" } } let call = await endpoint.makeCall(account, destination, options); call.getId() // Use this id to detect changes and make actions endpoint.addListener("call_changed", (newCall) => { if (call.getId() === newCall.getId()) { // Our call changed, do smth. } } endpoint.addListener("call_terminated", (newCall) => { if (call.getId() === newCall.getId()) { // Our call terminated } }</code></pre><h2>API</h2><ol> <li><a href="https://github.com/datso/react-native-pjsip/blob/master/docs/startup.md">Startup</a></li> <li><a href="https://github.com/datso/react-native-pjsip/blob/master/docs/accounts.md">Accounts</a></li> <li><a href="https://github.com/datso/react-native-pjsip/blob/master/docs/calls.md">Calls</a></li> <li><a href="https://github.com/datso/react-native-pjsip/blob/master/docs/settings.md">Settings</a></li> </ol> <h2>Demo</h2>The demo project is https://github.com/datso/react-native-pjsip-app. And you will need a SIP server.</article> </section> </div> <footer> Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Sep 27 2018 10:20:55 GMT+0300 (EEST) using the Minami theme. </footer> <script>prettyPrint();</script> <script src="scripts/linenumber.js"></script> </body> </html>