WebPhone
<!-- If the browser does not support frames put the first topic content here --> <div class="WordSection1"> <div style='border-top:solid #C0504D 6.0pt;border-left:none;border-bottom:solid #C0504D 6.0pt; border-right:none;padding:0in 0in 0in 0in;background:#C0504D'> <p class="MsoTitle"><span lang="HU"> </span>Mizu WebPhone</p> <p class="MsoTitle"><span style='font-size:12.0pt'>v.3.0. March 3, 2020</span></p> </div> <p class="MsoNormal"> </p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <p class="MsoTocHeading"><span style='font-size:10.0pt;line-height:112%'>Contents</span></p> </div> <p class="MsoToc1"><a href="start.htm#_Toc499665496"><span style='font-size:9.0pt;line-height:120%'>About</span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'> </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>2</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc499665497"><span style='font-size:9.0pt; line-height:120%'>Usage</span><span style='font-size:9.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>2</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665498"><span style='font-size:9.0pt; line-height:120%'>Steps</span><span style='font-size:9.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>2</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665499"><span style='font-size:9.0pt; line-height:120%'>Web Softphone</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>4</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665500"><span style='font-size:9.0pt; line-height:120%'>Click-to-call</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'> </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>4</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665501"><span style='font-size:9.0pt; line-height:120%'>Developers</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>4</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665502"><span style='font-size:9.0pt; line-height:120%'>Designers</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>4</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc499665503"><span style='font-size:9.0pt; line-height:120%'>Features, technology and licensing</span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>5</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665504"><span style='font-size:9.0pt; line-height:120%'>Feature list</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'> </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>5</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665505"><span style='font-size:9.0pt; line-height:120%'>Requirements</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>5</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665506"><span style='font-size:9.0pt; line-height:120%'>Technical details</span><span style='font-size:9.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>6</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665507"><span style='font-size:9.0pt; line-height:120%'>Licensing</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>8</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc499665508"><span style='font-size:9.0pt; line-height:120%'>Integration and customization</span><span style='font-size: 9.0pt;line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>9</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665509"><span style='font-size:9.0pt; line-height:120%'>Concepts</span><span style='font-size:9.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>9</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665510"><span style='font-size:9.0pt; line-height:120%'>User interface Skin/Design</span><span style='font-size:9.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>10</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665511"><span style='font-size:9.0pt; line-height:120%'>Web Dialer/Softphone</span><span style='font-size:9.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>11</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665512"><span style='font-size:9.0pt; line-height:120%'>Click to call</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'> </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>17</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665513"><span style='font-size:9.0pt; line-height:120%'>Custom solutions</span><span style='font-size:9.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>20</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665514"><span style='font-size:9.0pt; line-height:120%'>Integration with Web server side applications or scripts</span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>21</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665515"><span style='font-size:9.0pt; line-height:120%'>Integration with SIP server side applications or scripts</span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>23</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665516"><span style='font-size:9.0pt; line-height:120%'>Development</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'> </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>23</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc499665517"><span style='font-size:9.0pt; line-height:120%'>Parameters</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>26</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665518"><span style='font-size:9.0pt; line-height:120%'>SIP account settings</span><span style='font-size:9.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>28</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665519"><span style='font-size:9.0pt; line-height:120%'>Engine related settings</span><span style='font-size:9.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>31</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665520"><span style='font-size:9.0pt; line-height:120%'>Call divert and other settings</span><span style='font-size: 9.0pt;line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>49</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665521"><span style='font-size:9.0pt; line-height:120%'>User interface related settings</span><span style='font-size: 9.0pt;line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>57</span></a></p> <p class="MsoToc3"><a href="start.htm#_Toc499665522"><span style='font-size:9.0pt; line-height:120%'>Parameter security</span><span style='font-size:9.0pt; line-height:120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>64</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc499665523"><span style='font-size:9.0pt; line-height:120%'>JavaScript API</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'> </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>65</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc499665524"><span style='font-size:9.0pt; line-height:120%'>About</span><span style='font-size:9.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'> </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>65</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc499665525"><span style='font-size:9.0pt; line-height:120%'>Basic example</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>65</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc499665526"><span style='font-size:9.0pt; line-height:120%'>Functions</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>66</span></a></p> <p class="MsoToc2"><a href="start.htm#_Toc499665585"><span style='font-size:9.0pt; line-height:120%'>Events</span><span style='font-size:9.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>77</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc499665600"><span style='font-size:9.0pt; line-height:120%'>FAQ</span><span style='font-size:9.0pt;line-height:120%; color:windowtext;display:none;text-decoration:none'>.. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>86</span></a></p> <p class="MsoToc1"><a href="start.htm#_Toc499665687"><span style='font-size:9.0pt; line-height:120%'>Resources</span><span style='font-size:9.0pt;line-height: 120%;color:windowtext;display:none;text-decoration:none'>. </span><span style='font-size:9.0pt;line-height:120%;color:windowtext;display:none; text-decoration:none'>140</span></a></p> <p class="MsoNormal"> </p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1 style='background:#F2DBDB'><a name="_Toc499665496">About</a> </h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The Mizu WebPhone is a universal SIP client to provide VoIP capability for <b>all browsers</b> using a variety of technologies compatible with most OS/browsers. Since it is based on the open standard </span><a href="https://en.wikipedia.org/wiki/Session_Initiation_Protocol"><span style='font-style:normal'>SIP</span></a><span style='font-style:normal'> and </span><a href="https://en.wikipedia.org/wiki/Real-time_Transport_Protocol"><span style='font-style:normal'>RTP</span></a><span style='font-style:normal'> protocols, it can inter-operate with any other SIP-based network, allowing people to make true VoIP calls directly from their browsers. Compatible with all SIP softphones (X-Lite, Bria, Jitsi others), devices (gateways, ATA’s, IP Phones, others), proxies (SER, OpenSIPS, others), PBX (</span><a href="start.htm#_How_to_setup"><span style='font-style:normal'>Asterisk</span></a><span style='font-style:normal'>, FreeSWITCH, FreePBX, Elastix, Avaya, FusionPBX, 3CX, Broadsoft, Alcatel, NEC, others), VoIP servers (Mizu, Voipswitch, Cisco, Huawei, Kamailio, others), service providers (Vonage and others) and any SIP capable endpoint (UAC, UAS, proxy, others).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The Mizu WebPhone is truly <b>cross-platform</b>, running from both desktop and mobile browsers, offering the best browser to SIP phone functionality in all circumstances, using a variety of built-in technologies referred as “</span><a href="start.htm#_Engines"><span style='font-style:normal'>engines</span></a><span style='font-style:normal'>”:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>NS (Native Service/Plugin)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>WebRTC</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Java applet</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Flash</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>App</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>P2P/Callback</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Native Dial</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The engine to use is automatically selected by default based on OS, browser and server availability (It can be also set manually from the configuration or priorities can be changed). This </span><a href="start.htm#_Features,_technology_and"><span style='font-style:normal'>multi-engine</span></a><span style='font-style:normal'> capability has considerable </span><a href="start.htm#_What_are_the"><span style='font-style:normal'>benefits</span></a><span style='font-style:normal'> over other naive implementations.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone can be used with the provided user interface (as a ready to use <b>softphone</b> or <b>click to call</b> button) or as a <b>JavaScript library</b> via its API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The provided user interfaces are implemented as simple HTML/CSS and can be fully </span><a href="start.htm#_Integration_and_customization"><span style='font-style:normal'>customized</span></a><span style='font-style:normal'>, modified, extended or removed/replaced.</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1 style='background:#F2DBDB'><a name="_Toc499665497"></a><a name="_Usage"></a>Usage </h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone is an all-in-one VoIP client module which can be used as-is (as a ready to use softphone or click to call) or as a JavaScript library (to implement any custom VoIP client or add VoIP call capabilities to existing applications). You can create custom VoIP solutions from scratch with some JavaScript knowledge or use it as a turn-key solution if you don’t have any programming skills as the webphone is highly customizable by just changing its numerous settings.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665498"></a><a name="_Steps"></a><span style='font-size:12.0pt'>Setu</span><span style='font-size:12.0pt'>p</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6 style='text-indent:.5in'><a name="node0" id="node0"></a><span style='font-size:12.0pt'>In short:</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>Download the webphone.zip</span></a><span style='font-style:normal'> and extract it to your web server (or test it from your local file system by just launching it from your desktop for example).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Open the webphone_config.js file and </span><a href="start.htm#_How_to_configure"><span style='font-style:normal'>configure</span></a><span style='font-style:normal'> at least the </span><a href="start.htm#_serveraddress"><span style='font-style:normal'>serveraddress</span></a><span style='font-style:normal'> parameter. <br> Launch any of the example html included with the webphone, for example the index.html as from there you can access most examples.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enter your SIP username/password (if you haven’t preconfigured it in the webphone_config.js) and call any account/extension/phone number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>A quick tutorial can be found </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=WebPhone+Quick+Start"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>. and/or you might follow the below step by step detailed instructions:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="node1" id="node1"></a><span style='font-size:12.0pt'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Download </span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The package can be downloaded from here: </span><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>webphone download</span></a><span style='font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It includes everything you need for a browser to SIP solution: the engines, the JavaScript API, the skins and also a few usage examples.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This public downloadable version has some </span><a href="start.htm#_Demo_version"><span style='font-style:normal'>demo limitations</span></a><span style='font-style:normal'>, but you can use it for any tests or integration work before to purchase your license.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you already have a </span><a href="start.htm#_How_to_get_1"><span style='font-style:normal'>webphone license</span></a><span style='font-style:normal'>, then use the webphone package sent to you by Mizutech instead of the above link.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="_Deploy"></a><span style='font-size:12.0pt'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Deploy</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can find the requirements </span><a href="start.htm#_Requirements"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> which need to be fulfilled to be able to use the webphone.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There is no any web server related requirements. You can host the webphone on any </span><a href="start.htm#_Web_server_requirements"><span style='font-style:normal'>web server</span></a><span style='font-style:normal'> the exact same way as you host a static page or a png images.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Unzip and copy the webphone </span><a href="start.htm#_Folders_and_file"><span style='font-style:normal'>folder</span></a><span style='font-style:normal'> into your webserver and refer it from your html (for example from your main page) or open one of the included html in your browsers by specifying its exact URL. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example: </span><a href="http://192.168.1.44/webphone/samples/techdemo_example.html"><span style='font-style:normal'>http://192.168.1.44/webphone/samples/techdemo_example.html</span></a><span class="MsoHyperlink"><span style='color:windowtext;font-style:normal;text-decoration: none'> or </span></span><a href="https://yourdomain.com/webphone/softphone.html"><span style='font-style: normal'>https://yourdomain.com/webphone/softphone.html</span></a><span style='font-style:normal'> .</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='color:blue;font-style:normal'><br> </span></u><span style='font-style:normal'>Notes:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>You might have to enable the .jar, .exe, .zip, .swf, .dll, .so, .pkg, .dmg and .dylib </span><a href="start.htm#_Web_server_requirements"><span style='font-size:9.0pt'>mime types</span></a><span style='font-size:9.0pt'> in your webserver if not enabled by default (these files might be used in some circumstances depending on the client OS/browser).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If you wish to use (also) the WebRTC engine then your site should be secured (HTTPS with a valid SSL certificate). Modern browsers requires secure connection for both your website (HTTPS) and websocket (WSS). If your website doesn’t have an SSL certificate then </span><a href="mailto:webphone@mizu-voip.com?subject=webphone%20hosting"><span style='font-size:9.0pt'>we can</span></a><span style='font-size:9.0pt'> host the webphone for you for free or you can install a </span><a href="https://www.namecheap.com/"><span style='font-size:9.0pt'>cheap</span></a><span style='font-size:9.0pt'> or </span><a href="https://www.startssl.com/"><span style='font-size:9.0pt'>free</span></a><span style='font-size:9.0pt'> </span><a href="https://letsencrypt.org/"><span style='font-size:9.0pt'>certificate</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Alternatives:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>You can also test it without a webserver by launching the html files from your desktop (</span><a href="start.htm#_Test_environment_limitations"><span style='font-size:9.0pt'>launch from local file system</span></a><span style='font-size:9.0pt'>)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: "Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>You can also test it by using the </span><a href="https://www.mizu-voip.com/Software/WebPhone/WebphoneOnlineDemo.aspx"><span style='font-size:9.0pt'>online demo</span></a><span style='font-size:9.0pt'> hosted by Mizutech website, but in this case you will not be able to change the configuration (you can still set any parameters from the user interface or from </span><a href="start.htm#_How_to_use"><span style='font-size:9.0pt'>URL</span></a><span style='font-size:9.0pt'>)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="node2" id="node2"></a><span style='font-size:12.0pt'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Settings</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone has a long list of </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> which you can </span><a href="start.htm#_How_to_configure"><span style='font-style:normal'>set</span></a><span style='font-style:normal'> to customize it after your needs.<br> You can </span><a href="start.htm#_How_to_configure"><span style='font-style:normal'>set these parameters</span></a><span style='font-style:normal'> multiple ways (in the webphone_config.js file, </span><a href="start.htm#_How_to_use"><span style='font-style:normal'>pass by URL</span></a><span style='font-style:normal'> parameter or via the </span><a href="start.htm#_setparameter_(param,_value)"><span style='font-style:normal'>setparameter()</span></a><span style='font-style: normal'> API).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you are using the webphone with a SIP server (not peer to peer) then you must set at least the “</span><a href="start.htm#_serveraddress"><span style='font-style:normal'>serveraddress</span></a><span style='font-style:normal'>” parameter. For more details read </span><a href="start.htm#_Web_phone_setup_1"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The easiest way to start is to just enter the required parameters (serveraddress, username, password and any other you might wish) in the webphone_config.js file.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="node3" id="node3"></a><span style='font-size:12.0pt'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Integrate</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone can be used as a turn-key ready to use solution (just refer to it from your HTML) or as a Java-Script library to develop custom software. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There are multiple ways to use it: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use one of the supplied templates (the “softphone” or the “click to call”) and customize it after your needs. You can place one of them as an </span><a href="start.htm#_Load_the_webphone_1"><span style='font-style:normal'>iframe</span></a><span style='font-style:normal'> or div to your website </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Integration_and_customization"><span style='font-style: normal'>Integrate</span></a><span style='font-style:normal'> the webphone with your webpage, website or web application</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Integration_with_server"><span style='font-style:normal'>Integrate</span></a><span style='font-style:normal'> the webphone with your server side application (if you are a server side developer)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Create your </span><a href="start.htm#_Development"><span style='font-style:normal'>custom</span></a><span style='font-style:normal'> solution by using the webphone as a JavaScript library (if you are a JavaScript developer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="node4" id="node4"></a><span style='font-size:12.0pt'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Design</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you are a designer then you might create your own </span><a href="start.htm#_User_interface_Skin/Design_1"><span style='font-style:normal'>design</span></a><span style='font-style:normal'> or modify the existing HTML/CSS. For simple design changes you don’t need to be a designer. Colors, branding, logo and others can be specified by the settings for the supplied “softphone” and “click to call” skins. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Mizutech can also supply a ready to use pre-customized build of the softphone skin with your settings and branding for no extra cost (</span><a href="mailto:webphone@mizu-voip.com?subject=Customized/branded%20webphone"><span style='font-style:normal'>ask for it</span></a><span style='font-style:normal'>).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Please note that the webphone also works without any GUI.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="_Launch"></a><span style='font-size:12.0pt'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Launch</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Launch one of the examples (the html files in the webphone folder) or your own html (from desktop by double clicking on it or from browser by entering the URL). You might launch the “index.html” to see the included templates.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>At first start the webphone might offer to enable or download a native plugin if no other suitable engine are supported and enabled by default in your browser.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>It will also ask for a SIP username/password if you use the default GUI and these are not preset.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>On init, the webphone will register (connect) to your VoIP server (this can be disabled if not needed by setting the register parameter to 0).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Then you should be able to make calls to other UA (any webphone or SIP endpoint such as X-Lite or other softphone) or to pstn numbers (mobile/landline) if outbound call service is enabled by your server or VoIP provider. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Examples and ready to use solutions (found in the webphone folder):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>index</span></b><span style='font-style:normal'>.html: just an index page with direct links to the below examples for your convenience</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>minimal_example</span></b><span style='font-style:normal'>.html: shortest example capable to make a call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>basic_example</span></b><span style='font-style:normal'>.html: a basic usage example</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>techdemo_example</span></b><span style='font-style:normal'>.html: a simple tech demo. You might make any tests by using this html or change/extend it to fit your needs</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>softphone</span></b><span style='font-style:normal'>.html: a full featured, ready to use </span><a href="start.htm#_Softphone/Dialer"><span style='font-style:normal'>browser softphone</span></a><span style='font-style:normal'>. You can use it as is on your website as a web dialer. For example you can include it in an iframe or div on your website. Change the parameters in the webphone_config.js). You can further customize it by changing the parameters or changing its design.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>softphone_launch</span></b><span style='font-style:normal'>.html: a simple launcher for the above to look better when launched directly (since the softphone.html is used usually in a DIV or iFrame)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>click2call</span></b><span style='font-style:normal'>.html: a ready to use browser to SIP </span><a href="start.htm#_Use_the_Click2Call"><span style='font-style:normal'>click to call solution</span></a><span style='font-style:normal'>. You might further customize after your needs</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>custom</span></b><span style='font-style:normal'>: you can easily create any </span><a href="start.htm#_Custom_solutions"><span style='font-style:normal'>custom</span></a><span style='font-style:normal'> browser VoIP solution by using the webphone java script library</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Folders_and_file"><span style='font-style:normal'>Webphone file list</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Integration_and_customization"><span style='font-style: normal'>Customization</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=WebPhone+-How+It+Works%3f"><span style='font-style:normal'>How it works?</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=WebPhone+Quick+Start"><span style='font-style:normal'>Quick webphone tutorial</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665499"></a><a name="_Web_Softphone"></a><span style='font-size:12.0pt'>Web Softphone</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone package contains a ready to use </span><a href="start.htm#_Softphone/Dialer"><span style='font-style:normal'>web softphone</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Just copy the webphone folder to your webserver and change the “serveraddress” setting in the in webphone_config.js file to your SIP server IP or domain to have a fully featured softphone presented on your website. You can just simply include (refer to) the softphone.html via an </span><a href="start.htm#_Load_the_webphone_1"><span style='font-style:normal'>iframe</span></a><span style='font-style:normal'> (this way you can even preset the webphone parameters in the iframe URL) div or </span><a href="start.htm#_Load_the_webphone"><span style='font-style:normal'>on demand</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: you might have to enable the following mime types in your web server if not enabled by default: .jar, .swf, .dll, .dylib, .so, .pkg, .dmg, .exe</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The web softphone can be configured via URL parameters or in the "</span><span style='font-size:11.0pt'> </span><span style='font-style:normal'>webphone_config.js" file, which can be found in the root directory of the package. The most important configuration is the “serveraddress” parameter which should be set to your SIP server IP address or domain name. More details about the parameters can be found below in this documentation in the “</span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>Parameters</span></a><span style='font-style:normal'>” section.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We can also send you a build with all your branding and settings pre-set: </span><a href="mailto:webphone@mizu-voip.com?subject=Custom%20web%20softphone%20request"><span style='font-style:normal'>contact us</span></a><span style='font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check </span><a href="start.htm#_Softphone/Dialer"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> for more options.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665500"><span style='font-size: 12.0pt'>Click-to-call</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone package contains a ready to use click to call solution. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Just copy the whole webphone folder to your website, set the parameters in the webphone_config.js file and use it from the click2call.html.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Rewrite or modify after your needs with your custom button image or you can just use it via a simple URI or link such as:</span></p> <p class="MsoNoSpacing"><a href="http://www.yourwebsite.com/webphonedir/click2call.html?wp_serveraddress=YOURSIPDOMAIN&wp_username=USERNAME&wp_password=PASSWORD&wp_callto=CALLEDNUMBER&wp_autoaction=1"><span style='font-style:normal'>http://www.yourwebsite.com/webphonedir/click2call.html?wp_serveraddress=YOURSIPDOMAIN&wp_username=USERNAME&wp_password=PASSWORD&wp_callto=CALLEDNUMBER&wp_autoaction=1</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can find more details and customization options in the </span><a href="start.htm#_Click_to_call_1"><span style='font-style:normal'>click to call</span></a><span style='font-style:normal'> section.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665501"></a><a name="_Developers"></a><span style='font-size:12.0pt'>Developers</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Developers can use the webphone as a </span><span style='font-style:normal'>JavaScript </span><span style='font-style:normal'>library to create any </span><a href="start.htm#_Custom_solutions"><span style='font-style:normal'>custom</span></a><span style='font-style:normal'> VoIP solution integrated in any webpage or web application.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Just include the </span><span style='font-style:normal'>"</span><span style='font-size:11.0pt'> </span><span style='font-style:normal'>webphone_config.js" to your project or html and start using the </span><a href="start.htm#_Designers"><span style='font-style:normal'>webphone API</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="start.htm#_Development"><span style='font-style:normal'>development</span></a><span style='font-style:normal'> section for the details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: You can adjust the webphone behavior also without any development knowledge by just </span><a href="start.htm#_How_to_configure"><span style='font-style:normal'>modifying</span></a><span style='font-style:normal'> its </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>settings</span></a><span style='font-style:normal'> described in “parameters” section.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665502"></a><a name="_Designers"></a><span style='font-size:12.0pt'>Designers</span></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>If you are a designer, you can modify all the included HTML/CSS/images or create your own design from scratch using any technology that can bind to JS such as HML5/CSS, Flash or others.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For simple design changes you don’t need to be a designer. Colors, branding, logo and others can be set by the settings.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the “</span><a href="start.htm#_User_interface_Skin/Design_1"><span style='font-style:normal'>User Interface Skin/Design</span></a><span style='font-style:normal'>” section for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: If you are using the built-in softphone or click2call skins, then you can adjust them also without any designer knowledge by just setting/modifying the </span><a href="start.htm#_User_interface_related"><span style='font-style:normal'>user interface related settings</span></a><span style='font-style:normal'> in the webphone_config.js file.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc499665503"></a><a name="_Features,_technology_and"></a><span style='font-size:12.0pt;line-height:112%'>Features, technology and licensing</span></h1> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The WebPhone is a cross-platform SIP client running entirely in clients browsers compatible with all browsers and all SIP servers, IP-PBX or softswitch. The webphone is completely self-hosted without any cloud dependencies, completely owned and controlled by you (just copy the files to your Web server).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665504"><span style='font-size: 12.0pt'>Feature list</span></a></h3> </div> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Standard SIP voice calls (in/out), video, chat, conference and others (Session Initiation Protocol)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Maximum browsers </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=Webphone+engine+support+grid"><span style='font-style:normal'>compatibility</span></a><span style='font-style:normal'>. Runs in all browsers with Java, WebRTC or native plugin support (WebView, Chrome, Firefox, IE, Edge, Safari, Opera)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Includes several different technologies to make phone calls (engines): Java applet, WebRTC, NS (Native Service or Plugin), Flash, App, Native and server assisted conference rooms, calls through IVR, P2P and callback</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>SIP and RTP stack compatible with all standard VoIP servers and devices like Cisco, Voipswitch, Asterisk, softphones, ATA, IP phones and others</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Transport protocols: UDP, TCP, HTTP, RTMP, websocket (uses UDP for media whenever possible)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Encryption: SIPS, TLS, DTLS, SRTP and end to end encryption for webphone to webphone calls even if TLS/DTLS/SRTP is not supported</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>NAT/Firewall support: auto detect transport method (UDP/TCP/HTTP), stable SIP and RTP ports, keep-alive, rport support, proxy traversal, auto tunneling when necessary, ICE/STUN/TURN protocols and auto configuration, firewall traversal for corporate networks, VoIP over HTTP/TCP when firewalls blocks the UDP ports with full support for ICE TCP candidates</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Works over the internet and also on local LAN’s (perfectly fine to be used with your own internal company PBX)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>RFC’s: 2543, 3261, 7118, 2976, 3892, 2778, 2779, 3428, 3265, 3515, 3311, 3911, 3581, 3842, 1889, 2327, 3550, 3960, 4028, 3824, 3966, 2663, 6544, 5245 and others</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Supported methods: REGISTER, INVITE, re-INVITE, ACK,PRACK, BYE, CANCEL, UPDATE, MESSAGE, INFO, OPTIONS, SUBSCRIBE, NOTIFY, REFER</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Audio Codec: PCMU, PCMA, G.729, GSM, iLBC, SPEEX, OPUS (including wide-band HD audio)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Video codec: H.263, H.264 and VP8 for WebRTC only</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>SIP compatible codec auto negotiation and adjustment (for example OPUS – G.711, G.729 - wideband or RTC G.711 to G.729 transcoding if needed)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Video calls and Screen-sharing (for WebRTC enabled browsers)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call divert: rewrite, redial, mute, hold, transfer, forward, conference and other PBX features</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call park and pickup, barge-in (with NS)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Voice call recording</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>IM/Chat (RFC 3428), SMS, file transfer, DTMF, voicemail (MWI)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Multi-line support</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Multi account support</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Contacts: management, synchronization, flags, favorites, block, auto prioritization</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Presence (DND/online/offline/others) via standard SIP PUBLISH/SUBSCIBE/NOTIFY</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>BLF (Busy Lamp Field)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Balance display, call timer, inbound/outbound calls, caller-id display</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>High level JavaScript API: web developers can easily build any custom VoIP functionality using the webphone as a JS library</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Stable API: new releases are always backward compatible so you can always upgrade to new versions with no changes in your code</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Integration with any website or application including simple static pages, apps with client side code only (like a simple static page) or any server side stack such as PHP, .NET, java servlet, J2EE, Node.js and others (sign-up, CRM, callcenter, payments and others)</span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Phone API accessible from any JavaScript framework (such as AngularJS, React, jQuery and others) or from plain/vanilla JS or not use the JS API at all</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Branding and customization: customizable user interface with your own brand, skins and languages (with ready to use, modifiable themes)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Flexibility: all parameters/behavior can be changed/controlled by URL parameters, preconfigured parameters, from javascript or from server side</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The webphone is in continuous development with multiple new releases every year.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Only the major releases are published on the <a href="https://www.mizu-voip.com/Software/WebPhone.aspx">software homepage</a> as a <a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip">demo</a> (usually once per year), but new customers always receive the latest stable release.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>All versions are fully backward/forward compatible, thus upgrades doesn’t require any change in existing configurations and code.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>For the major new versions you can find the change list <a href="https://www.mizu-voip.com/Software/WebPhone/WebPhoneVersionHistory.aspx">here</a>. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665505"></a><a name="_Requirements"></a><span style='font-size:12.0pt'>Requirements</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Server side:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Any </span><a href="start.htm#_Web_server_requirements"><span style='font-style:normal'>web hosting</span></a><b><span style='font-style:normal'> </span></b><span style='font-style:normal'>for the webphone files (any webserver is fine: IIS, nginx, Apache, NodeJS, Java, others; any OS: Windows, Linux, others). </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-style:normal'>Chrome and Opera requires secure connection for WebRTC engine to work (otherwise this engine will be automatically skipped). We can also host the webphone for free if you wish on secure http. Note that the web phone itself doesn’t require any framework, just host it as static files (no PHP, .NET, JEE, NodeJS or similar server side scripting is required to be supported by your webserver, however you are free to integrate the webphone with any such server side stacks if you need so)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>At least one <b>SIP account</b> at any </span><a href="start.htm#_I_wish_to"><span style='font-style:normal'>VoIP service provider</span></a><span style='font-style:normal'> or your own </span><a href="start.htm#_Is_it_working"><span style='font-style:normal'>SIP server</span></a><span style='font-style:normal'> or IP-PBX (such as Asterisk, Voipswitch, 3CX, FreePBX, Trixbox, Elastix, SER, Cisco and others)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Optional: WebRTC capable SIP server or SIP to WebRTC gateway (Mizutech free WebRTC to SIP service is enabled by default. The webphone can be used and works fine also </span><a href="start.htm#_How_to_handle"><span style='font-style:normal'>without WebRTC</span></a><span style='font-style:normal'>, however if you prefer this technology then </span><a href="https://www.doubango.org/webrtc2sip/"><span style='font-style:normal'>free</span></a><span style='font-style:normal'> software is available and Mizutech also offers </span><a href="https://www.mizu-voip.com/Software/WebRTCtoSIP.aspx"><span style='font-style:normal'>WebRTC to SIP gateway</span></a><span style='font-style:normal'> (free with the Advanced license) and free service tier. Common VoIP servers also has </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=Asterisk+WebRTC"><span style='font-style:normal'>built-in WebRTC</span></a><span style='font-style: normal'> support nowadays)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Client side:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Any <b>browser</b> supporting WebRTC OR Java OR native plugins with JavaScript enabled (most browsers are supported)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Audio device</span></b><span style='font-style:normal'>: headset or microphone/speakers</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Compatibility:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>OS: Windows (XP,Vista,7,8,10) , Linux, MAC OSX, Android, iOS, BlackBerry, Chromium OS and others</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Browsers: Firefox, Chrome, IE (6+), Edge, Safari, Opera and others</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Different OS/browser might have different compatibility level depending on the usable engines. For example the rarely used Flash engine doesn’t implement all the functionalities of the WebRTC/Java/NS engines (these differences are handled automatically by the webphone API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you don't have an IP-PBX or VoIP account yet, you can use or test with our SIP </span><a href="https://www.mizu-voip.com/Services/VoIPServices.aspx"><span style='font-style:normal'>VoIP service</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Server address: voip.mizu-voip.com</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Account: </span><a href="http://voip.mizu-voip.com:8000/"><span style='font-style:normal'>create free VoIP account from here</span></a><span style='font-style:normal'> or use the following username/passwords: webphonetest1/webphonetest1, webphonetest2/webphonetest2 (other people might also use these public accounts so calls might be misrouted)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Some more details can be found </span><a href="start.htm#_What_software/service_do"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665506"><span style='font-size: 12.0pt'>Technical details</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The goal of this project is to implement a VoIP client compatible with all SIP servers, running in all browsers under all OS with the same user interface and API. At this moment no technology exists to implement a VoIP engine to fulfill these requirements due to browser/OS fragmentation. Also different technologies have some benefits over others. We have achieved this goal by implementing different “VoIP engines” targeting each OS/browser segment. This also has the advantage of just barely run a VoIP call, but to offer the best possible quality for all environments (client OS/browser). All these engines are covered by a single, easy to use unified API accessible from JavaScript. To ease the usage, we also created a few different user interfaces in HTML/JS/CSS addressing the most common needs such as a VoIP dialer and a click to call user interface. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details about how it works can be found </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=WebPhone+-How+It+Works%3f"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Each engine has its advantages and disadvantages. The sip webphone will automatically choose the “best” engine based on your preferences, OS/Browser/server side support and the enduser preferences (this can be overridden by settings if you have some special requirements): </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=Webphone+engine+support+grid"><span style='font-style:normal'>VoIP availability in browsers</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 1.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left:4.3pt;margin-right: 0in'> <h4 style='margin-left:0in'><a name="_Toc455069972"></a><a name="_Engines"></a><span style='font-size:12.0pt'>Engines</span></h4> </div> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node5" id="node5"></a><span style='font-size:12.0pt'>NS</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Native VoIP engine implemented as a service or browser plugin. The engine </span><a href="start.htm#_How_to_handle_1"><span style='font-size:9.0pt;font-style:normal'>works</span></a><span style='font-size:9.0pt;font-style:normal'> like a usual SIP client, connecting directly from client PC to your SIP server, but it is fully controlled from web (the client browser will communicate in the background with the native engine installed on the client pc/mobile device, thus using this natively installed sip/media stack for VoIP).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Available for: ALL browsers on Windows, Linux and macOS</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Pros:</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>All features all supported, native performance</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Cons</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Requires install (one click installer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node6" id="node6"></a><span style='font-size:12.0pt'>WebRTC</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>A new technology for media streaming in modern browsers supporting common VoIP features. </span><a href="https://en.wikipedia.org/wiki/WebRTC"><span style='font-size:9.0pt; font-style:normal'>WebRTC</span></a><span style='font-size:9.0pt;font-style: normal'> is a built-in module in modern browsers which can be used to implement VoIP. Signaling goes via websocket (unencrypted or TLS) and media via encrypted UDP (DTLS-SRTP). These are then converted to normal SIP/RTP by the VoIP server or by a gateway.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Available for: all modern browsers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Pros:</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Comfortable usage in browsers with WebRTC support because it is has no dependencies on plugins</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Cons:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>It is a black-box in the browser with a restrictive API</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Lack of popular VoIP codec such as G.729 (this can be solved by CPU intensive server side transcoding)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>A WebRTC to SIP gateway may be </span><a href="start.htm#_How_to_handle"><span style='font-size:9.0pt; font-style:normal'>required</span></a><span style='font-size:9.0pt;font-style: normal'> if your VoIP server don’t have built-in support for WebRTC (there are free software for this and we also provide a free service tier, included by default)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node7" id="node7"></a><span style='font-size:12.0pt'>Flash</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>A browser plugin technology developed by Adobe with its proprietary streaming protocol called </span><a href="https://en.wikipedia.org/wiki/Real_Time_Messaging_Protocol"><span style='font-size:9.0pt;font-style:normal'>RTMP</span></a><span style='font-size:9.0pt;font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Available for: old browsers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Pros:</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>In some old/special browsers only Flash is available as a single option to implement VoIP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Cons:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Requires server side Flash to SIP gateway to convert between flash RTMP and SIP/RTP (we provide free service tier)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Basic feature set</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node8" id="node8"></a><span style='font-size:12.0pt'>Java Applet</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Based on our powerful JVoIP SDK, compatible with all JRE enabled browsers. Using the </span><a href="http://www.oracle.com/technetwork/java/applets-137637.html"><span style='font-size:9.0pt;font-style:normal'>Java Applet</span></a><span style='font-size:9.0pt;font-style:normal'> technology you can make SIP calls from browsers the very same way as a native dialer, connecting directly from client browser to SIP server without any intermediary service (SIP over UDP/TCP and RTP over UDP).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Available for: java enabled browsers such as IE and old Firefox/Chome.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Pros:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>All SIP/media features are supported, all codecs including G.729, wideband and custom extra modules such as call recording</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Works exactly as a native softphone or ip phone connecting directly from the user browser to your SIP capable VoIP server or PBX (but with your user interface)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Cons:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Java is getting deprecated by modern browsers (handled automatically by the webphone by just choosing another available engine)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Some browsers may ask for user permission to activate the Java plugin</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node9" id="node9"></a><span style='font-size:12.0pt'>App</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Some platforms don’t have any suitable technology to enable VoIP in browsers (a minor percentage, most notably old iOS/Safari). In these cases the webphone can offer to the user to install a native </span><a href="https://en.wikipedia.org/wiki/Softphone"><span style='font-size:9.0pt;font-style:normal'>softphone</span></a><span style='font-size:9.0pt;font-style:normal'> application. The apps are capable to fully auto-provision itself based on the settings you provide in your web application so once the user installs the app from the app store, then on first launch it will magically auto-provision itself with most of your settings/branding/customization/user interface as you defined for the webphone itself. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Available for: old browsers with no any built-in or plugin based VoIP support.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Pros:</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>Covering platforms with lack of VoIP support in browsers (most notable old iOS Safari)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Cons:</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>No API support. Not the exactly same HTML user interface (although highly customized based on the settings you provided for the webphone)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_P2P_and_callback"></a><span style='font-size:12.0pt'>P2P and callback</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>These are just “virtual” engines with no real client VoIP stack.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;font-style:normal'>P2P </span><a href="start.htm#_P2P"><span style='font-size:9.0pt;font-style:normal'>means</span></a><span style='font-size:9.0pt;font-style:normal'> server initiated phone to phone call initiated by an API call into your VoIP server. Then the server will first call you (on your regular mobile/landline phone) and once you pick it up it will dial the other number and you can start talking (Just set the “p2p” setting to point to your VoIP server API for this to work)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="http://www.voip-info.org/wiki/view/CallBack"><span style='font-size:9.0pt;font-style:normal'>Callback</span></a><span style='font-size:9.0pt;font-style:normal'> is a method to make cheap international calls triggering a callback from the VoIP server by dialing its callback access number. It might be used only as a secondary engine if you set a callback access number (Just set the “callback” setting to point to your VoIP server API for this to work)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>These are treated as a secondary (failback) engines and used only if no other engines are available just to be able to cover all uncommon/ancient devices with lack of support for all the above engines which is very rare. However it might be possible that these fits into your business offer and in that case you might increase their priority to be used more frequently. Alternatively it might be used also to initiate native call under low quality network conditions.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node10" id="node10"></a><span style='font-size:12.0pt'>Native Dial</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>This means native calls from mobile using your mobile carrier network. This is a secondary “engine” to failback to if no any VoIP capabilities were found on the target platform or there is no network connection. In these circumstances the webphone is capable to simply trigger a phone call from the user smartphone if this option is enabled in the settings. Rarely used if any.</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The most important engines are: NS, WebRTC and Java. The other engines are to provide support for exotic or ancient browsers maximizing the coverage for all OS/browser combinations ensuring that endusers always has call capabilities regardless of the circumstances.</span></p> <div style='border-top:none;border-left:solid #C0504D 1.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left:4.3pt;margin-right: 0in'> <h4 style='margin-left:0in'><a name="_Toc455069973"><span style='font-size: 12.0pt'>API</span></a></h4> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>All the above engines are covered with an easy to use unified Java Script API, hiding all the differences between the engines as described below in the “</span><a href="start.htm#_JavaScript_API"><span style='font-size:9.0pt;font-style:normal'>JavaScript API</span></a><span style='font-size:9.0pt;font-style:normal'>” section.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 1.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left:4.3pt;margin-right: 0in'> <h4 style='margin-left:0in'><a name="_Toc455069974"><span style='font-size: 12.0pt'>GUI</span></a></h4> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The webphone can be used with or without a user interface.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The user interface can be built using any technology with JS binding. The most convenient is HTML/CSS, but you can also use any others such as Flash.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>The webphone package comes with a few prebuilt feature rich responsive user interfaces covering the most common usage such as a full featured softphone user interface and a click to call implementation. You are free to use these as is, modify them after your needs or create your own from scratch. For more details check the “</span><a href="start.htm#_User_interface_Skin/Design_1"><span style='font-size:9.0pt;font-style: normal'>User interface Skin/Design</span></a><span style='font-size:9.0pt; font-style:normal'>” section.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665507"></a><a name="_Licensing"></a><span style='font-size:12.0pt'>Licensing</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>The webphone is sold with life-time unlimited client license (Advanced and Gold) or restricted number of licenses (Basic and Standard). You can use it with any VoIP server(s) on your own and you can deploy it on any webpage(s) which belongs to you or your company. Your VoIP server(s) address (IP or domain name) and optionally your website(s) address will be hardcoded into the software to protect the licensing. You can find the licensing possibilities on the </span><a href="https://www.mizu-voip.com/Support/Webphonepricing.aspx"><span style='font-style:normal'>pricing page</span></a><span style='font-style:normal'>. After successful tests please ask for your final version at </span><a href="mailto:webphone@mizu-voip.com"><span style='font-style:normal'>webphone@mizu-voip.com</span></a><span style='font-style:normal'>. Mizutech will deliver your webphone build within one workday after your purchase.<br> Release versions does not have any limitations (mentioned below in the “Demo version” section) and are customized for your domain(s). All “mizu” and “mizutech” words and links are removed so you can brand it after your needs (with your company name, brand-name or domain name), customize and skin (we also provide a few skin which can be freely used or modified).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Your final build must be used only for you company needs (including your direct sip endusers, service customers or integrated in your software).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Title, ownership rights, and intellectual property rights in the Software shall remain with MizuTech.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>The webphone is licensed per server. Already licensed servers cannot be removed or changed, however, you can use domain names, thus allowing changing your server or its IP address any time later without any implications regarding the webphone license. The exception for the server limitations is the Gold license which has a more flexible licensing, allowing also unlimited servers.<br> The agreement and the license granted hereunder will terminate automatically if you fail to comply with the limitations described herein. Upon termination, you must destroy all copies of the Software. The software is provided "as is" without any warranty of any kind. You must accept the software </span><a href="https://www.mizu-voip.com/portals/0/Files/WebphoneSLA.pdf"><span style='font-style:normal'>SLA</span></a><span style='font-style:normal'> before to use the webphone.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>You may:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use the webphone on any number of computers, depending on your license</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Give the access to the webphone for your customers or use within your company</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Offer your VoIP services via the webphone </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Integrate the webphone to your website or web application (or native applications usually via a webview)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use the webphone on multiple webpage’s and with multiple VoIP servers (after the agreement with Mizutech). All the VoIP servers must be owned by you or your company. Otherwise please contact our support to check the possibilities</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>You may not:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Resell the webphone as is</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Sell “webphone” services for third party VoIP providers and other companies usable with any third-party VoIP servers (except if coupled with your own VoIP servers)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Resell the webphone or any derivative work which might compete with the Mizutech “</span><a href="https://www.mizu-voip.com/Software/WebPhone.aspx"><span style='font-style: normal'>webphone</span></a><span style='font-style:normal'>” software offer</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Create competition for Mizutech by reselling the webphone in similar way (not tied to your servers or apps, but as a general browser VoIP client)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Reverse engineer, decompile or disassemble or modify the software in any way except modifying the settings and the HTML/CSS skins or the included JavaScript examples</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: It is perfectly fine to sell or promote it as a “webphone service” if that is tied to your own SIP servers. But if you sell it as webphone software which can be used with any server than you are actually selling the same as Mizutech and this is not allowed by the license.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>There are the following legal ways to use the webphone:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>you have your own SIP server(s) and the webphone will be used with these server(s) (your customers can integrate the webphone into any application or website but they will use the webphone via your VoIP server)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>you are building some application or website (such as a CRM, portal or game), so the webphone will be tightly integrated with your solution </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>both of the above (webphone used via your own SIP server from within your own website or application)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>click to call for your webpage (or click to call service for others via your SIP server)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>your call center or contact center</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>call center software offered to other companies if the webphone is deeply integrated in your callcenter software or uses your own SIP server for call termination/reception</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>you are a VoIP service provider and wish to allow your customers to make calls from your website (without the need to install a native client)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'>Contact us if you wish to use the webphone in some other way which is not covered by this license or you are in doubt with the usage: <a href="mailto:webphone@mizu-voip.com?subject=webphone%20license">webphone@mizu-voip.com</a></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Demo_version"></a><span style='font-size:12.0pt'>Demo version</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The </span><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>downloadable</span></a><span style='font-style:normal'> demo version can be used to try and test before any purchase. The demo version has all features enabled but with some restrictions to prevent commercial usage. The limitations are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>commercial usage not allowed</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>maximum ~10 simultaneous webphone instances at the same time (depending on the engine used)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>might be restricted to up to ~5 or ~10 simultaneous calls (depending on the engine used)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>will expire after several months of usage (usually 2 or 3 months)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>maximum ~100 sec call duration restriction </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>maximum ~10 calls / session limitation. (After ~10 calls you will have to restart your browser)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>will work maximum ~20 minutes after that you have to restart it or restart the browser</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>can be blocked from Mizutech license service </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The demo version can be used for all kind of tests or development, but it can’t be used for production. It can be used by up to 5 developers to make short calls (below 100 seconds) and the browser have to be restarted after 10 calls or 20 minutes, otherwise a “Trial” or “License” error will be displayed or printed to the browser console.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: for the first few calls and in some circumstances the limitations might be weaker than described above, with fewer restrictions.</span></p> <p class="MsoNormal"><span style='font-style:normal'>On </span><a href="mailto:webphone@mizu-voip.com?subject=webphone%20trial"><span style='font-style:normal'>request</span></a><span style='font-style:normal'> we can also provide test builds with only trial period limitation (will expire after ~3 weeks of usage) and without the above demo limitations.</span></p> <p class="MsoNormal"><span style='font-style:normal'>See the pricing and </span><a href="start.htm#_How_to_get_1"><span style='font-style:normal'>order</span></a><span style='font-style:normal'> your licensed copy from </span><a href="https://www.mizu-voip.com/Support/Webphonepricing.aspx"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc499665508"></a><a name="_Integration_and_customization"></a><span style='font-size:12.0pt;line-height:112%'>Integration and customization</span></h1> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>The webphone is a flexible VoIP web client which can be used for </span><a href="start.htm#_Usage_examples"><span style='font-style:normal'>various purposes</span></a><span style='font-style: normal'> such as a dialer on your website, a click to call button for contacts or integrated with your web application (contact center, CRM, social media or any other application which requires VoIP calls).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665509"><span style='font-size: 12.0pt'>Concepts</span></a></h3> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>The webphone can be customized by its numerous </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>settings</span></a><span style='font-style:normal'>, </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>webphone API</span></a><span style='font-style:normal'>’s and by </span><a href="start.htm#_User_interface_Skin/Design_1"><span style='font-style:normal'>changing its HTML/CSS</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Deploy:</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The webphone can be </span><a href="start.htm#_Usage"><span style='font-style:normal'>deployed</span></a><span style='font-style:normal'> as a static page (just copy the webphone file to your website), as a dynamic page (with dynamically generated settings) or used as a JavaScript VoIP library by web </span><a href="start.htm#_Development"><span style='font-style:normal'>developers</span></a><span style='font-style:normal'>. You can embed the webphone to your </span><a href="start.htm#_Web_server_requirements"><span style='font-style:normal'>website</span></a><span style='font-style:normal'> in a div, in an </span><a href="start.htm#_Load_the_webphone_1"><span style='font-style: normal'>iFrame</span></a><span style='font-style:normal'> or </span><a href="start.htm#_Load_the_webphone"><span style='font-style:normal'>on demand</span></a><span style='font-style:normal'>, as a module or as a separate page. The webphone settings can be set also by </span><a href="start.htm#_How_to_use"><span style='font-style:normal'>URL parameters</span></a><span style='font-style: normal'> so you can just launch it from a link with all the required settings specified.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>VoIP platform:</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>All you need to use the webphone is a SIP account at any VoIP service provider or your own softswitch/IP-PBX.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Free SIP accounts can be obtained from numerous </span><a href="https://www.google.com/search?q=sip+service+provider+create+accout"><span style='font-style:normal'>VoIP service providers</span></a><span style='font-style:normal'> or you can use </span><a href="https://www.mizu-voip.com/Services/VoIPServices.aspx"><span style='font-style:normal'>our service</span></a><span style='font-style:normal'>. (Note that free accounts are free only for VoIP to VoIP calls. For outbound pstn/mobile you will need to top-up your account).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>If you wish to host it yourself then you can use any </span><a href="https://en.wikipedia.org/wiki/List_of_SIP_software"><span style='font-style:normal'>SIP server software</span></a><span style='font-style: normal'>. For example </span><a href="https://www.freepbx.org/"><span style='font-style:normal'>FreePBX</span></a><span style='font-style:normal'> for linux or the </span><a href="https://www.mizu-voip.com/Software/VoIPServer.aspx"><span style='font-style:normal'>advanced</span></a><span style='font-style:normal'> / </span><a href="https://www.mizu-voip.com/Software/VoIPServer/FreeSoftswitch.aspx"><span style='font-style:normal'>free VoIP server for windows</span></a><span style='font-style:normal'> by Mizutech. We can also provide our </span><a href="https://www.mizu-voip.com/Software/WebRTCtoSIP.aspx"><span style='font-style:normal'>WebRTC to SIP gateway</span></a><span style='font-style:normal'> (for free with the Advanced or Gold license) if your softswitch don’t have support for WebRTC and you need a self-hosted solution.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Settings:</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The webphone settings can be passed multiple ways as described at the beginning of the </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> chapter.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The most important parameter that you will need to set is the “</span><a href="start.htm#_serveraddress"><span style='font-style:normal'>serveraddress</span></a><span style='font-style:normal'>” which have to be set to the domain or IP:port of your SIP server.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Other important parameters are listed </span><a href="start.htm#_Important_settings"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>More details regarding the configuration with your SIP server can be found </span><a href="start.htm#_Web_phone_setup_1"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Integration:</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>You can </span><a href="start.htm#_Integration_with_server"><span style='font-style:normal'>integrate</span></a><span style='font-style:normal'> the webphone with your web-site or web-application:</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>-using your own </span><a href="start.htm#_Custom_HTTP_API"><span style='font-style:normal'>web server API</span></a></p> <p class="MsoNoSpacing"><span style='font-style:normal'>-and/or using the webphone client side </span><a href="start.htm#_JavaScript_API"><span style='font-style: normal'>JavaScript API</span></a><span style='font-style:normal'> to insert any business logic or AJAX call to your server API</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The webphone library doesn’t depend on any framework (as it is a pure client side library) but you can integrate it with any server side framework if you wish (PHP, .NET, NodeJS, J2EE or any server side scripting language) or work with it only from client side (from your JavaScript).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>On the client side you can use the webphone API from any JavaScript framework (such as AngularJS, React, jQuery and others) or from plain/vanilla JS or not use the JS API at all.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>You can tightly integrate the web phone with your SIP server using the methods described </span><a href="start.htm#_Integration_with_SIP"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Design</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>You can completely </span><a href="start.htm#_User_interface_Skin/Design_1"><span style='font-style:normal'>change</span></a><span style='font-style:normal'> any of the included skins (click to call button, softphone), or change the </span><a href="start.htm#_How_to_add"><span style='font-style: normal'>softphone colors</span></a><span style='font-style:normal'> or create your user interface from scratch with your favorite tool and call the webphone API from there.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Custom application:</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For deep changes or to create your unique VoIP client or custom application you will need to use the </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>JavaScript API</span></a><span class="MsoHyperlink"><span style='font-style:normal'>.</span></span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>See the </span><a href="start.htm#_Development"><span style='font-style:normal'>development</span></a><span style='font-style:normal'> section for more details.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Branding: </span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Since the webphone is usually used within your website context, your website is already your brand and no additional branding is required inside the webphone application itself. However the softphone skin (if you are using this turn-key GUI) has its own </span><a href="start.htm#_User_interface_related"><span style='font-style:normal'>branding options</span></a><span style='font-style:normal'> which can be set after your requirements.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Additionally you can change the webphone HTML/CSS </span><a href="start.htm#_User_interface_Skin/Design"><span style='font-style:normal'>design</span></a><span style='font-style:normal'> after your needs if more modifications are required.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>On request, we can send your webphone build already preconfigured with your preferences. </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For this just answer the points from the </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=General+softphone+customization"><span style='font-style:normal'>voip client customization</span></a><span style='font-style:normal'> page (as many as possible) and send to us by </span><a href="mailto:webphone@mizu-voip.com?subject=Custom%20webphone"><span style='font-style:normal'>email</span></a><span style='font-style:normal'>. Then we will generate and send your webphone build within one work-day. All the preconfigured parameters can be further changed by you via the webphone settings.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Of course, this is relevant only if you are using a skin shipped with the webphone, such as the softphone.html. Otherwise you can create your custom solution using the webphone library with your unique user interface or integrate into your existing website.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665510"></a><a name="_User_interface_Skin/Design_1"></a><span style='font-size:12.0pt'>User interface Skin/Design</span></h3> </div> <p class="MsoNormal"><span style='font-style:normal'>You can use the webphone with or without a user interface.</span></p> <p class="MsoNormal"><span style='font-style:normal'>The webphone is shipped with a few ready to use open source user interfaces such as a softphone and click to call skins. Both of these can be fully customized or you can modify their source to match your needs. You can also create any custom user interface using any technique such as HTML/CSS and bind it to the web phone javascript API. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The default user interface for the softphone and other included apps can be easily changed by modifying parameters or changing the html/css. For simple design changes you don’t need to be a designer. Colors, branding, logo and others can be set by the settings parameters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Also you can easily create your own app user interface from scratch with any tool (HTML/CSS or others) and call the webphone Java Script API from your code.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In short, there are two ways to achieve your own (any kind of) custom user interface:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>A.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use one of the skins provided by the webphone</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Here you also have two possibilities:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Quick/Basic_skin_change"><span style='font-style:normal'>Quick customization</span></a><span style='font-style:normal'> changing the webphone built-in user-interface related settings (you can change the colors, behaviors and </span><a href="start.htm#_User_interface_related"><span style='font-style:normal'>others</span></a><span style='font-style:normal'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If you are a web developer, then have a look at the html and JavaScript source code and </span><a href="start.htm#_Advanced_skinning"><span style='font-style:normal'>modify</span></a><span style='font-style:normal'> it after your needs (we provide all the source code for these; it can be found also in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>downloadable demo</span></a><span style='font-style: normal'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>B.<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Development"><span style='font-style:normal'>Create your own user web VoIP user interface</span></a><span style='font-style:normal'> and use the webphone as a JavaScript library from there.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The webphone has an easy to use </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>API</span></a><span style='font-style:normal'> which can be easily integrated with any user interface. For example from your “Call” button, just call the webphone webphone_api.js.call(number) function. Have a look at the samples folder: “minimal_example.html”, “basic_example.html” or “techdemo_example.html” (You can also use the provided samples as a template to start with and modify/extend it after your needs) </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Quick/Basic_skin_change"></a><span style='font-size:12.0pt'>Quick/Basic skin change</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Just use the “</span><a href="start.htm#_colortheme"><span style='font-style:normal'>colortheme</span></a><span style='font-style:normal'>” parameter to make quick and wide changes.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Then have a look at the “</span><a href="start.htm#_User_interface_related"><span style='font-style:normal'>User interface related</span></a><span style='font-style:normal'>” parameters (described in the “</span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>Parameters</span></a><span style='font-style:normal'>” section) and change them after your needs (set logo, branding, </span><a href="start.htm#_How_to_translate?"><span style='font-style: normal'>translate</span></a><span style='font-style:normal'> and others).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We can also send you a web softphone with your preferred skin. For this just set your customization on the </span><a href="https://www.mizu-voip.com/G/webphone/skin_customizer/index.html"><span style='font-style:normal'>online designer</span></a><span style='font-style: normal'> form and send us the parameters. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We can also send you fully customized and branded web softphone with your preferences. For this just </span><a href="mailto:webphone@mizu-voip.com?subject=Custom%20Web%20Softphone%20request"><span style='font-style:normal'>send us</span></a><span style='font-style:normal'> the </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=General+softphone+customization"><span style='font-style:normal'>customization details</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Read below if you need more customizations.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Advanced_skinning"></a><span style='font-size:12.0pt'>Advanced skinning</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Web developers/designers can easily modify the existing skins or create their own.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For the softphone application all the HTML source code can be found in "softphone.html" file as a single-page application model. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There are a few possibilities to change the skins:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Change the </span><a href="start.htm#_User_interface_related"><span style='font-style:normal'>user interface related</span></a><span style='font-style:normal'> parameters as already discussed above (for example the “</span><a href="start.htm#_colortheme"><span style='font-style:normal'>colortheme</span></a><span style='font-style:normal'>” and other parameters)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>You can manually edit the html and css file with your favorite editor to change it after your needs</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Or just create your design with your favorite tools and call the web sip phone API from there</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If you wish to customize the softphone skin (softphone.html), it is discussed in details </span><a href="start.htm#_Softphone/Dialer"><span style='font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: If you are using the webphone as a javascript library then you can customize the “choose engine” popup in "css\pmodal.css".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone can be positioned on your webpage after your needs. You can put it in a DIV or iFrame control and define any position from HTML of CSS. For example you can make it floating as described </span><a href="start.htm#_Floating_webphone"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you have different needs or don’t like the default skins, just create your own from scratch and call the webphone JavaScript API from your code. Using the API you can easily add VoIP call capabilities also to existing website or project with a few function calls as described in the “</span><a href="start.htm#_JavaScript_API"><span style='font-style: normal'>Java Script API</span></a><span style='font-style:normal'>” section below. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For specific needs, look at the following sections:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Web_Dialer/Softphone"><span style='font-style:normal'>Dialer skin</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Click_to_call_1"><span style='font-style:normal'>Click to call skin</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span class="MsoHyperlink"><span style='font-family:Symbol;color:windowtext;font-style:normal;text-decoration: none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="start.htm#_Custom_solutions"><span style='font-style:normal'>Custom solution</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span class="MsoHyperlink"><span style='font-family:Symbol;color:windowtext;font-style:normal;text-decoration: none'>·<span style='font:7.0pt "Times New Roman"'> </span></span></span><a href="start.htm#_Floating_webphone"><span style='font-style: normal'>Floating skin</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_How_to_manage"><span style='font-style:normal'>Multi-line</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665511"></a><a name="_Softphone/Dialer"></a><a name="_Web_Dialer/Softphone"></a><span style='font-size:12.0pt'>Web Dialer/Softphone</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>With the Mizu webphone you can create a web based softphone which looks like and works like a native desktop softphone application (such as X-Lite). A web based solution has a big advantage since it is always available for endusers without the need to download and install an application and also it is much more flexible than a traditional softphone (tons of parameters, easy to build user interface with HTML/CSS and easy integration with your backend).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone includes a turn-key ready softphone skin (softphone.html) which you can start using in production as-is or change it after your needs.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node11" id="node11"></a><span style='font-size:12.0pt'>Possibilities</span></h6> </div> <p class="MsoListParagraphCxSpFirst" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>You can create any HTML/CSS web design (with call controls, contact lists, etc) and call out to the WebPhone API to add the VoIP functionality.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>You can start with any custom design from scratch or you might extend the “api_example.html” to reach your goals.</span></p> <p class="MsoListParagraphCxSpLast" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>More details can be found </span><a href="start.htm#_Development"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There are two possibilities to create your web dialer:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Create your web softphone or dialer from scratch</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>You can create any HTML/CSS web design (with call controls, contact lists, etc) and call out to the WebPhone API to add the VoIP functionality.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Start with any custom design from scratch or you might extend the “api_example.html” (or any other from the samples folder) to reach your goals.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Basically the purpose of the webphone library is to create any web based SIP client solution and most of this documentation is about describing this process.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Jump </span><a href="start.htm#_Development"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> to begin the development.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Modify the existing softphone skin</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>In this chapter below we will explore the possibilities of customizing and extending the softphone skin (softphone.html)</span></p> <p class="MsoListParagraphCxSpLast" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node12" id="node12"></a><span style='font-size:12.0pt'>Softphone skin basic customization</span></h6> </div> <p class="MsoListParagraphCxSpFirst" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>An easier solution is to use the turn-key softphone skin shipped with the webphone (softphone.html and related css and js files). This can be used as-is (it is a ready to use turn-key solution) or further modifying after your needs.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>No any development knowledge is required to </span><a href="start.htm#_Web_Softphone"><span style='font-style:normal'>deploy</span></a><span style='font-style:normal'> the web softphone on your </span><a href="start.htm#_Web_server_requirements"><span style='font-style:normal'>website</span></a><span style='font-style:normal'> and you can also customize it easily via webphone </span><a href="start.htm#_User_interface_related"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'>. <br> <br> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>Note: You can quickly test this also from the online demo if you haven’t </span><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>downloaded</span></a><span style='font-style:normal'> the webphone demo package yet: </span><a href="https://www.webvoipphone.com/webphone_online_demo/softphone_launch.html"><span style='font-style:normal'>https://www.webvoipphone.com/webphone_online_demo/softphone_launch.html</span></a><span style='font-style:normal'> (this will launch the very same “softphone.html” included in the download package).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'><br> If you are a JavaScript developer then you might implement even more modifications by changing the HTML, CSS or JS files (softphone.html, js\softphone files).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>We can also ship the webphone with ready to use customized softphone skin (with your branding and settings). For this, just answer the points on </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=General+softphone+customization"><span style='font-style:normal'>this page</span></a><span style='font-style:normal'> on your order and send the answers by email.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>Here is the whole process step by step:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>1)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Order your webphone from Mizutech with branding (send as many customization details as you can by answering </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=General+softphone+customization"><span style='font-style:normal'>these points</span></a><span style='font-style:normal'>).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-style:normal'>At this point you already have a turn-key ready to use solution which can be </span><a href="start.htm#_Steps"><span style='font-style:normal'>deployed</span></a><span style='font-style:normal'> and used as-is on your website/page/application, without the need of any technical or developer knowledge.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>2)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Customize your softphone by adjusting the technical </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> after your needs</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-style:normal'>This can be easily done by just modifying or adding more parameters in the webphone_config.js. At least the “</span><a href="start.htm#_serveraddress"><span style='font-style:normal'>serveraddress</span></a><span style='font-style:normal'>” parameter must be set.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>3)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Modify the </span><a href="start.htm#_User_interface_related"><span style='font-style:normal'>user interface related parameters</span></a><span style='font-style:normal'> after your needs</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-style:normal'>For example you can set the “</span><a href="start.htm#_colortheme"><span style='font-style:normal'>colortheme</span></a><span style='font-style:normal'>” parameter to make quick and wide change about the skin appearance.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>4)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Optionally further customize your softphone by making more user interface changes as described </span><a href="start.htm#_User_interface_Skin/Design_1"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> and </span><a href="start.htm#_Softphone_skin_customization"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;line-height:normal'><span style='font-style:normal'>This optional step requires some basic HTML/CSS knowledge.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>5)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Optionally further customize your softphone by </span><a href="start.htm#_Development"><span style='font-style:normal'>integrating</span></a><span style='font-style:normal'> it with your client side application, </span><a href="start.htm#_Integration_with_web"><span style='font-style:normal'>integrating it with your server</span></a><span class="MsoHyperlink"><span style='font-style: normal'>,</span></span><span style='font-style:normal'> integrate with </span><a href="start.htm#_How_to_integrate"><span style='font-style:normal'>server-side address book</span></a><span style='font-style:normal'> or change/add functionalities by using the </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>phone API</span></a><span style='font-style:normal'> .</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>This optional step requires some development knowledge.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The softphone skin can be positioned on your webpage after your needs. You can put it in a DIV or iFrame control and define any position from HTML of CSS. For example you can make it floating as described </span><a href="start.htm#_Floating_webphone"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Softphone_skin_customization"></a><span style='font-size:12.0pt'>Softphone skin advanced customization</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the above described customization options are not enough to achieve your goals, you can modify or extend the softphone HTML, CSS or JavaScript code.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The softphone skin can be further customized, with new functionality, new user interface elements including new pages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Adding a new functionality for the softphone skin usually involves the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Add some user interface element to the softphone skin. This is described in this chapter below.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Add functionality for your user interface element. This is usually interaction with the SIP client or interaction with your app server (web service):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>To interact with the SIP client, just use the webphone </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>SIP API</span></a><span style='font-style:normal'>. Learn more </span><a href="start.htm#_Development"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>For the interaction with your backend you can use AJAX requests. Learn more </span><a href="start.htm#_Integration_with_server"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Files</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>All the webphone SDK library related files are located in the \js\lib\ directory.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The softphone skin related </span><a href="start.htm#_Folders_and_file"><span style='font-style:normal'>files</span></a><span style='font-style:normal'> are:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>html file: this is a Single Page Application and the HTML code is all in "softphone.html"</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>css files are located in \css\ directory</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>javascript files are located in: \js\softphone\ directory.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>JQuery Mobile</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The softphone skin is a single page application built using jQuery Mobile framework.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Every jQuery mobile "page" defined in softphone.html has a corresponding Javascript file in /softphone/ directory.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Regarding css files, styling, most of these css files in "css" directory are related to jQuery Mobile framework which is used to aid in the build of the Single Page application and these should not be edited/changed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>All the styling of the webphone skin is defined in "mainlayout.css" and can be customized from here. This css file should be used to change any styling.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>A simple way to change the softphone design can be achieved by changing the jQuery theme: The jQuery mobile Theme Roller generated style sheet can be found in this file: "css\themes\wphone_1.0.css". </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Current jQuery mobile version is 1.4.2. Using the Theme roller, you can create new styles: http://themeroller.jquerymobile.com/</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The style sheet which overrides the "generated" one (in which all the customizations are defined) is "css/mainlayout.css".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For basic color scheme changes you can use the </span><a href="https://www.mizu-voip.com/G/webphone/skin_customizer/index.html"><span style='font-style:normal'>online designer</span></a><span style='font-style: normal'> form. Send us your preferred color parameters and we can send you a softphone build preconfigured with your favorite colors.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Important note: jQuery namespace within the webphone is changed from "$" to "j$".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Pages</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Pages in softphone.html are <DIV> elements with the following attribute: data-role="page".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Every jQuery mobile "page" defined in softphone.html has a corresponding Javascript file in js/softphone/ directory.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example settings page's HTML is defined in softphone.html file in a <DIV> element with the id: page_settings. The corresponding Javascript file for the settings page is: \js\softphone\_settings.js. All these "page view" Javascript files contain a few lifecycle functions which are used to initiate/load/destroy a page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Helper containers</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For your convenience, the softphone skin already contains a few <DIV> elements where you can drop any custom content. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>These are place below the header on each main page (settins, dialpad, contactslist, callhistorylist).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The ID of these elements is the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>extra_header_settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>extra_header_dialpad</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>extra_header_contactslist</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>extra_header_callhistorylist</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Of course, you can add, modify or remove any user interface element as you wish. Edit the html and CSS files after your needs.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>These DIV’s were added only to help beginners.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Extra customizable pages</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There are 5 predefined extra pages which can be customized as required. These pages are: page_extra1, page_extra2, page_extra3, page_extra4, page_extra5.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The corresponding javascript files are: _extra1.js, _extra2.js, _extra3.js, _extra4.js, _extra5.js.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In each javascript file related to a page, there are three "lifecycle" functions predefined:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>onCreate()</span><span style='font-style:normal'>: This lifecycle function is called only once per session, when the user navigates to the page for the first time. This is where most initialization should go: attaching event listeners, initializing static page content, etc.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>onStart()</span><span style='font-style:normal'>:This lifecycle function is called every time the user navigates to this page (every time the page is displayed). This is where dynamic content can be added/refreshed. For example on Contacts page we load and display the contacts list.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>onStop()</span><span style='font-style:normal'>:This lifecycle function is called every time the user navigates away from this page. This is where you can save data that the user modified, clear dynamically added page content, etc.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Page navigation:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Page navigation can be done by calling jQuery mobile "changePage()" method: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Format: j$.mobile.changePage("#PAGE_ID", { transition: "none", role: "page" });</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: j$.mobile.changePage("#page_extra1", { transition: "none", role: "page" });</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To "close" a page, you can either navigate to another page, or return to the previous page by calling jQuery mobile method: j$.mobile.back();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Page content:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The content of a page will be put in a <DIV> element with the following attribute: role="main".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Content can be added:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>statically, by defining the content in softphone.html file. For example for page_extra1 the content will be in <DIV> element with id: page_extra1_content.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>dynamically, in function "PopulateData()" defined in all javascript files corresponding to a page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Autocomplete:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can turn autocomplete off for your HTML input elements like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'><input type="text" autocomplete="off" name="destination" id=”destination” /></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Auto login:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>By default the softphone skin will stop at the login screen only if there was no previous login (missing username/password). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Otherwise it should auto-login.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you wish to preset the username/password then you can do it multiple ways:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Set it in the webphone_config.js</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Pass as URL query parameters https://www.youraddress.com/webphone_path/softphone.html?wp_username=xxx&wp_password=yyy</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Pass it from JavaScript using the setparameter() API</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Pass it from your server side script session variable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Add functionality to web softphone skin</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone is shipped with a ready to use softphone skin with full functionality, but this doesn't mean that other desired functionalities cannot be added.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This can be achieved using the webphone's API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example, capturing call state events (or using any other API function) can be done like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>- create a new javascript file, for example new.js</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>- import this script right after "webphone_api.js" in softphone.html file</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>- add the following javascript code in new.js:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//start interacting with the webphone only once the onAppStateChange callback has been fired with the “loaded” event.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>webphone_api.onAppStateChange (function (state)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>{ </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> if (state === 'loaded')</span><span style='font-size:9.0pt;color:gray;font-style: normal'> //webphone loaded</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.onCallStateChange(function (event, direction, peername, peerdisplayname, line)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> //handle any events here. For example to catch the call connect events:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> if (event === 'callConnected')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'> //add your code here</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> } </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> });</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>});</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can find a similar example of webphone API usage in /samples/basic_example.html.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Empty callback functions can be found in the _dialpad.js file for your convenience (onAppStateChange, onRegStateChange, onCallStateChange, onCdr). You can just enter any code for these functions body.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The full webphone API is available so you can easily interact with the softphone skin from external modules or injected code as described in the </span><a href="start.htm#_Development"><span style='font-style:normal'>development</span></a><span style='font-style:normal'> and </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>API</span></a><span style='font-style:normal'> chapters. Please note that the onCallStateChange and some other callbacks are not used internally by the softphone (because it uses the low level notifications), but you can use them in your code to catch webphone state changes. Just set your callback function(s) and it will work.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Toc10264413"><span style='font-size:12.0pt'>GUI architecture</span></a></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The skin HTML is located in softphone.html.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-style:normal'>This is a single page application that uses </span><a href="https://jquerymobile.com/"><span style='font-style:normal'>jQuery Mobile</span></a><span style='font-style:normal'> framework for the single page structure and also for UI elements cross browser compatibility. Every “page” in “softphone.html” has a corresponding Javasript file in “\js\softphone\” directory, for example: </span><span style='font-family: Consolas;color:#CE7B00;font-style:normal'>"page_dialpad" </span><span style='font-style:normal'>is managed by “_dialpad.js” file.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-style:normal'>Each Javascript file managing a page has three “life cycle” callback functions:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:13.5pt;background:white'><span style='font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>onCreate() - called only once – it is a good practice to handle binding to all kind of events here</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:13.5pt;background:white'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>onStart() – called every time the page is displayed</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:13.5pt;background:white'><span style='font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>onStop() – called every time the page is “closed”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-style:normal'>Note: </span><span style='color:black;font-style:normal'>jQuery namespace within the webphone is changed from "$" to "j$".</span></p> <p class="MsoHeading9"><a name="_Toc10264414"><span style='font-size:11.0pt'>Page list</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Below is a list of all Javascript files managing pages. These are located in \js\softphone\ directory:</span><span style='font-size:11.0pt;line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_accounts.js”: manage multiple SIP accounts</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_addeditcontact.js”: user interface for creating or editing contacts</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_call.js”: user interface of the in call page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_callhistorydetails.js”: call history details page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_callhistorylist.js”: call history list page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_message.js”: messaging page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_messagelist.js”: messaging inbox list page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> “_contactdetails.js”: contact details page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_contactslist.js”: contacts list page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> “_filetransfer.js”: file transfer page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_filters.js”: simple prefix rewrite page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_internalbrowser.js”: web view used as a browser</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“_logview.js”: page for viewing internal app log/trace</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> “_newuser.js”: new user registration page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> “_dialpad.js”: main dial pad page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> “_settings.js”: settings/login page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> “_startpage.js”: it’s a page displayed once or on every start; can by a URL or text; usually used for privacy policy</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>“themes.js”: contains all the definitions of the different color themes that can be applied to the skin</span></p> <p class="MsoHeading9"><a name="_Toc10264415"><span style='font-size:11.0pt'>Menu</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-style:normal'>Every page has a menu which can be accessed when the menu button in top-right corner is clicked. This click event triggers the CreateOptionsMenu() function in the corresponding page javascript file. In CreateOptionsMenu() function the menu is assembled every time it is displayed to the user.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-style:normal'>Then in MenuItemSelected() function the selected menu item will be handled.</span></p> <p class="MsoHeading9"><a name="_Toc10264416"><span style='font-size:11.0pt'>Navigation</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Navigation between pages can be accomplished with the jquery mobile </span><a href="https://api.jquerymobile.com/1.3/jQuery.mobile.changePage/"><span style='line-height:120%;font-style:normal'>changePage</span></a><span style='line-height:120%;font-style:normal'>() method. For example, to navigate to settings page the following command will be used:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-family:Consolas;color:black;font-style:normal'>j$.</span><span style='line-height:120%;font-family:Consolas;color:#009900;font-style:normal'>mobile</span><span style='line-height:120%;font-family:Consolas;color:black;font-style:normal'>.changePage(</span><span style='line-height:120%;font-family:Consolas;color:#CE7B00;font-style:normal'>"#page_settings"</span><span style='line-height:120%;font-family:Consolas;color:black;font-style:normal'>, { </span><span style='line-height:120%;font-family:Consolas;color:#009900; font-style:normal'>transition</span><span style='line-height:120%;font-family: Consolas;color:black;font-style:normal'>: </span><span style='line-height:120%; font-family:Consolas;color:#CE7B00;font-style:normal'>"pop"</span><span style='line-height:120%;font-family:Consolas;color:black;font-style:normal'>, </span><span style='line-height:120%;font-family:Consolas;color:#009900;font-style:normal'>role</span><span style='line-height:120%;font-family:Consolas;color:black;font-style:normal'>: </span><span style='line-height:120%;font-family:Consolas;color:#CE7B00;font-style:normal'>"page"</span><span style='line-height:120%;font-family:Consolas;color:black;font-style:normal'> });</span></p> <p class="MsoHeading9"><a name="_Toc10264417"><span style='font-size:11.0pt'>Styling</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>All the skin related CSS files are located in “\css\softphone\” directory. Here all the CSS files are jQuery mobile generated style sheets, except “mainlayout.css”. All the styling is done here.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>All element dimensions are set proportionally with percentages if possible, or using “em” unit of measure, to assure that the skin user interface resizes well on any screen size and any resolution.</span></p> <p class="MsoHeading9"><a name="_Toc10264418"><span style='font-size:11.0pt'>Skin start up</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The main page launched is every time the settings page. If the user has already entered login credentials before, the skin will automatically login and display the dial pad page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node13" id="node13"></a><span style='font-size:12.0pt'>Common tasks</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The softphone skin is open sourced (plain html/css/js source code is included in the webphone package) and it can be freely changed by any web developer.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>A few common tasks are described below for your convenience:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoHeading9" style='margin:0in;margin-bottom:.0001pt'><a name="_Toc10264429"></a><a name="_Toc10259042"><span style='font-size:11.0pt'>How to add a new page</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The ready to use skin which is delivered with the webphone package is built as a single page application using </span><a href="https://jquerymobile.com/"><span style='line-height:120%; font-style:normal'>jQuery mobile</span></a><span style='line-height:120%; font-style:normal'> framework (actually only a few things are used from jQuery mobile, the rest is plain html/javascript).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Follow the steps below to create a new page:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-style:normal'>1)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Create new <div> html element with attribute <b>data-role="page" </b>in softphone.html file. You can use “page_extra1” as template.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>2)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Create the equivalent JavaScript file, which manages the behavior of the new page. You can use the “</span><span style='line-height:120%;font-style:normal'>_extra1.js</span><span style='line-height:120%;font-style:normal'>” file as template.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>3)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Add the three “life cycle” callback Javascript functions in init.js</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>j$(document).on('pageinit</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>j$(document).on('pageshow'</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>c.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>j$(document).on('pagebeforehide'</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The new page is ready.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <p class="MsoHeading9" style='margin:0in;margin-bottom:.0001pt'><a name="_Toc10264430"></a><a name="_Toc10259043"><span style='font-size:11.0pt'>How to change the login page</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The login page is managed in “_settings.js” file. Basically, it displays only the main login settings: serveraddress, username, password. There is also a traditional style login page which can be enabled with the “useloginpage” parameter: -1=auto (default), 0=no, 1=only at first login, 2=always.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <p class="MsoHeading9" style='margin:0in;margin-bottom:.0001pt'><a name="_Toc10264431"></a><a name="_Toc10259044"><span style='font-size:11.0pt'>How to change the main page (dial pad tab)</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The main dial pad tab consists of the “page_dialpad” id <div> defined in softphone.html and the associated javascript file: _dialpad.js.</span></p> <p class="MsoHeading9"><a name="_Toc10264432"></a><a name="_Toc10259045"><span style='font-size:11.0pt'>How to add a new setting</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>First establish the setting parameter name, which should be in lowercase, for example “newsetting”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Open stringres.js file and define the new setting title, description and short description (short description is optional) with the following format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-family:Consolas;color:#009900; font-style:normal'>sett_display_name_proximitysensor</span><span style='font-family:Consolas;color:black;font-style:normal'>: </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>'My settings'</span><span style='font-family:Consolas;color:black;font-style:normal'>,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-family:Consolas;color:#009900; font-style:normal'>sett_comment_proximitysensor</span><span style='font-family: Consolas;color:black;font-style:normal'>: </span><span style='font-family:Consolas; color:#CE7B00;font-style:normal'>'My new settings does the following'</span><span style='font-family:Consolas;color:black;font-style:normal'>,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-family:Consolas;color:#009900; font-style:normal'>sett_comment_short_proximitysensor</span><span style='font-family:Consolas;color:black;font-style:normal'>: </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>''</span><span style='font-family:Consolas;color:black;font-style:normal'>,</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If you want this setting to appear on the user interface, then add the “newsetting” to the comma separated list stored in String variable “settOrderWebphone” and “settOrderWebphoneWebRTCFlash” located in _setings.js file. Also, the order in this list will define the order in which the settings will be displayed. For a setting to appear in “Basic settings”, the parameter name should be added to the slit in variable “basicSettings”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>To actually define a new setting, go to “InitializeSettings()” function in common.js file add the new settings using SettingItem() function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The following line of code will add the new settings:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-family:Consolas;color:black; font-style:normal'>SettingItem (</span><span style='font-family:Consolas; color:#CE7B00;font-style:normal'>"newsetting"</span><span style='font-family:Consolas;color:black;font-style:normal'>, </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>""</span><span style='font-family:Consolas;color:black;font-style:normal'>, </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>"1"</span><span style='font-family:Consolas;color:black;font-style:normal'>, GROUP_LOGIN, </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>""</span><span style='font-family:Consolas;color:black;font-style:normal'>, </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>""</span><span style='font-family:Consolas;color:black;font-style:normal'>, </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>"1"</span><span style='font-family:Consolas;color:black;font-style:normal'>, </span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>""</span><span style='font-family:Consolas;color:black;font-style:normal'>);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;background:white'><span style='font-family:"Courier New";color:black; font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>SettingItem function has the following parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) parameterName: the name of the parameter.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) value: the current value of the parameter. I can be empty string.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) type: the type of the settings:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“0” = (boolean) enabled/disabled</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“1” = text input</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“2” = dropdown list</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) group: it belongs to this group/submenu:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“20” = displayed on login page</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“0” = basic settings list</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“1” = SIP settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“2” = Media settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“3” = Call divert settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“4” = General Settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>“8” = Video settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) allNames: a comma separated list of the display names of possible values. Used only for dropdown list type settings, otherwise empty string.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) allValues: a comma separated list of the actual parameter values. Used only for dropdown list type settings, otherwise empty string.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) isdefault: the value here should always be “1”</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>(String) defaultValue: the default value of the parameter</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <p class="MsoHeading9" style='margin:0in;margin-bottom:.0001pt'><a name="_Toc10264433"></a><a name="_Toc10259046"><span style='font-size:11.0pt'>How to remove a setting</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Go to “InitializeSettings()” function in common.js file and comment out/delete the “</span><span style='line-height:120%;color:black;font-style:normal'>SettingItem()</span><span style='line-height:120%;font-style:normal'>” function call for that parameter that is to be removed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Also search for setting parameter name in “settOrderWebphone” and “settOrderWebphoneWebRTCFlash” and “basicSettings” variable and remove it from there if found.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <p class="MsoHeading9" style='margin:0in;margin-bottom:.0001pt'><a name="_Toc10264434"></a><a name="_Toc10259047"><span style='font-size:11.0pt'>How to add a new menu item</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>In every javascript file that manages a page (located in \js\softphone\), the Menu is created in “CreateOptionsMenu ()” method. Add a menu with the following line of code:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: 13.5pt;background:white'><span style='font-family:Consolas;color:black; font-style:normal'>j$(menuId).append(</span><span style='font-family:Consolas; color:#CE7B00;font-style:normal'>'<li id="ITEM_ID"><a data-rel="back">TITLE</a></li>'</span><span style='font-family:Consolas;color:black;font-style:normal'>).listview(</span><span style='font-family:Consolas;color:#CE7B00;font-style:normal'>'refresh'</span><span style='font-family:Consolas;color:black;font-style:normal'>);</span></p> <table class="MsoNormalTable" border="0" cellpadding="0" width="100%" style='width:100.0%'> <tr> <td style='padding:.75pt .75pt .75pt .75pt'></td> <td width="98%" style='width:98.86%;padding:.75pt .75pt .75pt .75pt'></td> </tr> </table> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;background:white'><span style='color:black'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal;background:white'><span style='color:black;font-style:normal'>In MenuItemSelected() function handle the action for the added menu based on itemId.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <p class="MsoHeading9" style='margin:0in;margin-bottom:.0001pt'><a name="_Toc10264435"></a><a name="_Toc10259048"><span style='font-size:11.0pt'>How to remove a menu item</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>In every javascript file that manages a page (located in \js\softphone\), the Menu is created in “CreateOptionsMenu ()” method. Just comment out or delete the “</span><span style='line-height:120%;font-family:"Courier New";color:black;font-style:normal'>j$(menuId).append()</span><span style='line-height:120%;font-style:normal'>” line for the item to be removed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <p class="MsoHeading9" style='margin:0in;margin-bottom:.0001pt'><a name="_Toc10264436"></a><a name="_Toc10259049"><span style='font-size:11.0pt'>How </span></a><span style='font-size:11.0pt'>to add a header/footer</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For every page there is already added a header and a footer where custom content can easily be displayed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The content to be displayed here can be text or HTML and can be specified with the following parameters in webphone_api.js: “header” and “footer”.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665512"></a><a name="_Click_to_call_1"></a><span style='font-size:12.0pt'>Click to call</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Click-to-call (also known as click-to-talk, webcall or click-to-dial) is a simplified form to make a call when the enduser just needs to click on a button or a hyperlink to request an immediate connection to another webphone, softphone or PSTN (landline/mobile), without the need of configuration to be set by the enduser. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You can use the webphone library to implement your custom click-to-call solution or use one of the skin templates for click to call. Click to call buttons or links can be embedded into any webpage (sales page, blogs, social media, others) and also in email (click to call from email signature).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You can also set auto-dial feature when the call is initiated automatically without enduser interaction, using the <a href="start.htm#_callto">callto</a> and <a href="start.htm#_autoaction">autoaction</a> parameters.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There are multiple ways to achieve click to call or clicktodial functionality with the sip webphone:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-style:normal'>1)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Click to call from HTML link via URL parameters (single line copy-paste code into your html)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-style:normal'>2)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use the webphone library directly (via it’s API) to implement any custom click to call solution (for JavaScript developers)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-style:normal'>3)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use the click2call template as-is. A click to call skin is shipped with the webphone (click2call.html and related css/js files) as a turn-key click to call solution which can be used without any development knowledge</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-style:normal'>4)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Modify the click2call template by changing its settings and skin after your needs)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Details:</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="node14" id="node14"></a><span style='font-size:12.0pt'>1)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Click to call from HTML link</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can pass any </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>setting</span></a><span style='font-style:normal'> as </span><a href="start.htm#_How_to_use"><span style='font-style:normal'>URL parameter</span></a><span style='font-style:normal'> and the webphone (and the included templates) can be easily parametrized to act as a click to call solution:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="http://www.yourwebsite.com/webphonedir/click2call.html?wp_serveraddress=YOURSIPDOMAIN&wp_username=USERNAME&wp_password=PASSWORD&wp_callto=CALLEDNUMBER&wp_autoaction=1"><span style='font-style:normal'>http://www.yourwebsite.com/webphonedir/click2call.html?wp_serveraddress=YOURSIPDOMAIN&wp_username=USERNAME&wp_password=PASSWORD&wp_callto=CALLEDNUMBER&wp_autoaction=1</span></a><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>A working example with the click to call skin:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="https://www.webvoipphone.com/webphone_online_demo/click2call.html?wp_serveraddress=voip.mizu-voip.com&wp_username=webphonetest1&wp_password=webphonetest1&wp_callto=testivr3&wp_autoaction=1"><span style='font-style:normal'>https://www.webvoipphone.com/webphone_online_demo/click2call.html?wp_serveraddress=voip.mizu-voip.com&wp_username=webphonetest1&wp_password=webphonetest1&wp_callto=testivr3&wp_autoaction=1</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This will launch the click to call page and will initiate the call automatically. You can find more examples for URL parameters </span><a href="start.htm#_How_to_use"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can also use any other skins for click to call. For example here is with the softphone skin:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a href="https://www.webvoipphone.com/webphone_online_demo/softphone.html?wp_serveraddress=voip.mizu-voip.com&wp_username=webphonetest1&wp_password=webphonetest1&wp_callto=testivr3&wp_autoaction=1"><span style='font-style:normal'>https://www.webvoipphone.com/webphone_online_demo/softphone.html?wp_serveraddress=voip.mizu-voip.com&wp_username=webphonetest1&wp_password=webphonetest1&wp_callto=testivr3&wp_autoaction=1</span></a></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="node15" id="node15"></a><span style='font-size:12.0pt'>2)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Use the webphone library directly</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can easily create your custom click to call solution from scratch by using the webphone as a library/SDK.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Just create a HTML button after your needs and call the <span style='color:#984806'>webphone_api.call(number)</span> function from there.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is recommended for JavaScript developers and in this way you can create any custom web click to call solution after your needs.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Have a look at the <span style='color:#984806'>click2call_example.html</span> in the samples folder for a very basic click to call implementation (you can use this as a starting point for your custom development).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="start.htm#_Development"><span style='font-style:normal'>Development</span></a><span style='font-style:normal'> and the </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>API</span></a><span style='font-style:normal'> sections about how to work with the web phone SDK.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="_Use_the_Click2Call"></a><span style='font-size:12.0pt'>3)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Use the Click2Call template as-is</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone package contains a ready to use click to call solution (click2call.html and related JS/CSS files). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Just copy the whole webphone folder to your website, set the parameters in the webphone_config.js file and use the click2call.html as-is on your webpage or directly. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Configure it after your needs by adjusting (changing and/or adding) the settings in the “Configuration parameters” section in the “click2call.html” file. See the </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> settings for the full list of adjustable settings.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: You can quickly test this also from the online demo if you haven’t </span><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>downloaded</span></a><span style='font-style:normal'> the webphone demo package yet: </span><a href="https://www.webvoipphone.com/webphone_online_demo/click2call.html"><span style='font-style:normal'>https://www.webvoipphone.com/webphone_online_demo/click2call.html</span></a></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in; margin-left:.25in;margin-right:0in'> <h6 style='margin-left:.25in;text-indent:-.25in'><a name="_Custom_click_to"></a><a name="_Modify_the_Click2Call"></a><span style='font-size:12.0pt'>4)<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:12.0pt'>Modify the Click2Call template</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can completely customize the click2call example for your needs (change any </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>settings</span></a><span style='font-style:normal'>, change the html/css/javascript, use your custom button image).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This click2call template/skin consists of a few different files:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>\click2call.html</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>\css\click2call\click2call.css</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>\js\click2call\click2call.js</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In the HTML file there is short html code which defines a click to call button: <span style='color:#984806'><div id="c2k_container_0" title="" style="text-align: center;"></div></span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is the single line of HTML code which you will include in your webpage where you want the click to call button to be displayed. For the call button to work, you will also have to include (preferably in the <head> section of your web page) the related css (in this case click2call.css), Javascript (click2call.js) and the webphone API file: webphone_api.js.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The Configuration parameters in click2call.html are put there just for convenience. These same parameters can be just as easily set in webphone_config.js file where the other webphone parameters are set.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In order for the click to call skin to work, a valid SIP account and a destination number need to be configured with the following API parameters :</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>serveraddress</span><span style='font-style:normal'>: yoursipdomain.com your VoIP server IP address or domain name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>username</span><span style='font-style:normal'>: SIP account username</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>password</span><span style='font-style:normal'>: SIP account password</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>callto</span><span style='font-style:normal'>: destination number to call (the click2call can be also modified to load this at run-time if there are multiple target numbers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(You can also fine-tune your solution by setting/changing any of the webphone </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The click-to-call buttons color, width, height, radius or the displayed text can be customized after your needs from the click2call.js file using the variables from the "Customizations" section.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can even add a background image, by setting your image (jpg or png format) path for the call_button_color variable in the following way: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var call_button_color = 'url(IMAGE_PATH/YOUR_PHOTO.png)';</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a name="_Toc455069986"><u><span style='font-size:11.0pt;line-height:120%'>Integrate into web page</span></u></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Below is an example code and steps to integrate the click to call button into your web page:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><u><span style='font-size:11.0pt;line-height:120%'><span style='text-decoration:none'> </span></span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Put the below code in your web page's <head> section:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'><link rel="stylesheet" href="css/click2call/click2call.css" /></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> <script src="webphone_api.js"></script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> <script src="js/click2call/click2call.js"></script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> <script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span><span style='color:gray;font-style:normal'> /**Configuration parameters*/</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> webphone_api.parameters['serveraddress'] = '';</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> webphone_api.parameters['username'] = '';</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> webphone_api.parameters['password'] = ''; </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> webphone_api.parameters['md5'] = ''; </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> webphone_api.parameters['realm'] = '';</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> webphone_api.parameters['callto'] = ''; </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> webphone_api.parameters['autoaction'] = 1;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span><span style='color:gray;font-style:normal'>//Add any other parameter here</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'></script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Copy this html element in you page, where you want the click to call button to show up:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'><div id="c2k_container_0" title=""><a href="tel://CALLTO" id="c2k_alternative_url">CALLTO</a></div></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Customize the button</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The provided click to call example button can further be customized with customization parameters located at the beginning of click2call.js file in js\click2call\ directory:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:gray;font-style:normal'>/** Customizations */</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var call_button_text = 'Call'; </span><span style='color:gray;font-style:normal'> // text displayed on call button</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var hangup_button_text = 'Hangup'; </span><span style='color:gray;font-style:normal'> // text displayed on hangup button</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var call_button_color = '#43b61b'; </span><span style='color:gray;font-style:normal'> // call button color</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var hangup_button_color = '#e83232'; </span><span style='color:gray;font-style:normal'> // hangup button color</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var status_text_color = '#ffffff'; </span><span style='color:gray;font-style:normal'> // color of displayed status messages</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var button_width = 135; </span><span style='color:gray;font-style:normal'> // button width in pixels</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var button_height = 42; </span><span style='color:gray;font-style:normal'> // button height in pixels</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var button_radius = 5; </span><span style='color:gray;font-style:normal'> // button corner radius in pixels, higher values will result in a round button</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var chatwindow_title = 'Chat'; </span><span style='color:gray;font-style:normal'> // chat window header-title; can be text or html</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var chatwindow_default_state = 0; </span><span style='color:gray;font-style:normal'> // default state of the chat window: 0=open, 1=collapsed</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The styling can be further customized from click2call.css located in css/click2call/ directory.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:gray;font-style:normal'>/**For floating button*/</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_button = false; </span><span style='color:gray;font-style:normal'> // if set to true the button will float over the content of the webpage</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_top = -1; </span><span style='color:gray;font-style:normal'> // distance in pixels from the top of the page. -1 means disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_left = -1; </span><span style='color:gray;font-style: normal'> // distance in pixels from the left of the page. -1 means disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_bottom = -1; </span><span style='color:gray;font-style: normal'> // distance in pixels from the bottom of the page. -1 means disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_right = -1; </span><span style='color:gray;font-style: normal'>// distance in pixels from the right of the page. -1 means disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Customize the behavior</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The click to call example can further be customized by editing the js\click2call\click2call.js Javascript file.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>All the API functions found in webphone_api.js can be used to achieve the desired functionality.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example if you choose to add your own custom incoming call popup, you can do this in click2call.js file using the <span style='color:#984806'>webphone_api.onCallStateChange()</span> function where you receive call events. For chat message events use the <span style='color:#984806'>webphone_api.onChat()</span> function. Find more details about the API functions in the documentation and in webphone_api.js.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="OLE_LINK23"></a><a name="OLE_LINK22"><b><span style='font-style:normal'>Use as a chat window</span></b></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The click to call button can also be used as a chat window. This is controlled by the </span><a href="start.htm#_autoaction"><span style='font-style:normal'>autoaction</span></a><span style='font-style:normal'> parameter (1 means call, 2 means chat).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The chat window can also be opened by accessing the menu and selecting the Chat item.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The menu can be accessed by right clicking or by long clicking on the button.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="OLE_LINK25"></a><a name="OLE_LINK24"><b><span style='font-style:normal'>Floating button</span></b></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This click to call button can also be used as a floating button on a web page. The floating related configurations can be found in click2call.js file located in js/click2call/ folder.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To enable floating, set the "float_button" config to true and specify two direction coordinates for the floating. For example to have a floating button on the top right corner of your page, located from 100 pixels from the top and 10 pixels from the right:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_button = true;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_top = 100; </span><span style='color:gray;font-style:normal'>// floating 100 pixels from the top of the page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_left = -1;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_bottom = -1;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var float_distance_from_right = 10; </span><span style='color:gray;font-style:normal'>// floating 10 pixels from the right of the page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The floating parameters also apply to the chat window in the same way as for the click to call button.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: If somehow your changes will not have effect in the web browser, you just need to clear the cache.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Multiple instances</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To add more than one click to call button to a page, include the script part in the <head> section once, and copy the container <div> increasing the id index number for every instance.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>ex:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'><div id="c2k_container_0" title="55555"></div></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'><div id="c2k_container_1" title="66666"></div></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'><div id="c2k_container_2" title="77777"></div></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'><div id="c2k_container_3" title="88888"></div></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>These id indexes must be unique and increasing.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The callto parameter can be set as the title attribute of the <div> element.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Load on demand</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can also load the sip web phone on demand as explained </span><a href="start.htm#_Load_the_webphone"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Auto-call</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>If you wish to make a call automatically, then just initialize the webphone as described above and </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>-either set also the “<span style='color:#984806'>autoaction</span>” parameter to <span style='color:#984806'>1</span></span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>-or make the call with the <span style='color:#984806'>webphone_api.call(number</span>) API from the <span style='color:#984806'>onAppStateChange()</span> callback “<span style='color:#984806'>loaded</span>” event or from the <span style='color:#984806'>onRegStateChange ()</span> callback “<span style='color:#984806'>registered</span>” event.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The </span><a href="start.htm#_autoaction"><span style='font-style:normal'>autoaction</span></a><span style='font-style:normal'> API parameter controls the behavior of the click to call button and can have the following values:</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>0: Nothing (default) - it will display the click to call button and will place a call whet the user clicks it.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>1: Call - it will immediately place a call, once page is loaded in which the click to call button is integrated.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>2: Chat - a chat window will be displayed for the user</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>3: Video Call - it will immediately place a video call, once page is loaded in which the click to call button is integrated.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-size:9.0pt'>Note:</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Even if you initiate a call form the onAppStateChange “loaded” event and the webphone is not yet registered -and it needs to register-, then it will handle registration first then it will initialize the call automatically.</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If your IP-PBX doesn’t require registrations, then just set the “register” setting to 0.</span></p> <p class="MsoNoSpacing"><span style='font-size:9.0pt'> </span></p> <p class="MsoNoSpacing"><span style='font-size:9.0pt;font-style:normal'>More details about the click to call functionality can be found </span><a href="https://www.mizu-voip.com/Solutions/Clicktocall.aspx"><span style='font-size:9.0pt;font-style:normal'>here</span></a><span style='font-size:9.0pt;font-style:normal'> and in </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/topic/Click-to-call/Default.aspx"><span style='font-size:9.0pt;font-style:normal'>this wiki article</span></a><span style='font-size:9.0pt;font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-size:9.0pt;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665513"></a><a name="_Custom_solutions"></a><span style='font-size:12.0pt'>Custom solutions</span></h3> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>The most common use case for the webphone is as a dialer (softphone user interface) or as a click to call solution (simple click to call button user interface).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For these we got you covered with ready to use solutions shipped with the webphone (see the softphone.html and the click2call.html files).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>However this doesn’t mean that the webphone usage is restricted only for these. You can create any kind of solution using the webphone. A few examples are listed </span><a href="start.htm#_Usage_examples"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>All you need is a little HTML knowledge to create your desired user interface and some JavaScript knowledge to use the webphone API from your HTML/JS.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>You might implement your solution by </span><a href="start.htm#_Softphone/Dialer"><span style='font-style:normal'>extending the softphone skin</span></a><span style='font-style:normal'> or by creating a new solution from scratch.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>See the </span><a href="start.htm#_Development"><span style='font-style:normal'>webphone development</span></a><span style='font-style:normal'> section for more details.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665514"></a><a name="_Integration_with_server"></a><a name="_Integration_with_web"></a><span style='font-size:12.0pt'>Integration with Web server side applications or scripts</span></h3> </div> <p class="MsoNoSpacing"><span style='font-size:9.0pt'>This section is mostly for server side developers. If you have more JavaScript skills then we recommend to just use the </span><a href="start.htm#_JavaScript_API"><span style='font-size:9.0pt'>JavaScript API</span></a><span style='font-size:9.0pt'> directly as described in the </span><a href="start.htm#_Development"><span style='font-size:9.0pt'>development section</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>First of all it is important to mention that the webphone doesn’t have any server side framework dependencies. You can host it on any webserver without any framework (.PHP, .NET, Node.Js ot others installed).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The webphone is running entirely on the client side (in the user browser as a browser sip plugin) and can be easily manipulated via its JavaScript SIP API, h</span><span style='font-style:normal'>owever you can easily integrate the webphone with any server side application (web applications or web service) or script, be it .NET, PHP, Node.Js, J2EE or any other language or framework even if you don’t have JavaScript experience. Just </span><span style='font-style:normal'>create a HTTP API to catch events such as login/call start/disconnect and drive your app logic accordingly.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>The most basic things you can do is to <b>dynamically generate the webphone </b></span><a href="start.htm#_Main_Parameters"><b><span style='font-style:normal'>parameters</span></b></a><b><span style='font-style:normal'> </span></b><span style='font-style:normal'>per session depending on your needs. For example if the user is already logged-in, then you can pass its SIP username/password for the webphone (possibly </span><a href="start.htm#_Applet_parameter_security"><span style='font-style:normal'>encoded</span></a><span style='font-style:normal'>).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For this, just generate the webphone_config.js dynamically or pass the </span><a href="start.htm#_How_to_use"><span style='font-style:normal'>parameters in the URI</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For a tighter integration you will just have to <b>call into your server from the webphone</b>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>This can be done with simple XMLHTTP /</span><a href="https://www.w3schools.com/xml/ajax_intro.asp"><span style='font-style:normal'>AJAX</span></a><span style='font-style:normal'> or websocket requests against your server HTTP API, then process the events in your server code according to your needs. The requests can be generated using the built-in HTTP API events or you can just post them yourself from your custom JavaScript code using websocket or ajax requests. Usually these requests will be made from </span><a href="start.htm#_Events"><span style='font-style:normal'>callback events</span></a><span style='font-style:normal'> which are triggered on web phone state machine changes, but you are free to place ajax request anywhere in your code such as click on a button.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><b><span style='font-style:normal'>Example:</span></b></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For example if you need to save each call details (date, caller, called, duration, others) into a server side database, then just define a “oncalldetails” or similarly named API in your server side application which can be called via simple HTTP request in one of the following ways:</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Using the built-in </span><a href="start.htm#_Custom_HTTP_API"><span style='font-style:normal'>HTTP API integration</span></a><span style='font-style:normal'> capabilities:</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>Just set the scurl_onincalldisconnected to your HTTP API. For example: </span><a href="https://mydomain.com/myapi/oncalldetails/"><span style='font-style:normal'>https://mydomain.com/myapi/oncalldetails/</span></a><span style='font-style:normal'> (or wherever your API can be called). This method is very convenient if you are a server side developer with no JavaScript knowledge as you don’t need to touch any JavaScript to implement this. See the details </span><a href="start.htm#_Custom_HTTP_API"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing" style='margin-left:.5in;text-indent:-.25in'><span style='font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Using custom AJAX requests:</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>Use the onCdr() API to setup a </span><a href="start.htm#_Events"><span style='font-style: normal'>callback</span></a><span style='font-style:normal'> which will be triggered after each call.</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>Send an AJAX request (XMLHttpRequest or jQuery get or post) to your application server with the CDR details.</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>(You can pass the details in HTTP GET URL parameters or in HTTP POST body in your preferred format such as clear text, json, xml or other).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>You will need an API on your web server to handle the websocket or AJAX HTTP GET/POST requests from the webphone.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>This can be done by implementing a web service or a simple script in any server side framework on language (such as .ASP .NET, PHP, Node.js or others).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>You can push/request anything from the webphone and do anything with the data (store in a database such as MS SQL, MySQL or PostgreSQL) or answer with some content to be displayed on the webphone user interface.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For example on incoming calls (cached with the </span><a href="start.htm#_onCallStateChange_(callback)"><span style='font-style:normal'>onCallStateChange</span></a><span style='font-style: normal'> callback or preset with the </span><a href="start.htm#_Custom_HTTP_API"><span style='font-style:normal'>scurl_onincallsetup</span></a><span style='font-style: normal'> parameter) you might look-up the caller id (caller number) in your database and return details about the caller (such as full name, interests, etc).</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>You can do similar things for all other important events such as on phone start, on chat, on call setup, etc and perform various actions on your server side such as processing/transforming/storing the data received by the webphone and/or returning answers to be processed or displayed by the webphone.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Note: For auto-provisioning from a server side application, you can create an API to return all the webphone parameters (settings) and set the “scurl_setparameters” setting to this API URL.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Custom_HTTP_API"></a><span style='font-size:12.0pt'>Custom HTTP API integration</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can integrate the webphone with your server code using your custom HTTP (AJAX) API URI’s. These are called “Action URL’s”, so you can implement various server-side actions when something happens on the SIP client (such as on incoming call, on call finished, and others). You can implement these API’s in your existing server-side framework, using any language or tools (ASP.NET, PHP or any others).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Just set one or more of the following settings to point to your server application HTTP API entries which will be called automatically as the webphone state machine changes:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onstart</span></b><span style='line-height:120%;font-style:normal'>: will be called when the webphone is starting</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onoutcallsetup</span></b><span style='line-height:120%;font-style:normal'>: will be called on outgoing call init</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onoutcallringing</span></b><span style='line-height:120%;font-style:normal'>: will be called on outgoing call ring</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onoutcallconnected</span></b><span style='line-height:120%;font-style:normal'>: will be called on outgoing call connect</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onoutcalldisconnected</span></b><span style='line-height:120%;font-style:normal'>: will be called on outgoing call disconnect with call details (CDR)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onincallsetup</span></b><span style='line-height:120%;font-style:normal'>: will be called on incoming call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onincallringing</span></b><span style='line-height:120%;font-style:normal'>: will be called on incoming call ring</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onincallconnected</span></b><span style='line-height:120%;font-style:normal'>: will be called on incoming call connect </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onincalldisconnected</span></b><span style='line-height:120%;font-style:normal'>: will be called on incoming call disconnect with call details (CDR)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_oninchat</span></b><span style='line-height:120%;font-style:normal'>: will be called on incoming instant message</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_onoutchat</span></b><span style='line-height:120%;font-style:normal'>: will be called on outgoing instant message</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_setparameters</span></b><span style='line-height:120%;font-style:normal'>: will be called after onAppStateChange started event and can be used to provision the webphone from server API. The answer should contain parameters as key/value pairs, ex: username=xxx,password=yyy</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>scurl_displaypeerdetails</span></b><span style='line-height:120%;font-style:normal'>: will be called at the beginning of incoming and outgoing calls to return details about the peer from your server API (like full name, address or other details from your CRM). It will be displayed at the location specified by the “displaypeerdetails” parameter. You can return any string as clear text or html which can be displayed as-is.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example: scurl_onoutcallsetup: </span><a href="https://mydomain.com/myapi/?user=USERNAME&called=CALLEDUMBER"><span style='line-height:120%;font-style:normal'>https://mydomain.com/myapi/?user=USERNAME&called=CALLEDUMBER</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(Your API will be called each time the webphone user makes an outgoing call and the parameters in uppercase will be replaced at runtime in the same way as described for the </span><a href="start.htm#_links"><span style='line-height:120%;font-style:normal'>links</span></a><span style='line-height:120%;font-style:normal'> setting)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For API request, the webphone will try to use following techniques (first available): AJAX/XHTTP, CORS, JSONP and websocket (if available).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node16" id="node16"></a><span style='font-size:12.0pt'>Integration with third party systems and CRM’s</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use the webphone library to implement your custom click-to-call solution or use one of the skin templates for click to call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The VoIP web sip phone browser plugin doesn’t depend on any framework and can be integrated with any system or CRM with JavaScript binding support. Usually you just need to include the webphone_api.js, set the basic parameters in the webphone_config.js (such as serveraddress/username/password to be used, but these can be passed also by the API) and just use the call() function to make an outgoing calls. Incoming calls are handled automatically and with a few more API calls you can easily implement features such as call transfer, conference, chat, dtmf or video call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example here is tutorial for </span><a href="https://www.mizu-voip.com/Portals/0/Files/SalesforceWebPhone.pdf"><span style='font-style:normal'>Salesforce webphone integration</span></a><span style='font-style:normal'> in case if you are interested in this platform or some details about </span><a href="start.htm#_Optimized_VoIP_for"><span style='font-style:normal'>VoIP callcenter integration</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Consult your CRM documentation to find the details about integration third-party general modules (or even better if it has an interface specific for third party phone integrations). </span><a href="mailto:webphone@mizu-voip.com?subject=webphone%20integration"><span style='font-style:normal'>Contact us</span></a><span style='font-style:normal'> if you need help with any integration.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node17" id="node17"></a><span style='font-size:12.0pt'>Using the webphone with various server side frameworks</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone doesn’t require any server side web framework however you are free to use your own favorite framework, language and libraries to interact with the web phone such as PHP, ASP.NET, J2EE, NodeJS, Perl, C++, Python, Ruby on Rails, Express.js, Django or any other framework. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is useful if you have a server application and you need certain details from the webphone (such as call detail records to be inserted into your database) or you wish to push some data to the webphone (settings depending on the enduser, incoming caller details, etc).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>By default the webphone has nothing to do with server side framework (it is a pure client-side library) so you can deploy it like any other javascript library.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Then you can add server side binding in various ways:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>if you don’t have any JavaScript experience, just use the action URL’s mentioned </span><a href="start.htm#_Custom_HTTP_API"><span style='font-style:normal'>above</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>otherwise you can interact with your server side service with AJAX calls (for example you can notify your server about phone state change by triggering an </span><a href="https://www.w3schools.com/xml/ajax_xmlhttprequest_send.asp"><span style='font-style:normal'>xhttp request</span></a><span style='font-style:normal'> from the from the </span><a href="start.htm#_onCallStateChange_(callback)"><span style='font-style:normal'>onCallStateChange</span></a><span style='font-style: normal'> callback) or send call the details after hangup from the </span><a href="start.htm#_onCdr_(callback)"><span style='font-style:normal'>onCdr</span></a><span style='font-style:normal'> callback. </span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>you can use also any other technique for the communication between the webphone and your server such as WebSocket, HTTP polling or use a library such as </span><a href="https://socket.io/"><span style='font-style:normal'>Socket.IO</span></a><span style='font-style:normal'> technique (These might be necessary only if you wish to exchange a lot’s of data between the webphone and your server application. Otherwise simple HTTP API requests are just fine)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In short: All you need to do is to create some API’s in your server application to be called from the webphone, usually via AJAX XHTTP requests.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><u><span style='font-style:normal'>Examples:</span></u></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We don’t have too much framework specific examples to show as the webphone is a client-side library and the server side integration is just optional and the usage is really straightforward as described above:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>ASP.NET: a very basic example from one of our customer can be downloaded from </span><a href="http://www.mizu-voip.com/Portals/0/Files/llamadasMizu.zip"><span style='font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>PHP: we are currently working on a few PHP examples and it will be available with the upcoming new release</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Others: We will extend this list with upcoming new versions. Please let us know if you have some code to share with us.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665515"></a><a name="_Integration_with_SIP"></a><span style='font-size:12.0pt'>Integration with SIP server side applications or scripts</span></h3> </div> <p class="MsoNoSpacing"><span style='font-style:normal'>This is a more straightforward topic then the previous Web application integration because here we are restricted to the SIP protocol capabilities.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>Actually the main purpose of the whole webphone library is to interact with a SIP server.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>For a tighter integration you can take full advantage of the </span><a href="https://www.ietf.org/rfc/rfc3261.txt"><span style='font-style:normal'>SIP protocol</span></a><span style='font-style:normal'> using the following tools:</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Your SIP server capabilities (configure the webphone extensions like any other SIP endpoint, taking full advantage of your softswitch (or proxy/gateway/other SIP device) capabilities such as voicemail, server side call forward, call queue, etc</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Webphone parameters: you can fully customize the webphone behavior by changing the </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span lang="HU" style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Webphone API: fully control the interaction between the webphone and your SIP server using the </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>webphone API</span></a><span style='font-style:normal'>. </span><span lang="HU" style='font-style:normal'>Beyond basic functionality, you can find useful functions such as BLF, dtmf, presence which can be used for specific interaction with your SIP server in a standard way. For example, during a call you can exchange additional details with your SIP server using SIP INFO, DTMF or even chat/presence/BLF notifications.</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span lang="HU" style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span lang="HU" style='font-style:normal'>You can also consider using a side-channel to exchange information with your server using alternative methods such as HTTP API or websocket. For this you will need a server side application and the details </span><a href="start.htm#_Integration_with_server"><span lang="HU" style='font-style:normal'>described</span></a><span lang="HU" style='font-style:normal'> in the previous chapter can be applied.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In case if you have some built-in application or script then a preferred method to exchange information between the server and the webphone is the usage of <b>extra SIP headers</b> (which can be easily sent/extract on your SIP server and also by the webphone). For more details see the </span><a href="start.htm#_customsipheader"><span style='font-style: normal'>customsipheader</span></a><span style='font-style:normal'> parameter and the </span><a href="start.htm#_setsipheader(header)"><span style='font-style:normal'>setsipheader</span></a><span style='font-style:normal'>/</span><a href="start.htm#_getsipheader(header,_callback)"><span style='font-style:normal'>getsipheader</span></a><span style='font-style:normal'> API’s.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Integration with the SIP server API is also possible by using the </span><a href="start.htm#_links"><span style='font-style: normal'>links</span></a><span style='font-style:normal'> parameters. This is useful for things like balance display, </span><a href="start.htm#_How_to_integrate"><span style='font-style:normal'>server side contact list</span></a><span style='font-style:normal'>, SMS, recharge and others.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665516"></a><a name="_Development"></a><span style='font-size:12.0pt'>Development</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_Click_to_call"></a><span style='font-size:9.0pt'>This section is for JavaScript developers. You can use this webphone also without any JavaScript skills:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If you don’t have any programming skills: </span><a href="start.htm#_Integration_and_customization"><span style='font-size:9.0pt'>customize</span></a><span style='font-size:9.0pt'> and use the included turn-key templates (for example the </span><a href="start.htm#_Softphone/Dialer"><span style='font-size:9.0pt'>softphone.html</span></a><span style='font-size:9.0pt'> or </span><a href="start.htm#_Click_to_call_1"><span style='font-size:9.0pt'>click2call.html</span></a><span style='font-size:9.0pt'>) on your website.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If you are a server-side developer not comfortable with JS: take advantage of the </span><a href="start.htm#_Integration_with_server"><span style='font-size:9.0pt'>server integration</span></a><span style='font-size:9.0pt'> capabilities</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Developers can use the webphone as an SDK (</span><span style='font-style:normal'>JavaScript </span><span style='font-style:normal'>library) to create any custom VoIP solution, standalone or integrated in any webpage or web application.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Setup"></a><span style='font-size:12.0pt'>Setup</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>First of all you should </span><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>download</span></a><span style='font-style:normal'> and </span><a href="start.htm#_Deploy"><span style='font-style:normal'>deploy</span></a><span style='font-style:normal'> the webphone on your </span><a href="start.htm#_Web_server_requirements"><span style='font-style:normal'>webserver</span></a><span style='font-style:normal'> (copy the webphone folder to your web server).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can also launch it from local file system on your dev environment (works with some limitations), but the best is if you use it from a secure (HTTPS) webserver. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Notes:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Requirements:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Basic </span><a href="https://www.w3schools.com/html/default.asp"><span style='font-style:normal'>HTML</span></a><span style='font-style:normal'> and </span><a href="https://www.w3schools.com/js/"><span style='font-style:normal'>JavaScript</span></a><span style='font-style:normal'> knowledge is required to work with the webphone to create custom solutions.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You will also need a </span><a href="start.htm#_Web_server_requirements"><span style='font-style:normal'>web server</span></a><span style='font-style:normal'> and a </span><a href="start.htm#_Is_it_working"><span style='font-style:normal'>SIP account</span></a><span style='font-style:normal'>. See more details </span><a href="start.htm#_Requirements"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Settings:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Once you deployed the webphone, you will have to adjust the settings. At least the “</span><a href="start.htm#_serveraddress"><span style='font-style:normal'>serveraddress</span></a><span style='font-style:normal'>” parameter must be set.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The library </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> can be preconfigured in webphone_config.js, changed runtime from JavaScript, passed by URL parameters or set dynamically by any server side script such as PHP, .NET, java servlet, J2EE or Node.js.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Frameworks:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone doesn’t require any extra client or server side framework (it is a client side VoIP implementation which can be used from simple JavaScript) however you are free to use your own favorite framework or libraries to </span><a href="start.htm#_Integration_with_server"><span style='font-style:normal'>interact</span></a><span style='font-style:normal'> with the web phone (for example use with jQuery on the client side or integrate into your PHP/.ASP/.NET/J2EE/NodeJS or other server side framework or use it straight without any frameworks involved).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>jQuery:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>jQuery namespace within the webphone is changed from "$" to "j$"</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><u><span style='font-style:normal'>Demo:</span></u></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The downloadable demo version has some </span><a href="start.htm#_Licensing"><span style='font-style:normal'>limitations</span></a><span style='font-style:normal'> to disable commercial usage, however if your development/test process is affected by these then you can </span><a href="mailto:webphone@mizu-voip.com?subject=webphone%20trial"><span style='font-style:normal'>request</span></a><span style='font-style:normal'> a trial from mizutech with all demo limitation removed.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node18" id="node18"></a><span style='font-size:12.0pt'>API</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The public JavaScript API can be found in "webphone_api.js" file, under global javascript namespace "webphone_api".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Just include the </span><span style='font-style:normal'>"webphone_api.js" to your project or html and start using the webphone API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The API reference can be found </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Make sure to call any API function only after the webphone completely initializes itself (the </span><a href="start.htm#_onLoaded_(callback)"><span style='font-style:normal'>onAppStateChange</span></a><span style='font-style:normal'> callback was fired with the “<span style='color: #984806'>loaded</span>” event).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node19" id="node19"></a><span style='font-size:12.0pt'>Work-flow</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Follow these steps to get started:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>1<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_Setup"><span style='font-style:normal'>Download and deploy the webphone</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Include the webphone to your project by adding/importing the <span style='color:#984806'>webphone_api.js</span> to your project</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>For HTML add the following line: <span style='color:#984806'><script src="webphone_api.js"></script></span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Create any </span><a href="start.htm#_User_interface_Skin/Design_1"><span style='font-style:normal'>user interface</span></a><span style='font-style:normal'> in HTML/CSS (or any other framework capable to bind to JavaScript) if you need something from scratch. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Otherwise you can use, modify or start with one of the html included in the webphone package: the </span><a href="start.htm#_Softphone/Dialer"><span style='font-style:normal'>softphone.html</span></a><span style='font-style:normal'>, the </span><a href="start.htm#_Click_to_call_1"><span style='font-style:normal'>click2call.html</span></a><span style='font-style: normal'> or the examples in the samples folder.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Configure the webphone via its </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'>. This can be done in multiple ways (but it is enough if you use one method only):</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>a.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>by using </span><a href="start.htm#_setparameter_(param,_value)"><span style='font-style:normal'>webphone_api.setparameter()</span></a><span style='font-style:normal'> API from JavaScript once the webphone is </span><a href="start.htm#_onLoaded_(callback)"><span style='font-style:normal'>loaded</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>b.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>by setting static parameters in the <span style='color:#984806'>webphone_config.js</span> file</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>c.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>other methods described </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use the </span><a href="start.htm#_Functions"><span style='font-style:normal'>webphone API</span></a><span style='font-style:normal'> from your user interface controls (such as </span><a href="start.htm#_register_()"><span style='font-style:normal'>webphone_api.register ()</span></a><span style='font-style:normal'> from your CONNECT button or </span><a href="start.htm#_call_(number)"><span style='font-style:normal'>webphone_api.call ()</span></a><span style='font-style:normal'> from your CALL button)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Handle the webphone state machine (call state) by using the </span><a href="start.htm#_onCallStateChange_(callback)"><span style='font-style:normal'>onCallStateChange</span></a><span style='font-style: normal'> and other </span><a href="start.htm#_Events"><span style='font-style:normal'>callbacks</span></a><span style='font-style:normal'> (modify your user interface based on the webphone state, such as displaying “Connected” when the webphone is registered or displaying a “Incoming call from X. Accept/Reject” message on incoming calls)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>8.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Consult the </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'>, the </span><a href="start.htm#_JavaScript_API"><span style='font-style:normal'>API</span></a><span style='font-style:normal'>, the </span><a href="start.htm#_Other_examples"><span style='font-style:normal'>examples</span></a><span style='font-style:normal'> in the samples folder and </span><a href="start.htm#_Advanced_functions"><span style='font-style:normal'>other parts</span></a><span style='font-style:normal'> of this documentation for more details</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node20" id="node20"></a><span style='font-size:12.0pt'>Usage</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>There are 3 basic things which you have to do while working with the SIP SDK:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Set parameters: There is a long list of </span><a href="start.htm#_Main_Parameters"><span style='line-height: 120%;font-style:normal'>parameters</span></a><span style='line-height:120%; font-style:normal'> that you can set to configure the webphone after your needs (but only a </span><a href="start.htm#_Important_settings"><span style='line-height: 120%;font-style:normal'>few</span></a><span style='line-height:120%;font-style: normal'> really important).These can be set statically in the webphone_config.js files, dynamically from your code using the setparameter API or with other methods as described at the beginning of the </span><a href="start.htm#_Main_Parameters"><span style='line-height:120%;font-style:normal'>parameters</span></a><span style='line-height:120%;font-style:normal'> chapter.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Call API functions: You can interact with the webphone by calling its </span><a href="start.htm#_JavaScript_API"><span style='line-height:120%;font-style:normal'>API</span></a><span style='line-height:120%;font-style:normal'>. For example you can initiate a call with the </span><a href="start.htm#_call_(number)"><span style='line-height:120%; font-style:normal'>call</span></a><span style='line-height:120%;font-style: normal'> function.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Process the events: Handle the </span><a href="start.htm#_Events"><span style='line-height:120%;font-style: normal'>callback</span></a><span style='line-height:120%;font-style:normal'> notifications according to your application logic. The most important is the </span><a href="start.htm#_onCallStateChange_(callback)"><span style='line-height:120%;font-style: normal'>onCallStateChange</span></a><span style='line-height:120%;font-style: normal'> callback from where can update your user interface from there as required.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: <br> You can use the webphone also without point 2 and 3, bye just configuring a html shipped with the webphone (for example the softphone.html).<br> Also even if you use point 2 (API), for very simple apps you might not need to watch for events at all (For example to make blind calls to a destination).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node21" id="node21"></a><span style='font-size:12.0pt'>Simple example</span></h6> </div> <p class="MsoNormal"><span style='line-height:120%;font-style:normal'>A minimal implementation (a simple VoIP call) can be achieved with less than 5 lines of code on your website. See the minimal_example.html (found in the webphone package samples folder).<br> Example:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'><head></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'><!-- Include the webphone_api.js to your webpage --></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'><script src="webphone_api.js"></script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'></head></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'><body></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'><script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Wait until the webphone is loaded, before calling any API functions</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>webphone_api.onAppStateChange(function (state)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'> {</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> if (state === 'loaded')</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Set parameters (Replace upper case worlds with your settings)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//Alternatively these can be also preset in your webphone_config.js file or passed as URL parameters</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter('serveraddress', SERVERADDRESS); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter('username', USERNAME); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter('password', PASSWORD); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//See the “Parameters” section below for more options </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Start the webphone (optional but recommended) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.start();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//These API calls below actually should be placed behind separate functions (button clicks)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Make a call (Usually initiated by user action, such as click on a click to call button. Number can be extension, SIP username, SIP URI or mobile/landline phone) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.call(NUMBER); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Hang-up (usually called from “disconnect” button click)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.hangup(); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> //Send instant message (Number can be extension, SIP username. Usually called from a “send chat” button) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.sendchat(NUMBER, MESSAGETEXT);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>});</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:gray;font-style: normal'>//You should also handle events from the webphone and change your GUI accordingly (onXXX callbacks)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'></script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'></body></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Other_examples"></a><span style='font-size:12.0pt'>Other examples</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the html </span><a href="start.htm#_Folders_and_file"><span style='font-style:normal'>files</span></a><span style='font-style:normal'> in the webphone/samples folder for more examples.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>a very simple but functional basic example can be found in the webphone package: basic_example.html</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>as a better example, see the tech demo page (techdemo_example.html / techdemo_example.js) or the api_example.html</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>click2call.html is a ready to use click to call implementation </span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>softphone.html implements a fully features browser softphone (this can be found in the webphone root folder, not in the samples folder). You might choose to </span><a href="start.htm#_Softphone/Dialer"><span style='font-style:normal'>extend this skin</span></a><span style='font-style: normal'> instead of creating your own from scratch (in case if your goal is to create a complex dialer based solution).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can also try the same examples from our </span><a href="https://www.mizu-voip.com/Software/WebPhone/WebphoneOnlineDemo.aspx"><span style='font-style:normal'>online demo</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You are free to use/modify any of these files and adjust it after your needs or create your own solution from scratch.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For beginners we would recommend to start with the “basic_example.html “, “api_example.html “ or “techdemo_example” and modify/improve it after your needs.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you need something ready to use, than just use the “softphone.html” (this can be also customized with the many webphone </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'> or by changing the html/css/js files)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Advanced_functions"></a><span style='font-size:12.0pt'>Advanced functions</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Most of the traditional VoIP functionalities (in/our calls, chat, call divert) can be handled very easily with the webphone, however some advanced features might require special care if you wish to interact with them. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Lots of things can be achieved by the webphone </span><a href="start.htm#_Call_divert_and"><span style='font-style:normal'>parameters</span></a><span style='font-style:normal'>, without the need of any programming effort.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Here are some examples for advanced usage:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>settings/auto-provisioning: it can be done easily with the </span><a href="start.htm#_setparameter_(param,_value)"><span style='font-style: normal'>setparameter</span></a><span style='font-style:normal'> API but you might have special needs which would require to pass the parameters in a special way. See the beginning of the parameters section for the </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>possibilities</span></a><span style='font-style:normal'> and some more in the </span><a href="start.htm#_How_to_customize"><span style='font-style:normal'>FAQ</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>multiple lines: handled automatically but you might handle it </span><a href="start.htm#_How_to_manage"><span style='font-style:normal'>explicitly</span></a><span style='font-style:normal'> if required for your project</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>low-level engine </span><a href="start.htm#_Notifications"><span style='font-style:normal'>messages</span></a><span style='font-style:normal'>: this is only for advanced users and rarely needed to intercept these messages. You might use the </span><a href="start.htm#_getEvents_(callback)"><span style='font-style:normal'>onEvent</span></a><span style='font-style:normal'> callback for this but it is recommended to use the other high level events such as the </span><a href="start.htm#_onCallStateChange_(callback)"><span style='font-style: normal'>onCallStateChange</span></a><span style='font-style:normal'> to handle the web SIP state machine</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>low-level interaction with the native engines: if somehow you have some extra requirements which is not available with this high-level API then you might use the low-level </span><a href="start.htm#_jvoip(name,_jargs)"><span style='font-style:normal'>jvoip</span></a><span style='font-style:normal'> API with the NS and Java engines </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>dtmf, call transfer, hold, forward: we took special care to make these as simple to use as possible so all of these can be handled by a single API call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>voice call recording: just set the </span><a href="start.htm#_voicerecupload"><span style='font-style:normal'>voicerecupload</span></a><span style='font-style:normal'> parameter or use the </span><a href="start.htm#_voicerecord_(start,_url)"><span style='font-style:normal'>voicerecord</span></a><span style='font-style:normal'> API from Java Script</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>conference: handled automatically by default via a single API call but optionally you might implement some specific user interface to display all parties </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>parameter encryption/obfuscation: usually not required since you are working with them in the otherwise secure user session, but if you wish to use it then it is described </span><a href="start.htm#_Applet_parameter_security"><span style='font-style:normal'>here</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>video: you must provide a html element where the video have to be </span><a href="start.htm#_video"><span style='font-style:normal'>displayed</span></a><span style='font-style:normal'> and manage this GUI accordingly: <div id="video_container"></div></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>chat, sms: these also requires some extra user interface to send the messages and display the call history</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>manipulating SIP messages: requires some VoIP/SIP skills if you need to interact this way with your VoIP server and you can use the </span><a href="start.htm#_setsipheader(header)"><span style='font-style:normal'>setsipheader</span></a><span style='font-style:normal'>/</span><a href="start.htm#_getsipheader(header,_callback)"><span style='font-style:normal'>getsipheader</span></a><span style='font-style:normal'> API’s</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>create a native application by using the webphone from a </span><a href="start.htm#_Using_the_webphone_1"><span style='font-style:normal'>WebView</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: all of these are also implemented in the “</span><a href="start.htm#_Web_Softphone"><span style='font-style:normal'>softphone</span></a><span style='font-style:normal'>” skin which is included with the webphone so you might use/modify this skin if you need a complete softphone like solution instead to develop your own from scratch (if you don’t have specific requirements which can’t be handled by customizing the softphone skin)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For more details regarding custom development, see the “</span><a href="start.htm#_JavaScript_API"><span style='font-style: normal'>JavaScript API</span></a><span style='font-style:normal'>” section below in this documentation.</span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc499665517"></a><a name="_Main_Parameters"></a><a name="_Parameters"></a>Parameters</h1> </div> <p class="MsoNormal"><br> <span style='line-height:120%;font-style:normal'>The webphone parameters can be used to fully customize the webphone behavior including SIP settings, media settings, user interface settings, for example parameters like the SIP server domain, authentication, called party number, autodial and many others.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Most of the settings are optional except the "<b>serveraddress</b>" (but also this can be provided at runtime via the API).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The other important parameters are the SIP user credentials (<b>username</b>, <b>password</b>) and the called number (<b>callto</b>) which you can also preset (for example if you wish to implement click to call) however these are usually entered by user (and optionally can be saved in local cookie for later reuse).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone parameters can be set in multiple ways (statically and </span><a href="start.htm#_How_to_customize"><span style='font-style:normal'>dynamically</span></a><span style='font-style:normal'>) to allow maximum flexibility and ease the usage for any work-flow.<br> Use one (or more) of the following methods for the webphone configuration:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Preset the settings in the "</span><a href="start.htm#_Folders_and_file"><b><span style='font-style:normal'>webphone_config.js</span></b></a><span style='font-style:normal'>" file. This should be used for parameters which are expected to not change at runtime, such as the serveraddress parameter.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Use the </span><a href="start.htm#_setparameter_(param,_value)"><b><span style='font-style:normal'>setparameter()</span></b></a><b><span style='color:#984806;font-style:normal'> </span></b><span style='font-style: normal'>API call from JavaScript. For most parameters the setparameter function must be called from the </span><a href="start.htm#_onAppStateChange_(callback)"><span style='font-style:normal'>onAppStateChange</span></a><span style='font-style: normal'> callback “<span style='color:#984806'>loaded</span>” event. Never sooner (API functions, including the setparameter, works only after the “loaded” event was triggered in onAppStateChange).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Changing the parameters by using the <span style='color:#984806'>webphone_api.parameters['paramname'] = 'value'</span> format is NOT recommended because parameters changed in this way can’t be overwritten later by the setparameter() API.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Webpage </span><a href="start.htm#_How_to_use"><b><span style='font-style:normal'>URL</span></b></a><span style='font-style:normal'> query string (The webphone will look at the embedding document URL at startup. </span><span style='font-style:normal'>Prefix all keys with “wp_”. For example &wp_username=x or any other parameter specified in this documentation</span><span style='font-style:normal'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Via the </span><a href="start.htm#_Custom_HTTP_API"><span style='font-style:normal'>scurl_setparameters</span></a><span style='font-style:normal'> settings which can load the parameters from your server side application (</span><span style='font-style:normal'>This will be called after the onAppStateChange “started” event and can be used to provision the webphone from server API. The answer should contain parameters as key/value pairs, ex: username=xxx,password=yyy)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Cookies (prefix all keys with “wp_”. For example wp_username)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Web session variables (</span><a href="start.htm#_How_to_pass"><span style='line-height:120%; font-style:normal'>PHP example</span></a><span style='line-height:120%; font-style:normal'>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>SIP signaling (sent from server) with the x-mparam header (or x-mparamp if need to persist). Example: <span style='color:#548DD4'>x-mparam=loglevel=5;aec=0</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Auto-provisioning: the browser phone is also capable to download it’s settings from a config file based on user entered OP CODE (although this way of configuration is a little bit redundant for a web app, since you can easily create different versions of the app –for example by deploying it in different folders- already preconfigured for your customers, providing a direct link to the desired version instead of asking the users to enter an additional OPCODE) </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>User input: You can let the user to modify the settings. For example to enter username/password for SIP authentication (For example using the softphone skin most of the settings can be specified by the users at login/settings screens, which might overwrite server side settings loaded from the webphone_config.js file if any)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Also see </span><a href="start.htm#_How_to_configure"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> and </span><a href="start.htm#_How_to_set"><span style='font-style:normal'>here</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Any of these methods can be used or they can be even mixed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The quick and easiest way to start is to just set all the required parameters in the webphone_config.js file. For example:<br> <br> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>webphone_api.parameters = {</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>serveraddress: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>'voip.mizu-voip.com'</span><span style='font-size:9.0pt;line-height:120%;color:#984806;font-style:normal'>,</span><span style='font-size:9.0pt;line-height:120%;color:gray;font-style:normal'> //your SIP server domain:port or IP:port</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>username: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>'webphonetest1'</span><span style='font-size:9.0pt;line-height:120%;color:#984806;font-style:normal'>,</span><span style='font-size:9.0pt;line-height:120%;color:gray;font-style:normal'> //the username is usually specified by the enduser and not need to be set globally here</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>password: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>'webphonetest1'</span><span style='font-size:9.0pt;line-height:120%;color:#984806;font-style:normal'>,</span><span style='font-size:9.0pt;line-height:120%;color:gray;font-style:normal'> //the password is usually specified by the enduser and not need to be set globally here</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>displayname: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>'John Smith'</span><span style='font-size:9.0pt;line-height:120%;color:#984806; font-style:normal'>,</span><span style='font-size:9.0pt;line-height:120%; color:gray;font-style:normal'> //optional display name, usually specified by the enduser and not need to be set globally here</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>brandname: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>'BestPhone'</span><span style='font-size:9.0pt;line-height:120%;color:#984806;font-style:normal'>,</span><span style='font-size:9.0pt;line-height:120%;color:gray;font-style:normal'> //your brand name</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>rejectonbusy: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>true</span><span style='font-size:9.0pt;line-height:120%;color:#984806;font-style:normal'>,</span><span style='font-size:9.0pt;line-height:120%;color:gray;font-style:normal'> //will reject incoming call if user already in call</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>ringtimeout: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>50000</span><span style='font-size:9.0pt;line-height:120%;color:#984806;font-style:normal'>,</span><span style='font-size:9.0pt;line-height:120%;color:gray;font-style:normal'> //disconnect the call after 50 sec on no answer</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'>loglevel: </span><span style='font-size:9.0pt;line-height:120%;color:#4F6228;font-style:normal'>5</span><span style='font-size:9.0pt;line-height:120%;color:gray;font-style:normal'> //enable detailed logs</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:gray;font-style:normal'>//no comma is needed after the last parameter</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:9.0pt; line-height:120%;color:#984806;font-style:normal'> };</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Usually you might set some parameters in the above webphone_config.js file (the common static/global parameters applicable for all users which doesn’t need to be changes such as the serveraddress or proxy address), then you might use one of the other methods to specify instance specific parameters (for example ask the user credentials at login screen and set it as the username/password parameters with the setparameter API).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>For a basic usage you will have to set only your VoIP server ip or domain name (“serveraddress” parameter).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'>The SIP username/password are asked from the user with the default skins if not preconfigured.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>The rest of the parameters are optional and should be changed only if you have a good reason for it.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Some parameters (username/password, displayname) are usually set by the user via some user interface (using the setparameter() API), however in some situation you might hardcode them on the server side webphone_config.js file. For example if you have some static IVR service and the caller user identity doesn’t matter.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>All parameters can be passed as strings and will be converted to the proper type internally by the webphone browser plugin.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Most parameters are saved by the webphone (in web storage and cookies) and reused at next sessions (but you can always overwrite already stored settings or clear them by setting the value to “<span style='color:#984806'>NULL</span>” or use different </span><a href="start.htm#_profile"><span style='font-style:normal'>profiles</span></a><span style='font-style:normal'>).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; color:black;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Don’t remove or comment out already set parameters because the old value might be already cached by the browser webphone. Instead of this you should just set to “<span style='color:#984806'>NULL</span>”/”<span style='color:#984806'>DEF</span>” or its default value. Details </span><a href="start.htm#_New_settings_not"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; color:black;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:black;font-style:normal'>If you have changed the parameters in the webphone_config.js then you might change its jscodeversion parameter where you include it in your project, to avoid</span><span style='font-style:normal'> any caching and force a re-download by the browser. For example: <span style='color:#984806'><script src="webphone_config.js?jscodeversion=1234"></script></span> </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Prefix parameter name with “ucfg_” if it should prefer client side settings (otherwise server side settings defined in the webphone_config.js will overwrite the client settings). Example: <span style='color:#984806'>ucfg_aec: 2</span></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>You can also clear the settings with the </span><a href="start.htm#_delsettings_(level)"><span style='font-style:normal'>delsettings</span></a><span style='font-style:normal'> API or force the webphone to forget old settings with the </span><a href="start.htm#_resetsettings"><span style='font-style:normal'>resetsettings</span></a><span style='font-style:normal'> parameter. Details </span><a href="start.htm#_New_settings_not"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Parameters can be also encrypted or obfuscated. See the “</span><a href="start.htm#_Parameter_security"><span style='font-style:normal'>Parameter security</span></a><span style='font-style: normal'>” section for the details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Important_settings"></a><span style='font-size:12.0pt'>Important settings</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The most important parameters are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_serveraddress"><span style='line-height:120%; font-style:normal'>serveraddress</span></a><span style='line-height:120%; font-style:normal'> (your SIP server domain or IP:port, usually set statically in the webphone_config.js)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_username"><span style='line-height:120%;font-style: normal'>username</span></a><span style='line-height:120%;font-style:normal'>/</span><a href="start.htm#_password"><span style='line-height:120%;font-style:normal'>password</span></a><span style='line-height:120%;font-style:normal'> (SIP account details, usually entered by the endusers and passed to the webphone with the </span><a href="start.htm#_setparameter_(param,_value)"><span style='line-height:120%;font-style: normal'>setparameter</span></a><span style='line-height:120%;font-style:normal'> API or by </span><a href="start.htm#_How_to_use"><span style='line-height:120%; font-style:normal'>URL</span></a><span style='line-height:120%;font-style:normal'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Other important parameters you might need to set are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_sipusername_1"><span style='line-height:120%; font-style:normal'>sipusername</span></a><span style='line-height:120%; font-style:normal'> (sometimes required for authentication or for Caller-ID purposes)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><span style='font-size:9.0pt;line-height:120%'>If your SIP server requires a </span><a href="start.htm#_My_server_requires"><span style='font-size:9.0pt; line-height:120%'>different auth vs user id</span></a><span style='font-size: 9.0pt;line-height:120%'>, then you can set the user id with the username parameter and the authorization username with the sipusername. You can also use it to configure a </span><a href="start.htm#_Caller_ID_display"><span style='font-size: 9.0pt;line-height:120%'>Caller ID</span></a><span style='font-size:9.0pt; line-height:120%'> (different from the auth user name) if your SIP server accepts a different username/sipusername.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt'><span style='font-size:9.0pt;line-height:120%'>With other words:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>The username will be used as user id (extension number / Caller–ID)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>The sipusername parameter will be used as the authentication username</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If only one is set, then it will be used for both the above purposes</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_displayname"><span style='line-height:120%;font-style: normal'>displayname</span></a><span style='line-height:120%;font-style:normal'> (usually from user input –enduser full name)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_proxyaddress"><span style='line-height:120%; font-style:normal'>proxyaddress</span></a><span style='line-height:120%; font-style:normal'> (only if you have an outbound proxy different from your SIP server address)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_register"><span style='line-height:120%;font-style: normal'>register</span></a><span style='line-height:120%;font-style:normal'> (you might set it to 0 if no registration is not required)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>other </span><a href="start.htm#_SIP_account_settings"><span style='line-height:120%;font-style:normal'>sip account related settings</span></a><span style='line-height:120%;font-style: normal'> (change any only if needed for your goals)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_webphonebasedir"><span style='line-height:120%; font-style:normal'>engine priority</span></a><span style='line-height:120%; font-style:normal'> (only if you prefer a specific engine for some special reason, otherwise the “best” possible engine will be used automatically)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_webrtcserveraddress"><span style='line-height:120%; font-style:normal'>webrtcserveraddress</span></a><span style='line-height:120%; font-style:normal'> (if you have your own </span><a href="start.htm#_How_to_handle"><span style='line-height:120%;font-style:normal'>WebRTC</span></a><span style='line-height:120%;font-style:normal'> </span><a href="start.htm#_How_to_configure_1"><span style='line-height:120%;font-style:normal'>gateway</span></a><span style='line-height:120%;font-style:normal'> or your softswitch has built-in WebRTC capabilities, set this to your websocket listener URL)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_codec"><span style='line-height:120%;font-style:normal'>codec</span></a><span style='line-height:120%;font-style:normal'> and </span><a href="start.htm#_prefcodec"><span style='line-height:120%;font-style:normal'>prefcodec</span></a><span style='line-height:120%;font-style:normal'> (no any changes are recommended for these since the webphone is capable to auto negotiate the </span><a href="start.htm#_What_is_the"><span style='line-height:120%;font-style:normal'>“best” possible codec</span></a><span style='line-height:120%;font-style:normal'> to use, but you might change it if you have some special needs)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>other </span><a href="start.htm#_Engine_related_settings"><span style='line-height:120%;font-style:normal'>engine related settings</span></a><span style='line-height:120%;font-style:normal'> (change any only if needed for your goals)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_callto"><span style='line-height:120%;font-style:normal'>callto</span></a><span style='line-height:120%;font-style:normal'> and </span><a href="start.htm#_autoaction"><span style='line-height:120%;font-style:normal'>autoaction</span></a><span style='line-height:120%;font-style:normal'> (in case if you wish to make an action at startup which otherwise can be done also with the API)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>other </span><a href="start.htm#_Call_divert"><span style='line-height:120%;font-style:normal'>call divert related settings</span></a><span style='line-height:120%;font-style: normal'> such as </span><a href="start.htm#_autoaccept"><span style='line-height:120%; font-style:normal'>autoaccept</span></a><span style='line-height:120%; font-style:normal'>, </span><a href="start.htm#_callforwardonbusy"><span style='line-height:120%;font-style:normal'>callforwardonbusy</span></a><span style='line-height:120%;font-style:normal'> and others (you might use the API instead for these tasks)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><a href="start.htm#_User_interface_related"><span style='line-height:120%; font-style:normal'>user interface related settings</span></a><span style='line-height:120%;font-style:normal'> if you use the </span><a href="start.htm#_Softphone/Dialer"><span style='line-height:120%;font-style:normal'>softphone skin</span></a><span style='line-height:120%;font-style:normal'> (the softphone.html, included with the webphone)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>There is <a href="start.htm#_What_are_the_1">no need</a> to any “fine-tuning” of the parameters. </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The webphone has a long list of configurable settings (listed below) for maximum flexibility, however it is not recommended to change any parameter unless strictly required to achieve your project goals. All parameters has meaningful optimal value by default or it is auto-negotiated regarding server/network/environment and unnecessarily altering the settings might result in sub-optimal behavior.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665518"></a><a name="_SIP_account_settings"></a><span style='font-size:12.0pt'>SIP account settings</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Credentials and other basic SIP parameters:</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_serveraddress"></a><span style='font-size:12.0pt'>serveraddress</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The address of your SIP server (domain or IP + port), usually the same with your SIP domain.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>It can be specified as IP address or as A or SRV domain name. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify also the port if your server is not using the default 5060; in this case append the port after the address separated by colon. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Examples:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>mydomain.com</span><span style='line-height: 120%;color:gray;font-style:normal'> (this will use the default SIP port 5060)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>sip.mydomain.com:5062</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>10.20.30.40:5065</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>10.20.30.40 </span><span style='line-height: 120%;color:gray;font-style:normal'>(this will use the default SIP port 5060)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is the single most important parameter for the webphone (along with the username/password but those can be also entered by the user). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>Sometime you might have to set also the </span><a href="start.htm#_proxyaddress"><span style='line-height:120%'>SIP proxy</span></a><span style='line-height:120%'> address and the </span><a href="start.htm#_transport"><span style='line-height:120%'>transport</span></a><span style='line-height:120%'> parameters (depending on your server side requirements). Read </span><a href="start.htm#_Web_phone_setup_1"><span style='line-height:120%'>here</span></a><span style='line-height:120%'> for more details.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>If you are using a (sub)domain as your SIP server address, then we recommend to always set it’s A record also (not just the SRV record) for full WebRTC compatibility, since browsers might not ask for SRV records.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>If your server address is different from your SIP domain, then you might set the SIP domain as the </span><a href="start.htm#_realm"><span style='line-height:120%'>realm</span></a><span style='line-height:120%'> parameter</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>If you SIP server doesn’t allow UDP for the SIP signaling then set the </span><a href="start.htm#_transport"><span style='line-height:120%'>transport</span></a><span style='line-height:120%'> parameter accordingly</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_username"></a><span style='font-size:12.0pt'>username</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is the SIP account user name (User ID / Extension ID).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Technically speaking, this is the user part of the Address of Record (AOR), sent in the “From” and “Contact” SIP headers.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>It is used for authentication (if no </span><a href="start.htm#_sipusername_1"><span style='font-size:9.0pt;line-height:120%'>sipusername</span></a><span style='font-size:9.0pt;line-height:120%'> parameter is set) and as A number/Caller-ID for the outgoing calls. Other users can make call to this endpoint by dialing this value. Some SIP service providers use a globally routable telephone number (DID) as the SIP username.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>The username/password parameters are usually supplied by the user (via some user interface and then calling the setparameter API), however in some cases you might just set it statically in the webphone_config.js file (when caller user credentials doesn’t matter). See more </span><a href="start.htm#_Register_vs_Login"><span style='font-size:9.0pt; line-height:120%'>here</span></a><span style='font-size:9.0pt;line-height:120%'>. In case if you set it “statically” in the webpone_api.js and you are using the softphone skin (softphone.html) the username will not be asked from the enduser at login.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Even if you don’t need a username and/or your server accepts all calls without authentication, you must set the username to some value: the “anonymous” username might be used in this case</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If you set the username setting to “Anonymous” then the username input box will be hidden on the “softphone” skin settings and login screens</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If you wish to set a separate caller-id you can use this parameter to specify it and then use the </span><a href="start.htm#_sipusername_1"><span style='font-size:9.0pt;line-height:120%'>sipusername</span></a><span style='font-size:9.0pt;line-height:120%'> </span><span style='font-size:9.0pt; line-height:120%'>parameter to specify the username used for authentication as specified in SIP standards. However please note that most SIP server can treat also the below mentioned “displayname” parameter as the caller-id so the usage of separate username/sipusername is usually not necessary and confusing. See more details </span><a href="start.htm#_Caller_ID_display"><span style='font-size:9.0pt; line-height:120%'>here</span></a><span style='font-size:9.0pt;line-height:120%'>.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>For maximum compatibility with third-party software and services, </span><a href="start.htm#_Special_characters_in"><span style='font-size:9.0pt;line-height:120%'>avoid</span></a><span style='font-size:9.0pt;line-height:120%'> using special and non-ASCII characters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_sipusername_1"></a><span style='font-size:12.0pt'>sipusername</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is the username used for SIP digest authentication (Auth User Name or Authorization Name).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>It is an optional setting which should be set only if your SIP server requires a different username for authentication.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>If your SIP user name and auth user name are different, the proceed like this:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Set the webphone <span style='color:#984806'>username</span> to the SIP user name (also known as extension number or the user part of the AOR)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Set the webphone <span style='color:#984806'>sipusername</span> parameter to the Auth user name (also known as Auth ID or PIN in some systems)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>If only one of the above are set (username or sipusername) then the same will be used for both purposes (both as user id and authorization user name)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>You need to set this if only the <span style='color:#984806'>username</span> parameter is not the same with the auth user name (when you need to use a different caller id and username for authentication).</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If this is not set, then the </span><a href="start.htm#_username"><span style='font-size:9.0pt;line-height:120%'>username</span></a><span style='font-size:9.0pt;line-height:120%'> parameter will be used for both the caller-id (public-identity sent with the <span style='color:#984806'>From</span> SIP header) and authorization (private identity sent with the <span style='color:#984806'>Authorization</span> SIP header).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If this is set, then this parameter will be used for authorization and the </span><a href="start.htm#_username"><span style='font-size:9.0pt;line-height:120%'>username</span></a><span style='font-size:9.0pt;line-height:120%'> parameter will be used for caller ID.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>See more details </span><a href="start.htm#_Caller_ID_display"><span style='font-size:9.0pt;line-height:120%'>here</span></a><span style='font-size:9.0pt;line-height:120%'> and </span><a href="start.htm#_My_server_requires"><span style='font-size:9.0pt;line-height:120%'>here</span></a><span style='font-size:9.0pt;line-height:120%'>.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_password"></a><span style='font-size:12.0pt'>password</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is the SIP account password used for authentication.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Make sure to never hardcode the password in html or set it via insecure http. </span><span style='font-size: 9.0pt;line-height:120%'>See more details </span><a href="start.htm#_Applet_parameter_security"><span style='font-size:9.0pt;line-height: 120%'>here</span></a><span style='font-size:9.0pt;line-height:120%'> about security.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>You can use the webphone also without password (if not using via server or your server doesn’t authenticate the users). In this case you can set the password to any value since it is supposed that it will not be required for calls or registrations</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Usually you ask the password from the endusers and set it at runtime with the setparameters API. In case if you set it “statically” in the webpone_api.js and you are using the softphone skin (softphone.html) the passord will not be asked from the enduser at login.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If your IP-PBX accept blind registrations and/or calls then the value of the password doesn’t matter (it will not be used anyway)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If you set the password setting to “nopassword” then the password input box will be hidden on the “softphone” skin settings and login screens</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If your IP-PBX doesn’t require registrations or you are not using any server then you should set the “</span><a href="start.htm#_register"><span style='font-size:9.0pt;line-height:120%'>register</span></a><span style='font-size:9.0pt;line-height:120%'>” setting to 0</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>SIP passwords are always case sensitive</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_displayname"></a><span style='font-size:12.0pt'>displayname</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Optional SIP display name.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify default display name used in “from” or “contact” SIP headers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is often sent to peer as Caller ID when placing a call (if not overwritten on the server side).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default </span><span style='font-style:normal'>value </span><span style='line-height:120%; font-style:normal'>is empty (which means that only the “username” field will be sent to the peers).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>This has nothing to do with the text displayed by the webphone skin. This is a SIP parameter to specify the display name sent to the others with call setup.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>See more details </span><a href="start.htm#_Caller_ID_display"><span style='line-height:120%'>here</span></a><span style='line-height:120%'>.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_realm"></a><span style='font-size:12.0pt'>realm</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Optional parameter to set the SIP realm (logical SIP domain) if not the same with the serveraddress. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Rarely required. (Only if your VoIP server has different realm setting as its domain and it strictly enforces that realm for authentication)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default </span><span style='font-style:normal'>value </span><span style='line-height:120%; font-style:normal'>is empty. (By default the serveraddress will be used without the port number)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_proxyaddress"></a><span style='font-size:12.0pt'>proxyaddress</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Outbound SIP proxy address (Examples: <span style='color:#984806'>mydomain.com, proxy.mydomain.com:5065, 10.20.30.40:5065</span>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Leave it empty if you don’t have a stateless proxy. (Use only the serveraddress parameter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: Set to “NULL” if you already set it before (to a wrong value) and wish to clear it.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_register"></a><span style='font-size:12.0pt'>register</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>With this parameter you can set whether the softphone should register (connect) to the sip server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no (the webphone will not send REGISTER requests)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: auto guess (yes if username/password are preset, otherwise no)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: yes (and must be registered before to make calls)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a href="start.htm#_How_to_auto"><span style='font-size:9.0pt;line-height:120%'>Related parameters</span></a><span style='font-size:9.0pt;line-height:120%'>: autostart (start webphone with page load), appengine_startat (native engine launch), startsipstack (NS engine specific), autologin (softphone skin specific)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_registerinterval"></a><span style='font-size:12.0pt'>registerinterval</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Registration interval in seconds (used by the re-registration expires timer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 120 or 300 depending on the circumstances.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>This is important for SIP servers to find out unexpected termination of the webphone application or webpage such as killing the browser, power loss or others (so the server will know that the client is no longer alive if this time is expired, but no new re-registration were received from the client).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: we don’t recommend to set the re-register interval below 30 seconds (it just causes unnecessary server load; below 30 seconds most of the SIP servers will not decide anyway and some servers doesn’t accept such short re-registration periods). Also you should not set it longer than 3600 (one hour).</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a name="_voicemailnum"></a><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665519"></a><a name="_Engine_related"></a><a name="_Engine_related_settings"></a><span style='font-size:12.0pt'>Engine related settings</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Library, engine, transport, SIP, media, DTMF, presence and BLF related settings:</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_webphonebasedir"></a><a name="_engine_priority"></a><span style='font-size:12.0pt'>sengine priority</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>By default the webphone will choose the “best” suitable </span><a href="start.htm#_Engines"><span style='line-height:120%; font-style:normal'>engines</span></a><span style='line-height:120%;font-style: normal'> </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=Webphone+engine+support+grid"><span style='line-height:120%;font-style:normal'>automatically</span></a><span style='line-height:120%;font-style:normal'> based on OS/browser/server support. This algorithm is optimized for all OS and all browsers so you can be sure that your users will have the best experience with default settings, however, if you wish, you can influence this engine selection algorithm by setting one or more of the following parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_java</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_webrtc</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_ns</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_flash</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_app</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_p2p</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_accessnum</span></b></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_nativedial</span></b></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>enginepriority_otherbrowser</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> 0: Disabled (never use this engine)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> 1: Lower (decrease the engine priority)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> 2: Normal (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> 3: Higher (will boost engine priority)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> 4: Highest (will use this engine whenever possible)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> 5: Force (only this engine will be used)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-if you wish to prioritize the NS engine, just set: <span style='color:#984806'>enginepriority_ns: 3</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-if you wish to avoid WebRTC engine, just set: <span style='color:#984806'>enginepriority_webrtc: 1</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%;color:#984806'>Best practices:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%;color:#984806'>-You should not change the engine priorities unless you have a good reason (one of the main strength of the webphone is automatic optimal engine selection based on </span><a href="https://www.mizu-voip.com/Support/Wiki/tabid/99/Default.aspx?topic=Webphone+engine+support+grid"><span style='font-size:9.0pt;line-height:120%'>circumstances</span></a><span style='font-size:9.0pt;line-height:120%;color:#984806'>, so there should be rare cases when you might need to adjust this manually)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%;color:#984806'>-Even if you have a favorite engine, you should not force it or disable the others. Just set your favorite engine priority to 3 or 4. This way even endusers which doesn’t have a chance to run your favorite engine might be able to make calls with other engines.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%;color:#984806'>-Even if for some reason you don’t like an engine, don’t entirely disable it, just lower its priority (set its enginepriority to 1 instead of 0). This means that the webphone will pickup the engine only if there is no -any other alternatives and having the webphone working with an unwanted engine is much better then not working at all</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%;color:#984806'>-It is recommended to set engine priority from static settings (for example in the webphone_config.js file) and not at runtime. In case if you have to change the engine priorities at runtime using the setparameter() API, then you must do it only from the onAppStateChange “loaded” event, not sooner or later.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;color:gray'>The engines also have a built-in default priority number assigned which can range from 0 to 100 and can be changed with the enginedefpriority_ENGINENAME settings.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;color:gray'>Default values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;color:gray'> enginedefpriority_java: 32</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:120%;color:gray'>enginedefpriority_webrtc: 20</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:120%;color:gray'>enginedefpriority_flash: 13</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:120%;color:gray'>enginedefpriority_ns: 30</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:120%;color:gray'>enginedefpriority_app: 10</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:120%;color:gray'>enginedefpriority_p2p: 5</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:120%;color:gray'>enginedefpriority_callback: 5</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:8.0pt; line-height:120%;color:gray'>enginedefpriority_nativedial: 3</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;color:gray'>You should not touch these values!</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;color:gray'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family: "Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>You can disable the NS engine for linux by setting the <span style='color:#984806'>linnsengine</span> parameter to <span style='color:#984806'>false</span>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>You can disable the NS engine for MacOS by setting the <span style='color:#984806'>macnsengine</span> parameter to <span style='color:#984806'>false</span>.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family: "Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>You can disable the NS engine for Windows only if you completely disable the NS engine by setting <span style='color:#984806'>enginepriority_ns</span> to <span style='color:#984806'>0</span>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;color:gray'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;color:gray'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_webrtcserveraddress"></a><span style='font-size:12.0pt'>webrtcserveraddress</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>WebSocket Server URL for WebRTC.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Optional setting to indicate the domain name or IP address of your websocket service used for WebRTC if any (your server address and websocket listen port).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The following URI format can be used:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>protocol:address:port/path</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'>Where:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'> The <span style='color:#984806'>protocol</span> can be <span style='color:#984806'>ws</span> (unsecure websocket) or <span style='color:#984806'>wss</span> (secure websocket)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'> The <span style='color:#984806'>address</span> can be an IP address or a (sub)domain name</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'> The <span style='color:#984806'>port</span> is where the websocket is listening and it must be specified if not 80</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> The <span style='color:#984806'>path</span> part must be set if your server require it (For example Asterisk requires the “ws” path). Check your server documentation for the exact format. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Examples:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>ws://mydomain.com</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>wss://subdomain.mydomain.com:80/anypath</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>ws://10.20.30.40:5065</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>wss://asterisk.mydomain.com:8088/ws</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; color:#984806;font-style:normal'>wss://sip.mydomain.com:8080</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty (which means auto service discovery and if no webrtc service found then the mizu webrtc service can be used if accessible).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>You can verify if the address you have set is correct by trying a simple websocket connect with some </span><a href="https://websocket.org/echo.html"><span style='line-height:120%;font-style:normal'>tool</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Latest Chrome and Opera require secure websocket (wss). You will need to install an SSL certificate for your WebRTC server for this and set this parameter with the domain name (not IP address). This is needed only if your VoIP server is WebRTC capable or you have your own WebRTC to SIP gateway. Otherwise no changes are required.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Multiple servers can be set separating the addresses by comma. In this case the webphone will use the closest by default (with fastest response time) and it is capable to failover to other server/gateway</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>By default the webphone might use our WebRTC-SIP service if your SIP server has a public IP (accessible over the internet) <u>AND</u> the webphone auto selects the WebRTC engine <u>AND</u> you haven’t set your own websocket listener for webrtc. This is a free service tier offer by us for your convenience, but its usage is optional and the webphone works also without this service.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'>More details about webrtc can be found in the FAQ: </span><a href="start.htm#_How_to_handle"><span style='line-height:120%;font-style:normal'>here</span></a><span style='line-height:120%;font-style:normal'> and </span><a href="start.htm#_How_to_configure_1"><span style='line-height:120%;font-style:normal'>here</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node22" id="node22"></a><span style='font-size:12.0pt'>rtmpserveraddress</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Optional setting to indicate the address (domain name or IP address + port number) of your flash service if any (flash media + RTMP) which might improve the SIP availability in some exotic or outdated browsers where the other engines such as WebRTC, Java or NS are not available. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If not set, then the mizu flash to sip service might be used (rarely used in normal circumstances and it can be also </span><a href="start.htm#_Does_the_webphone"><span style='line-height:120%; font-style:normal'>disabled</span></a><span style='line-height:120%;font-style: normal'> if for some reason you always wish to avoid it). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Format: yourdomain.com:rtmpport</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example: <span style='color:#984806'>10.20.30.40:5678</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_stunserveraddress"></a><span style='font-size:12.0pt'>stunserveraddress</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>STUN server address in address:port format (</span><a href="https://tools.ietf.org/html/rfc5389"><span style='line-height:120%;font-style:normal'>RFC 5389</span></a><span style='line-height:120%;font-style:normal'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can set to “NULL” to completely disable STUN. Usually STUN is not required at all, however in some circumstances (mostly depending on your SIP server and outbound trunk capabilities) it might help to avoid unnecessary RTP routing (direct peer to peer RTP routing bypassing your server). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Examples: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>11.22.33.44:3478</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>mystunserver.com:3478</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>NULL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>By default (if you leave this setting unchanged) the webphone will use the Mizutech STUN servers (unlimited free service for all webphone customers). You can change this to your own STUN server or use any </span><a href="https://www.multitel.net/docs/view/93/STUN%20Servers"><span style='line-height:120%;font-style:normal'>public</span></a><span style='line-height:120%;font-style:normal'> server if you wish. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>If you set an incorrect STUN server, then the symptoms are extra delays at call setup (up to “icetimeout”).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Instead of using the stunserveraddress parameter, you might use the ice parameter to configure both stun and turn together.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="OLE_LINK6"></a><a name="OLE_LINK5"></a><a name="OLE_LINK4"></a><a name="OLE_LINK3"></a><a name="OLE_LINK2"></a><a name="OLE_LINK1"></a><a name="_turnserveraddress"></a><span style='font-size:12.0pt'>turnserveraddress</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>TURN server address in address:port format (</span><a href="https://tools.ietf.org/html/rfc5766"><span style='line-height:120%;font-style:normal'>RFC 5766</span></a><span style='line-height:120%;font-style:normal'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can set to “NULL” to completely disable TURN.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Examples: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>11.22.33.44:80</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>mystunserver.com:80</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>NULL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If your server is capable to route the RTP, then TURN is usually not required at all. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>TURN is used mostly only with WebRTC and might be useful only if the webphone cannot send the media directly to the peer (which is usually your VoIP server) and your server doesn’t support TCP candidates. For example if all UDP is blocked or only TCP 80 is allowed or you need peer to peer media via TURN relay.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>By default (if you leave this setting unchanged) the webphone can use the Mizutech TURN servers. If you wish, you can deploy your own TURN server using the popular open source </span><a href="https://github.com/coturn/coturn"><span style='line-height:120%; font-style:normal'>coturn</span></a><span style='line-height:120%;font-style: normal'> server. The MizuTech </span><a href="https://www.mizu-voip.com/Software/WebRTCtoSIP.aspx"><span style='line-height:120%;font-style:normal'>WebRTC to SIP gateway</span></a><span style='line-height:120%;font-style:normal'> also has its own built-in TURN server</span><span style='line-height:120%;font-style:normal'> and there is no need to set this parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: Instead of using the turnserveraddress parameter, you might use the ice parameter to configure both stun and turn together.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_turnparameters"></a><span style='font-size:12.0pt'>turnparameters</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Any TURN URI parameter. </span><span style='line-height:120%'>Required only if the turnserveraddress is set.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example: <span style='color:#984806'>transport=tcp</span></span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node23" id="node23"></a><span style='font-size:12.0pt'>turnusername</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Username for turn authentication. </span><span style='line-height:120%'>Required only if the turnserveraddress is set.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node24" id="node24"></a><span style='font-size:12.0pt'>turnpassword</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Password for turn authentication. </span><span style='line-height:120%'>Required only if the turnserveraddress is set.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_ice"></a><span style='font-size:12.0pt'>ice</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Instead of using the above STUN and TURN parameters, you can use this ice parameter in the following format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#984806;font-style:normal'>ice: ‘[{ url: 'stun:stun.l.google.com:19302'}, { url:'turn:user@myturnserver.com', credential:'myPassword'}]’</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>In case if you don’t use WebRTC or you are using mizutech WebRTC-SIP gateway (MRTC) then there is no need to set any ice/stun/turn parameter as they are discovered automatically (service provided by the gateway).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Otherwise the default is: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>ice: '[{ url:'stun:rtc.mizu-voip.com:8090'}, { </span><a href="../../../../../../Data/Documents/Roaming/Microsoft/Word/%22turn:rtc.mizu-voip.com:80%3ftransport=tcp%22,%22username%22:%22mzturnusr%22,%22credential%22:%22***%22%7d"><span style='line-height:120%;font-style:normal'>url:"turn:rtc.mizu-voip.com:80?transport=tcp","username":"mzturnusr","credential":"***"}</span></a><span style='line-height:120%;font-style:normal'>]'</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>In case if you configured the webrtcserveraddress parameter to point to your WebRTC server or gateway websocket listener, then you might reconfigure this ice parameter if you also have stun/turn service (you might use the </span><a href="https://github.com/coturn/coturn"><span style='line-height:120%; font-style:normal'>coturn</span></a><span style='line-height:120%;font-style: normal'>).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might also configure any other stun service. A list of public stun servers can be found </span><a href="https://www.voip-info.org/stun/"><span style='line-height:120%; font-style:normal'>here</span></a><span style='line-height:120%;font-style: normal'> or </span><a href="https://gist.github.com/mondain/b0ec1cf5f60ae726202e"><span style='line-height:120%;font-style:normal'>here</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>There are no public free turn servers (as turn is routing the media also and not cheap to host).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also set multiple STUN and TURN servers if you wish.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node25" id="node25"></a><span style='font-size:12.0pt'>icetimeout</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Timeout for ICE address gathering (STUN/TURN/others) in milliseconds.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 2000 (2 seconds).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might increase in special circumstances if you are using some slow STUN/TURN server or decrease if peer address is public (like if your SIP or WebRTC server is on public IP always routing the media, so calls will work also without STUN).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node26" id="node26"></a><span style='font-size:12.0pt'>stunturnonlocal</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>STUN/TURN usage on local LAN. This setting helps to avoid unnecessary STUN/TURN connections, negotiations and call setup delay.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no (will set the TURN and STUN servers to null, regardless of user settings and configurations)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: STUN only (keep using STUN, but no TURN)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: use both STUN and TURN (use STUN and TURN also with local servers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default: 1</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node27" id="node27"></a><span style='font-size:12.0pt'>use_rport</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Check rport in SIP signaling (requested and received from the SIP server by the VIA header) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=don’t ask (rtport request will not be added to the VIA header)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=use only for symmetric NAT (only when it is sure that the public address will be correct)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=always (always request and use the returned value except if already on public ip)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=request even on public IP (meaningless in most cases)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>9=request with the signaling, but don’t use the returned value (good If you want to keep the local IP and for peer to peer calls)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Change to 0 or 2 only if you have NAT issues (depending on your server type and settings)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(You might adjust also the use_fast_stun parameter if you change the use_rport) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node28" id="node28"></a><span style='font-size:12.0pt'>upnpnat</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Nat traversal via UpNP supported routers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: enable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node29" id="node29"></a><span style='font-size:12.0pt'>use_fast_ice</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Fast ICE negotiations (for p2p rtp routing):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no (set to 0 only if your server needs to always route the media)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=always (not recommended)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: if set to 1 or 2 then the stun should not be disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node30" id="node30"></a><span style='font-size:12.0pt'>use_fast_stun</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Fast stun request on startup.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=force private address (if the client has both private and public IP, than the private IP will be sent in the signaling)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=use only for stable symmetric NAT </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=use only if both tests match even if not symmetric (recommended)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=use for symmetric NAT even if only one match</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5=use even on public IP</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Change if you have NAT issues (depending on your server type and settings)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(You might adjust also the use_rport parameter if use_fast_stun is changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node31" id="node31"></a><span style='font-size:12.0pt'>autodetectwebrtc</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Try to auto-detect webrtc address if not set (if the active SIP server has built-in WebRTC capabilities)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node32" id="node32"></a><span style='font-size:12.0pt'>appengine_startat</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify how to launch the app engine (native dialer / native softphone) if the rare events when it might be required (if no any other engine can be used).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: at start</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: auto (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: at call attempt</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node33" id="node33"></a><span style='font-size:12.0pt'>android_nativedialerurl</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Android native softphone download URL if any. (Optional setting to allow alternative softphone offer on Google Play).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: Android browsers has support also for WebRTC so this might be selected only with old phones or if you disable WebRTC.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty (which means the default app).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node34" id="node34"></a><span style='font-size:12.0pt'>ios_nativedialerurl</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>iOS native softphone download URL if any. (Optional setting to allow alternative softphone offer on Apple App Store).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Old Safari browsers (up to v.11) under iOS doesn’t offer any plugin for VoIP so the webphone can use its native softphone (will be auto provisioned from your webphone settings).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty (which means the default app).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node35" id="node35"></a><span style='font-size:12.0pt'>app_protocol</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify the URI handler to be registered to launch native apps if needed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The defaults are: sip, tel, webphone</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might reconfigure it if you use some other third-party app that is triggered for other protocol. For example: <span style='color:#984806'>app_protocol: “myapp”</span></span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node36" id="node36"></a><span style='font-size:12.0pt'>accessnumber</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set this if your IP-PBX has an access number where users can call into from PSTN and it can forward their call on VoIP (IVR asking for the target number).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This can be used when no other engines are working (no suitable environment, no internet connection).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node37" id="node37"></a><span style='font-size:12.0pt'>callbacknumber</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set this if your server has a callback access number where users can ring into and will receive a call from your server (possibly with an IVR which might offer the possibility to specify the destination number via DTMF).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This can be used when no other engines are working (no suitable environment, no internet connection) and it is very useful in situation where call from the server is cheaper than user call to server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_sipusername"></a><span style='font-size:12.0pt'>useragent</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This will overwrite the default User-Agent setting.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Do not set this when used with mizu VoIP servers because the server detects extra capabilities by reading this header.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_customsipheader"></a><span style='font-size:12.0pt'>customsipheader</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set a custom sip header (a line in the SIP signaling) that will be sent with all messages. Can be used for various integration purposes and usually has a key:val format. For example: <span style='color:#984806'>myheader:myvalue</span><span style='color:black'>.</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Custom SIP headers should begin with “X-“ to be able to bypass servers, gateways and proxies (For example: <span style='color:#984806'>X-MyHeader: 47</span>).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>You can add more than one header, separated by semicolon (For example: customsipheader: <span style='color:#984806'>'x-key1: val1;x-key2: val2',</span>).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>You can also use the </span><a href="start.htm#_setsipheader(header)"><span style='font-size:9.0pt;line-height:120%'>setsipheader</span></a><span style='font-size:9.0pt;line-height:120%'> API call at runtime. It can be used instead of this parameter or you can use both together (both this parameter and the API)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_checkmicrophone"></a><span style='font-size:12.0pt'>autoprovisioning</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify whether the settings have to be downloaded from a central config server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> 0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> 1: auto (</span><span style='line-height:120%;font-style:normal'>if not ip or domain was entered</span><span style='font-style:normal'>)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> 2: yes </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node38" id="node38"></a><span style='font-size:12.0pt'>checkmicrophone</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify whether calls should fail or succeed also without a microphone device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no (calls with be allowed even if client doesn’t have any microphone audio device)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: with warning (call will be allowed but a warning message will be displayed for the user)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: yes (calls will fail if user doesn’t have a microphone device)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node39" id="node39"></a><span style='font-size:12.0pt'>usecommdevice</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Use VoIP optimizations on windows (WAVE_MAPPED_DEFAULT_COMMUNICATION_DEVICE). This will also enable audio ducking (audio focus: auto lowering the volume for other processes while the webphone is in call).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: Yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: Force </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 0 if you encounter audio volume issues, especially for multi-calls.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node40" id="node40"></a><span style='font-size:12.0pt'>checkvolumesettings</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Check if audio device is muted or volume settings are too low (and un-mute and/or increase volume if necessary).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: at first run</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 1</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node41" id="node41"></a><span style='font-size:12.0pt'>allowsipuriasusername</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Used for SIP user name normalization.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: No: if username is a SIP URI, then the webphone will remove the domain and save only the username part</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: Yes: will not touch the entered user name</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Old/deprecated config option was “enabledirectcalls”.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_backgroundcalls"></a><span style='font-size:12.0pt'>callreceiver</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable background call listener. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If the WebRTC engine is used, this means push notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If you are using the NS engine on Windows, your webpage can be started automatically on incoming calls if you set this parameter to true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>When background calls is turned on, the NS engine will listen continuously for incoming call and chat notifications and will launch your website with the incoming session details if your page is not already started by the user. This will enable incoming SIP calls even if the browser is closed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable all incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: enable incoming calls (while app is running; no background listener)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: enable also background calls (WebRTC push or NS engine or android service)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>This has nothing to do with the HTML5 notification support which can be configured with the </span><a href="start.htm#_incomingcallpopup"><span style='line-height:120%;font-style:normal'>incomingcallpopup</span></a><span style='line-height:120%;font-style:normal'> parameter.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>In case if you need only NS engine background calls but not push notifications, then you might set the <span style='color:#984806'>enablepush </span>parameter to <span style='color:#984806'>0</span> (possible values: -1: auto, 0: no, 1: yes).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The old parameter was named <span style='color:#984806'>backgroundcalls</span> and it is still supported as-is</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a href="start.htm#_VoIP_Push_notifications"><span style='line-height:120%;font-style:normal'>Here</span></a><span style='line-height:120%;font-style:normal'> you can read more details about VoIP push notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_transport"></a><span style='font-size:12.0pt'>transport</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Transport protocol for native SIP.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: Auto detect</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: UDP (User Datagram Protocol. The most commonly used transport for SIP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: TCP (signaling via TCP. RTP will remain on UDP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: TLS (SIPS encrypted signaling)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: HTTP tunneling (both signaling and media. Supported only by mizu server or mizu tunnel)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: HTTP proxy connect (requires tunnel gateway or server)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5: Auto tunnel (automatic failover from UDP to HTTP </span><span style='font-style:normal'>as needed if </span><span style='line-height:120%;font-style:normal'>tunnel gateway or server is used)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>-for SIPS TLS/SRTP you might set also the </span><a href="start.htm#_mediaencryption"><span style='font-size:9.0pt;line-height: 120%'>mediaencryption</span></a><span style='font-size:9.0pt;line-height:120%'> parameter </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>-when using WebRTC this will mean the SIP transport protocol to be used with your server as for WebRTC itself the transport is controlled by the browser: http/https, websocket/secure websocket (ws/wss) and always encrypted media (DTLS/SRTP).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node42" id="node42"></a><span style='font-size:12.0pt'>localip </span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(String)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify local IP address to be used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This should be used only on devices with multiple ethernet interface to force the specified IP. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty (autodetect)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: This setting is not applicable for WebRTC (In case of WebRTC this is handled entirely by the browser internal WebRTC stack)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_signalingport"></a><span style='font-size:12.0pt'>signalingport </span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify local SIP signaling port to use.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0 (a stable port which is selected randomly at the first usage)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: This is not the port of your server where the messages should be sent. This is the local port of the signaling socket (Usually UDP if you don’t explicitly set the </span><a href="start.htm#_transport"><span style='font-size:9.0pt;line-height:120%'>transport</span></a><span style='font-size:9.0pt;line-height:120%'> to TCP)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: This setting is not applicable for WebRTC (In case of WebRTC this is handled entirely by the browser internal WebRTC stack)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node43" id="node43"></a><span style='font-size:12.0pt'>p2psignaling</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify to enable or disable peer to peer signaling routing feature.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>0: no (direct routing fully disabled forcing the call to travel via upper server –will also add X-P2P: no header)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>1: yes (full p2p direct signaling enabled when possible)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>2: proxy (might go over proxy. Actually this is a special option between no and yes where the signaling might be forwarded by proxy but might not sent directly or via upper server –will also add X-P2P: proxy header)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>3: process (might go over proxy with full processing. Actually this is a special option between no and yes where the signaling might get fully processed by proxy but might not travel via upper server –will also add X-P2P: process header)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>You might set to 0 (disable) in case if the call signaling has to reach your server (for example if you are using ring groups to fork the calls, or you wish to record the calls on your SIP server or if for billing purposes it is important that your server see also the enduser to enduser calls).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Otherwise with the default 1 value the webphone might contact directly the other party or the WebRTC gateway (in case of the WebRTC engine) might route the call directly between endusers, thus saving your server resources and shortening the network path.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: this might add a X-P2P: no/process/proxy/yes header to the SIP signaling notifying the gateway/server if routing have to be forced/ignored.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_p2prtp"></a><span style='font-size:12.0pt'>p2prtp</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify to enable (1) or disable (0) peer to peer media routing feature. This is a feature specific to Mizu webphones and it is independent of the SDP negotiations.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might set to 0 (disable) in case if the call media (RTP) must be routed through your SIP server (for example if you wish to voice record the calls on your server). Otherwise the webphone might route the media directly between webphone instances thus saving your server resources and shortening the network path. Please note that the media might be routed directly between the endpoint even if this parameter is set to 0, according the SDP and ICE negotiation (this can be influenced by your SIP server configuration by the usual NAT and RTP related settings globally or by extension).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1 (p2p for media enabled routing encrypted RTP directly between the endpoints when possible).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_rtpport"></a><span style='font-size:12.0pt'>rtpport </span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify local RTP port base.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0 (which means signalingport + 2)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: If not specified, then VoIP engine will choose signalingport + 2 which is then remembered at the first successful call and reused next time (stable rtp port). If there are multiple simultaneous calls then it will choose the next even number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Note: This setting is not applicable for WebRTC (In case of WebRTC this is handled entirely by the browser internal WebRTC stack)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node44" id="node44"></a><span style='font-size:12.0pt'>keepaliveival</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>NAT keep-alive packet send interval in milliseconds.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 0 to disable.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 28000 (28 sec)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node45" id="node45"></a><span style='font-size:12.0pt'>wskeepaliveival</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> (number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Keep-alive interval for the WebRTC websocket in milliseconds.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to 0 to disable.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 30000 (30 sec)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node46" id="node46"></a><span style='font-size:12.0pt'>sendrtponmuted</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Send rtp even if muted (zeroed packets)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to true only if your server is malfunctioning when no RTP is received.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is false.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_mediaencryption"></a><span style='font-size:12.0pt'>mediaencryption</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Media encryption method</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: </span><span style='font-style: normal'>auto guess (auto set to 1 if TLS)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: not encrypted (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: auto (will encrypt if initiated by other party)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: SRTP </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>-With SRTP it is recommended to also set the signaling </span><a href="start.htm#_transport"><span style='font-size:9.0pt; line-height:120%'>transport</span></a><span style='font-size:9.0pt;line-height: 120%'> to TLS.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>-This will not affect WebRTC since WebRTC always uses DTLS/SRTP for the media.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_dtmfmode"></a><span style='font-size:12.0pt'>dtmfmode</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>DTMF send method</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=SIP INFO method (out-of-band in SIP signaling INFO messages)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=auto (auto guess from peer advertised capabilities)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=INFO + NTE</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4=NTE (Named Telephone Events as specified in RFC 2833 and RFC 4733)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>5=In-Band (DTMF audio tones in the RTP stream)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>6=INFO + InBand</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>When more than one method is used (dtmfmode 3 or 6), the receiver might receive duplicated dtmf digits</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Received DTMF are recognized by default in both INFO or RFC2833 formats (no In-Band DTMF processing)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>WebRTC might not honor the dtmfmode settings (as this is handled by the browser in case of WebRTC)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>You should prefer the SIP INFO method if using WebRTC as In-Band NTE dtmf method might not be supported (depending on the browser implementation)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If you are using the mizu WebRTC-SIP gateway, you can set dtmf type for both inbound and outbound globally with the <span style='color:#984806'>fs_dtmf_type_intern</span> and <span style='color:#984806'>fs_dtmf_type_extern</span> server side settings and also per user with the <span style='color:#984806'>inbounddtmf</span> and <span style='color:#984806'>outbounddtmf</span> webphone parameters. The out-bound is also handled automatically after the <span style='color:#984806'>dtmfmode</span> setting (defaults to SIP info) and for in-bound both info and rfc2833 are accepted by default.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>If DTMF doesn’t work by default with Asterisk, then we recommend to set the <span style='color:#984806'>dtmfmode=info</span> configuration for the extensions used by the webphone</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:"Courier New";font-style: normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>DTMF messages can be sent from the existing skin templates or using the </span><a href="start.htm#_dtmf_(msg)"><span style='font-size:9.0pt;line-height:120%'>dtmf</span></a><span style='font-size: 9.0pt;line-height:120%'> API. Incoming dtmf messages are displayed automatically on skins or can be cached with the </span><a href="start.htm#_onDTMF_(callback)"><span style='font-size:9.0pt;line-height:120%'>onDTMF</span></a><span style='font-size:9.0pt;line-height:120%'> callback.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:8.0pt;font-family:"Courier New"; color:black;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;color:black'>DTMF messages can be also sent by adding it to the called number after a comma. For example if you make a call to 123,456 then it will call 123 and then it will send dtmf 456 once the call is connected.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node47" id="node47"></a><span style='font-size:12.0pt'>playdtmfsound</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify whether the webphone should generate local DTMF tone when DTMF is sent.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=if one digit</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=always (also when multiple digits are sent at once)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node48" id="node48"></a><span style='font-size:12.0pt'>earlymedia</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Start to send media when session progress is received.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: reserved</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: auto (will early open audio if wideband is enabled to check if supported)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: just early open the audio</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: null packets only when sdp received (NS only)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5: yes when sdp received</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>6: always forced yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 2.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_prefcodec"></a><span style='font-size:12.0pt'>prefcodec</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set your preferred audio codec. Will accept one of the followings: </span><span style='font-style:normal'>pcmu, pcma, g.711 (for both PCMU and PCMA), g.719, gsm, ilbc, speex, speexwb, speexuwb, opus, opuswb, opusuwb, opusswb</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty which means the built-in optimal </span><a href="http://www.mizu-voip.com/Support/Blog/tabid/100/EntryID/7/Default.aspx"><span style='line-height:120%;font-style:normal'>prioritization</span></a><span style='line-height:120%;font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;font-style:normal'>By default the engine will present the codec list optimized regarding the circumstances (the combination of the followings):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>available client codec set (not all engines supports all codecs)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>server codec list (depending on your server, peer device or carrier)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>internal/external call: for IP to IP calls will prioritize wideband codecs if possible, while for outbound calls usually G.729 will be selected if available</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>network quality (bandwidth, delay, packet-loss, jitter): for example iLBC is more tolerant to network problems if supported</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:8.0pt;line-height:120%;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:8.0pt;line-height:120%;font-style:normal'>device CPU: some old mobile devices might not be able to handle high-complexity codec’s such as opus or G.729. G711 and GSM has low computational costs</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;font-style:normal'>You can also fine-tune the codec settings with the use_xxx settings where xxx is the codec name as described in </span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP.pdf"><span style='font-size:8.0pt;line-height:120%;font-style:normal'>JVoIP documentation</span></a><span style='font-size:8.0pt;line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="OLE_LINK10"></a><a name="OLE_LINK9"></a><a name="_codec"></a><span style='font-size:12.0pt'>codec</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>List of allowed audio codec’s separated by comma.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>By default the webphone will automatically choose the best codec depending on available codec’s, circumstances (network/device) and peer capabilities.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set this parameter only if you have some special requirements such as forcing a specific codec, regardless of the circumstances.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example: <span style='color:#984806'>Opus,G.729,PCMU</span> (This will disable Speex, GSM, iLBC, GSM and PCMA).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default: empty (which means auto detection and negotiation)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Recommended value: leave it empty</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Under normal circumstances, the following is the built-in codec priority:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.5in'><span style='line-height:120%;font-style:normal'><span style='font:7.0pt "Times New Roman"'> </span>I.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Wideband Speex and Opus (These are set with top priority as they have the best quality. Likely used for VoIP to VoIP calls if the peer also has support for wideband)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.5in'><span style='line-height:120%;font-style:normal'><span style='font:7.0pt "Times New Roman"'> </span>II.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>G.729 (Usually the preferred codec for VoIP trunks used for mobile/landline calls because it’s excellent compression/quality ratio for narrowband)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.5in'><span style='line-height:120%;font-style:normal'><span style='font:7.0pt "Times New Roman"'> </span>III.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>iLBC, GSM (If G.729 is not supported then these are good alternatives. iLBC has better characteristics and GSM is better supported by legacy hardware)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.5in'><span style='line-height:120%;font-style:normal'><span style='font:7.0pt "Times New Roman"'> </span>IV.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>G.711: PCMU and PCMA (Requires more bandwidth, but has the best narrowband quality. Preferred from WebRTC if Opus is not supported as these are present in almost any WebRTC and SIP endpoints and servers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>With the NS and Java engines you can also use the use_codecname settings to disable/enable codec. Possible values: 0=never,1=don’t offer,2=yes with low priority,3=yes with high priority. For example to disable all codec except PCMU you can use the following settings:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>use_pcmu: 3, use_pcma: 0, use_g729: 0, use_gsm: 0, use_speex: 0, use_speexwb: 0, use_speexuwb: 0, use_opus: 0, use_opuswb: 0, use_opusuwb: 0, use_opusswb: 0, use_ilbc: 0, alwaysallowlowcodec: 0</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node49" id="node49"></a><span style='font-size:12.0pt'>vcodec</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>List of allowed video codec’s separated by comma.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might use this parameter to exclude some codec from the offer list. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example if you don’t wish to use VP8, then set this to: </span><span style='font-size:11.0pt;line-height:120%'> “</span><span style='line-height:120%;color:#984806;font-style:normal'>H264,</span><span style='color:#984806;font-style:normal'> H263</span><span style='line-height: 120%;font-style:normal'>”</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default: empty (which means auto detection and negotiation)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: WebRTC has support only for H.264 and VP8 from common browsers so you should not disable these codec’s.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_video"></a><span style='font-size:12.0pt'>video</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable video.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> <a name="OLE_LINK8"></a><a name="OLE_LINK7">-1: auto</a> (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'>0: disable</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>1: enable</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>2: force always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-If you are using the webphone with a custom skin, the video will be displayed in a div with id set to “video_container”, so your html must have this element: <span style='color:#984806'><div id="video_container"></div></span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:black;font-style:normal'>-The WebRTC engine is required for video to work (the webphone will handle this automatically by switching to WebRTC on video request if it is available)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node50" id="node50"></a><span style='font-size:12.0pt'>audio_bandwidth</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Max bandwidth for audio in kbits.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>It will be sent also with SDP “b:AS” attribute.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0 which means auto negotiated via RTCP and congestion control.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node51" id="node51"></a><span style='font-size:12.0pt'>video_bandwidth</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Max bandwidth for video in kbits.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>It will be sent also with SDP “b:AS” attribute.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0 which means auto negotiated via RTCP and congestion control.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node52" id="node52"></a><span style='font-size:12.0pt'>video size parameters</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can suggest the size of the video (in pixels) with the following parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_width</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_height</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_min_width</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_min_height</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_max_width</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>video_max_height</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_screensharing"></a><span style='font-size:12.0pt'>screensharing</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable screen sharing:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=No (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=Auto (if supported by the platform) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=Yes (always force)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Softphone skin users: If the screensharing is set, a screen share button will appear on the softphone user interface.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: screen sharing is still an experimental feature in WebRTC standards and you might need a browser </span><a href="https://chrome.google.com/webstore/detail/screen-capturing/ajhifddimkapgcifgcodmmfdlknahffk"><span style='line-height:120%;font-style:normal'>extension</span></a><span style='line-height:120%;font-style:normal'> to enable it.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might also need the followings:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Chrome: start the browser with --enable-usermedia-screen-capturing flag</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Firefox: in the config create a media.getusermedia.screensharing.enabled key and set its value to true and in media.getusermedia.screensharing.allowed_domains append the IP address of your server</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node53" id="node53"></a><span style='font-size:12.0pt'>codecframecount</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_conferencetype"></a><span style='font-style:normal'>Number of payloads in one UDP packet (frames per packet). This will directly influence RTP packet time (packetization interval) and packet size as shown </span><a href="https://www.bandcalc.com/"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>By default it is set to 0 which means 2 frames for G729 and 1 frame for all other codec.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>This usually means 20 msec rtp packetization interval for all codec’s and it is the most optimal setting, compatible with all SIP/media stack implementations.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>In case if you wish to minimize delay, then you might set the codecframecount to 1. This usually will result in 10 msec packetization interval and will increase the required bandwidth by 40% due to high header/data ratio.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>In case if you wish to minimize bandwidth, then you might set the codecframecount to 4.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: with the WebRTC engine the codec frame count is controlled by the browser WebRTC media stack and can’t be changed. Usually it will be 20 msec frame time.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node54" id="node54"></a><span style='font-size:12.0pt'>conferencetype</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify how to handle conference, especially for the WebRTC engine as other engines has built-in local RTP mixer.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: native only with local rtp mixer (on WebRTC will force the NS or java engine)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: server side conference mixing controlled by DTMF</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: 3-way SIP conference</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5: conference rooms via SIP MESSAGE and REFER</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>6. conference rooms via SIP MESSAGE</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>7. conference rooms via SIP REFER</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: call conferencing is always available with the NS and Java engines (since these are using a local RTP mixer), however with the WebRTC engine the conferencing feature will be disabled if you set this parameter to 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Old parameter name was conferenceroom, which is deprecated now.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>For more details see </span><a href="start.htm#_How_the_conference"><span style='line-height:120%'>here</span></a><span style='line-height:120%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node55" id="node55"></a><span style='font-size:12.0pt'>plc</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable packet loss concealment</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true (enabled)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node56" id="node56"></a><span style='font-size:12.0pt'>vad</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Enable/disable voice activity detection.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: yes for player (will help the jitter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: yes for recorder</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>4: yes for both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notes: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-The vad parameter is automatically set to 4 by default if the aec2 algorithm is used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-If you wish to use VAD related statistics in your application, you might have to also set the “vadstat” parameter after your needs. Possible values: 0=no,1=auto (default),2=detect no mic audio,3=send statistics. See the VAD notification and API_VAD for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-If you want to disable audio related notifications (microphone warning on no signal detected) then set the “enablenomicvoicewarning” parameter to 0</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node57" id="node57"></a><span style='font-size:12.0pt'>aec</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable acoustic echo cancellation</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=yes except if headset is guessed</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=yes if supported</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=forced yes even if not supported (might result in unexpected errors)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node58" id="node58"></a><span style='font-size:12.0pt'>aec2</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Secondary AEC algorithm.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3: yes with extra (this might be too much under normal circumstances)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: for maximum echo cancellation you can set the aec to 1,2 or 3 and aec2 to 2 or 3. </p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node59" id="node59"></a><span style='font-size:12.0pt'>agc</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Automatic gain control. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=Disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=For recording only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=Both for playback and recording</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=Guess</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 3</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node60" id="node60"></a><span style='font-size:12.0pt'>silencesupress</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable silence suppression</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Usually not recommended unless your bandwidth is really bad and expensive.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no (disabled)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1 (which means no, except mobile devices with low bandwidth)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node61" id="node61"></a><span style='font-size:12.0pt'>denoise</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Noise suppression.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=Disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=For recording only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=Both for playback and recording</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=Auto guess</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 3</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node62" id="node62"></a><span style='font-size:12.0pt'>jittersize</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Although the jitter size is calculated dynamically, you can modify its behavior with this setting.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no jitter,1=extra small,2=small,3=normal,4=big,5=extra big,6=max</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 3</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node63" id="node63"></a><span style='font-size:12.0pt'>enablepresence</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable presence. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable presence</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: auto (if presence capabilities detected)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: always enable / force </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node64" id="node64"></a><span style='font-size:12.0pt'>presenceuserlist</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>List of users separated by comma to request presence state from (the webphone will SUBSCRIBE to their presence state and will accept NOTIFY reports).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also use the <span style='color:#984806'>checkpresence()</span> API for this.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node65" id="node65"></a><span style='font-size:12.0pt'>enableblf</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable BLF (busy lamp field). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>0: disable BLF</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>1: auto (from here it will auto switch to 0 or 2 regarding the circumstances –whether BLF was initiated and succeed/failed)</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>2: enable BLF</span></p> <p class="MsoNoSpacing" style='margin-left:.5in'><span style='font-style:normal'>3: force always (if you set to 3 then it can’t be switched off later and will use BLF even after failure)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node66" id="node66"></a><span style='font-size:12.0pt'>blfuserlist</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>List of users separated by comma to request call state from (the webphone will SUBSCRIBE to their call state and will accept NOTIFY reports).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also use the <span style='color:#984806'>checkblf()</span> API for this.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_minserviceversion"></a><span style='font-size:12.0pt'>minserviceversion</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify the minimum accepted NS engine version. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is applicable only if the NS engine is used and the webphone will ask the user to upgrade if the installed NS plugin version is lower than this number (one click installer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>By default this is handled automatically by the webphone and you should change it only if you need to enforce a specific NS engine version for some reason.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Special values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-2: completely disable asking for upgrades</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-3: completely disable asking for all kind of ns engine install and upgrades</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value: depends on the webphone version</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNoSpacing"><span style='font-size:9.0pt'>Note: </span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>The NS service plugin version for v.3.0.20023 engine executable which was shipped with webphone v.3.0 is </span><u><span style='font-size:9.0pt;font-style:normal'>34</span></u><span style='font-size: 9.0pt'> (so you might set the “minserviceversion” setting to 34 to force the latest version for all users)</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Upgrades for very old (outdated/incompatible) NS engines are handled automatically by the webphone (with a reasonable default “minserviceversion” settings in new webphone versions)</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Never set this to a higher value then the latest NS plugin version (will result in continuously asking to upgrade)</span></p> <p class="MsoNoSpacing" style='margin-left:.25in;text-indent:-.25in'><span style='font-size:9.0pt;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>(Developer info: this value is loaded from the NS engine MAPPVERSION define)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>More details about NS engine upgrades can be found </span><a href="start.htm#_NS_engine_upgrade"><span style='line-height:120%;font-style:normal'>here</span></a></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_nsupgrademode"></a><span style='font-size:12.0pt'>nsupgrademode</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set how/when to upgrade the NS engine.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: delayed background install only (the new version will be downloaded and applied silently in the background with no user interaction)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: background or ask for user (default behavior to handle the upgrade. Might be delayed especially if the enduser doesn’t actively using the NS engine) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: immediate install (will ask the enduser immediately to download and install new versions)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: To completely disable all NS engine upgrades (which is not recommended), you should set the nsupgrademode to 0 and the autoupgrade to 6.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_extraregisteraccounts"></a><span style='font-size:14.0pt'>extraregisteraccounts</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Use this setting for multi-account registration.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can specify multiple SIP accounts in the following format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>IP,usr,pwd,t,proxy,realm;IP2,usr2,pwd2,t2,proxy2,realm2; IP3,usr3,pwd3,t3,proxy3,realm3;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Account parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>IP: is the SIP server IP or domain name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>usr: is the SIP username</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>pwd: is the SIP password</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>t: is the register timeout in seconds (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>proxy: SIP proxy (optional)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>realm: SIP realm (optional)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>authusr: auth (optional. Use only if separate extension id and authorization username have to be used)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Most of the parameters are optional.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The parameters have to be separated by comma (,) and the accounts have to be separated by semicolon (;).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>All have to be passed in a single line which should look like this: server,usr,pwd,ival;server2,usr2,pwd2,ival2; </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: sip1.mydomain,com,1111,xxx,300;sip2.mydomain.com,2222,xxx;</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For more details read </span><a href="start.htm#_How_to_manage_1"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_autostart"></a><span style='font-size:12.0pt'>autostart</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify whether the webphone stack should be started automatically on page load.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no (webphone will not start automatically and you might need to call the start() API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: yes (webphone will start once loaded if previous session was not failed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: always (webphone will always auto start, regardless of previous success)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If set to 0 or 1, then the start() method needs to be called manually in order for the webphone to start. Also the webphone will be started automatically on some other method calls such as register() or call().</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might set this parameter to 0 to prevent the auto initialization of the webphone, so you might delay the start() until actually the user wish to interact with your phone UI (such as pushing your click to call button).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a href="start.htm#_How_to_auto"><span style='font-size:9.0pt;line-height:120%'>Related parameters</span></a><span style='font-size:9.0pt;line-height:120%'>: register (auto register after start), appengine_startat (native engine launch), startsipstack (NS engine specific), autologin (softphone skin specific)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:12.0pt;font-family:"Cambria",serif;color:#943634'>forcereregister</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify whether you wish to disable/force reregistrations.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Please note that this is not about the normal SIP re-registrations enforced by the expires interval (That is handled automatically regardless of this settings).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This setting is considered when the sip stack unregisters unexpectedly due to error response, no response, no network or other reasons.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: never auto reregister</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: try auto reregister if it was already registered successfully before</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: always force reregister regardless of the error (for example this will attempt to reregister even if user supplied wrong username/password and server rejected the registration because of the wrong credentials)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Toc427878306"></a><a name="_Toc414334981"><span style='font-size: 12.0pt'>needunregister</span></a></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set to false to prevent unregister messages to be sent (for example to prevent unregister on web page reload).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is true.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:12.0pt;font-family:"Cambria",serif;color:#943634'>destroyonpageclose </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify what to do on close/refresh.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0: no (do nothing, will not close current call and will not unregister)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1: disconnect current calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2: disconnect and unregister </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default is 2</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:12.0pt;font-family:"Cambria",serif;color:#943634'>preferred_storage</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify what type of web storage should the webphone use.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1=Auto(default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>0=None (no persistent storage)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>1=IndexedDB</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>2=localStorage</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>3=WebSQL</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>The webphone might need to store various things for proper functionality. For example: remember old user settings so the user don’t have to type it again, remember old decisions (for example the VoIP engine to use) so it will not spend time next time to lookup or to remember if certain notifications was already showed for the user.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>It is highly recommended to keep this value at -1 (auto) as each browser has different capabilities which is handled automatically if the preferred_storage is -1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>It will use other storage method, if the preferred one is not supported by the browser.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>This parameter can be set in the <span style='color:#984806'>webphone_config.js</span> only and not passed via the <span style='color:black'>setparameter()</span> API.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Storage can also failback to cookie (only for the most important settings). <br> This can be enabled/disabled with the <span style='color:#984806'>storagecookiefailback</span> parameter: 0 means no,1 means yes (default 1)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_resetsettings"></a><span style='font-size:12.0pt'>resetsettings</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to true to clear all previously stored or cached settings on startup.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Warning: this will forget all settings, even those that should be remembered between sessions, such as “Have we already asked X from the enduser?”. To deal with different settings we recommend using the <a href="start.htm#_profile">profiles</a> instead or just set unneeded settings to NULL. More details can be found <a href="start.htm#_New_settings_not">here</a>.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is false.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_profile"></a><span style='font-size:12.0pt'>profile</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>By default all settings are remembered by the webphone depending on your html document full URI (full path).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>However if you specify a value for this profile parameter, then the settings will be stored in a storage named root path + profile name.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example if you deploy a webphone to </span><a href="https://domain.com/path1"><span style='line-height:120%; font-style:normal'>https://domain.com/path1</span></a><span style='line-height: 120%;font-style:normal'> and a separate webphone to </span><a href="https://domain.com/path2"><span style='line-height:120%;font-style:normal'>https://domain.com/path2</span></a><span style='line-height:120%;font-style:normal'> then the settings of these two webphones will be stored separately.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If you set the profile parameter to “myprofile1” for both webphones, then they will use the same settings storage (at domain.com_myprofile1).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also switch the settings with this parameter. For example if your webphone is hosted at </span><a href="https://domain.com/pathX"><span style='line-height:120%;font-style:normal'>https://domain.com/pathX</span></a><span style='line-height:120%;font-style:normal'> then you might create two separate profile. Sometime you might set the profile to “profileA” and sometime to “profileB”. This way you can use the webphone with unrelated settings and you can be sure that the settings will never mismatch.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty (which means settings bound to the webphone location full path).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node67" id="node67"></a><span style='font-size:12.0pt'>extra webrtc options</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Among the mentioned ice/turn/stun related settings, you can now specify the following additional webrtc options for the peer connection object: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>bundlePolicy </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>iceCandidatePoolSize</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>iceTransportPolicy</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>rtcpMuxPolicy.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>More details can be found </span><a href="https://developer.mozilla.org/en-US/docs/Web/API/RTCConfiguration"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_loglevel"></a><span style='font-size:12.0pt'>loglevel</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Tracing level. Values from 1 to 5.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Log level <span style='color:#984806'>5</span> means a full log including SIP signaling. Higher log levels should be avoided, because they can slow down the softphone.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Loglevel above <span style='color:#984806'>5</span> is meant only for Mizutech developers and might slow down the webphone (includes also RTP packets).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Do not set to <span style='color:#984806'>0</span> because that will disable also the important notifications presented for the users.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Recommended values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;color:#984806;font-style:normal'>1</span><span style='line-height:120%;font-style:normal'>: minimal logs for production</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;color:#984806;font-style:normal'>5</span><span style='line-height:120%;font-style:normal'>: detailed logs for tests</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>More details about logs can be found </span><a href="start.htm#_How_to_get"><span style='line-height:120%;font-style:normal'>here</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>There is also a <span style='color:#984806'>maxloglevel</span> parameter which you can use to prevent users to set the log level above this predefined value.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node68" id="node68"></a><span style='font-size:12.0pt'>logtoconsole</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify whether to send logs to console.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>true: will output all logs to console (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>false: will output only level 1 (important events also displayed for the user)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The amount of logs depends on the “loglevel” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is: true</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node69" id="node69"></a><span style='font-size:12.0pt'>NS and Java extra settings</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>With the NS and Java engines you can also use any parameters supported by the Mizu JVoIP SDK as listed in the </span><a href="https://www.mizu-voip.com/Portals/0/Files/JVoIP.pdf"><span style='line-height:120%;font-style:normal'>JVoIP documentation</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(Unrecognized parameters will be skipped if the WebRTC engine is used)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665520"></a><a name="_Call_divert"></a><a name="_Call_divert_and"></a><span style='font-size:12.0pt'>Call divert and other settings</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>These parameters are used for call auto-answer, forward, transfer, voicemail, number rewrite and similar tasks:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_callto"></a><span style='font-size:12.0pt'>callto</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone can initiate call on startup if this is set. It can be used to implement click to call or similar functionality.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can be any phone number, username, extension number or full SIP URI acceptable by your VoIP server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_autoaction"></a><span style='font-size:12.0pt'>autoaction</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Useful for click-to-call to specify what to do if you pass the “callto” parameter</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'>0: Nothing (do nothing, just preset the destination number; the user will have to initiate the call/chat)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>1: call (default. Will auto start the call to “callto” –auto-call)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>2: chat (will show the chat user interface presenting a chat session with “callto”)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>3: video call (will auto start a vide call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>You can achieve the same (and more flexible) behavior also via the API. For example just initiate a call (by using the Call function) once the webphone is registered.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Some more advanced SIP settings can be found in the “Engine related settings” below (such as dtmfmode, transport or codec).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node70" id="node70"></a><span style='font-size:12.0pt'>voicemailnum</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Specify the voicemail number (which the user can call to hear its own voicemails) if any.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Most PBX servers will automatically send the voicemail access number so usually this is detected automatically.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Default value is empty (auto-detect).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node71" id="node71"></a><span style='font-size:12.0pt'>normalizenumber</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Normalize called telephone numbers. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If the dialed number looks like a phone number (at least 5 number digits and no a-z, A-Z or @ characters and length between 5 and 20) then will drop all special characters leaving only valid digits (numbers, *, # and + at the beginning).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-1: auto</span><span style='font-style: normal'> (usually defaults to 1 yes, except if our username also contains special characters)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no, don’t normalize</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: yes, normalize (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node72" id="node72"></a><span style='font-size:12.0pt'>techprefix</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Add any prefix for the called numbers.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node73" id="node73"></a><span style='font-size:12.0pt'>numpxrewrite</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Called number prefix rewrite.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>In case if you need to rewrite numbers after your dial plan on the client side, you can use the numpxrewrite parameter (although these kind of number rewrite are usually done after server side dial plan):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can set multiple rules separated by semicolon. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Each rule has 4 parameters, separated by comma: prefix to rewrite, rewrite to, min length, max length</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;color:#984806;font-style:normal'>‘74,004074,8,10;+,001,7,14;',</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'>This will rewrite the 74 prefix in all numbers to 004074 if the number length is between 8 and 10. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in'><span style='line-height:120%;font-style:normal'>Also it will rewrite the + prefix in all numbers to 001 if the number length is between 7 and 14.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: this parameter is same with numrewriterules or the old filters parameter</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node74" id="node74"></a><span style='font-size:12.0pt'>blacklist</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Block incoming communication (call, chat and others) from these users. (username/numbers/extensions separated by comma).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_callforwardonbusy"></a><span style='font-size:12.0pt'>callforwardonbusy</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify a number where incoming calls should be forwarded when the user is already in a call. (Otherwise the new call alert will be displayed for the user or a message will be sent on the JS API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_callforwardonnoanswer"></a><span style='font-size:12.0pt'>callforwardonnoanswer</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Forward incoming calls to this number if not accepted or rejected within 15 seconds. You can modify this default 15 second timeout with the </span><span style='font-style:normal'>callforwardonnoanswertimeout setting.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node75" id="node75"></a><span style='font-size:12.0pt'>callforwardalways</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify a number where ALL incoming calls should be forwarded. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_calltransferalways"></a><span style='font-size:12.0pt'>calltransferalways</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify a number where ALL incoming calls should be transferred to. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This might be used if your server doesn’t support call forward (302 answers) otherwise better to set this on server side because the call will not reach the webphone when it is offline/closed, so no chance for it to forward the call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node76" id="node76"></a><span style='font-size:12.0pt'>autoignore</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to ignore all incoming calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: don’t ignore</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: silently ignore</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: reject</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 0.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_autoaccept"></a><span style='font-size:12.0pt'>autoaccept</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to true to automatically accept all incoming calls (auto answer).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: the calls are also auto accepted if the received INVITE contains the “<span style='color:#984806'>x-p-auto-answer: normal</span>" or "<span style='color:#984806'>x-answer-mode: auto</span>” SIP header.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node77" id="node77"></a><span style='font-size:12.0pt'>acceptcall_onsharedevice</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify whether to auto accept incoming calls when the user clicks to enable device sharing for WebRTC (the audio device permission browser popup)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no (Do nothing. The user will have to click the “Accept” button to accept the incoming call or you must call the accept() API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: auto (Auto accept when possible –if detected share device click)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: always (Always accept webrtc call on browser share device click)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_beeponincoming"></a><span style='font-size:12.0pt'>beeponincoming</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Will play a short sound on incoming calls. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: Yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: this is not the ringtone.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node78" id="node78"></a><span style='font-size:12.0pt'>beeponconnect</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Will play a short sound when calls are connected</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: Disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: For auto accepted incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: For incoming calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: For outgoing calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: For all calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 0</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node79" id="node79"></a><span style='font-size:12.0pt'>redialonfail</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Retry the call on failure or no response.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_rejectonbusy"></a><span style='font-size:12.0pt'>rejectonbusy</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to true to automatically reject (disconnect) incoming call if a call is already in progress.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is false.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_disablesamecall"></a><span style='font-size:12.0pt'>disablesamecall</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify whether to enable (possible accidental) outgoing call to a number where there is already a call in progress.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This might happen as a result of API misuse or by user double-click on the call button.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 1 to reject such kind of second call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 0 to disable this verification and enable all calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node80" id="node80"></a><span style='font-size:12.0pt'>allowcallredirect</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 1 to auto-redial on 301/302 call forward.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 0 to disable auto call forward.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node81" id="node81"></a><span style='font-size:12.0pt'>holdtype</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Specify how the call hold function should work:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>-2=no (will ignore hold requests)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>-1=auto (defaults to 2)<br> 0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>1=not used</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>2=hold (standard hold by sending “a=sendonly”)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>3=other party hold (will send “a=recvonly”)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>4=both in hold (will send “a=inactive”)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node82" id="node82"></a><span style='font-size:12.0pt'>defmute</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default mute direction:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: mute out (speakers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: mute in (microphone)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: both</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5: disable mute</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node83" id="node83"></a><span style='font-size:12.0pt'>muteholdalllines</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Auto Mute/Hold all call legs on conference calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_automute"></a><span style='font-size:12.0pt'>automute</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify if other lines will be muted on new call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=on incoming call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=on outgoing call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=on incoming and outgoing calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4=on other line button click</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_autohold"></a><span style='font-size:12.0pt'>autohold</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify if other lines will be put on hold on new call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=on incoming call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=on outgoing call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=on incoming and outgoing calls</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4=on other line button click</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node84" id="node84"></a><span style='font-size:12.0pt'>audiodevicein</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Audio device name for recording (microphone). Set to a valid device name or “Default” which would select the system default audio device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: this is usually set at run-time from the API or from an audio device select control presented to the users (already implemented by the softphone skin). If not set, then the webphone will use the OS default recording device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node85" id="node85"></a><span style='font-size:12.0pt'>audiodeviceout</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Audio device name for playback (speaker). Set to a valid device name or “Default” which would select the system default audio device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: this is usually set at run-time from the API or from an audio device select control presented to the users (already implemented by the softphone skin). If not set, then the webphone will use the OS default playback device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node86" id="node86"></a><span style='font-size:12.0pt'>audiodevicering</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Audio device name for ringtone. Set to a valid device name or “Default” which would select the system default audio device. You can also set it to “All” to have the ringtone played on all devices.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: this is usually set at run-time from the API or from an audio device select control presented to the users (already implemented by the softphone skin). If not set, then the webphone will use the OS default playback device. Separate ringer device selection is not available with the WebRTC engine.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_volumein"></a><span style='font-size:12.0pt'>volumein</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default microphone volume in percent from 0 to 100. 0 means muted. 100 means maximum volume.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is the audio input volume which are going to be streamed to the other end.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 50% (not changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The default volume level is determined by the OS volume setting. The webphone volume changes will be only relative to the OS settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The result volume level might be affected by the AGC if it is enabled.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Some browsers doesn’t expose volume change functionality if you are using the WebRTC engine</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node87" id="node87"></a><span style='font-size:12.0pt'>volumeout</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default speaker volume in percent from 0 to 100. 0 means muted. 100 means maximum volume.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is the audio output volume heard by the local user from the incoming audio stream sent by the other party.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 50% (not changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The default volume level is determined by the OS volume setting. The webphone volume changes will be only relative to the OS settings</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The result volume level might be affected by the AGC if it is enabled.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Some browsers doesn’t expose volume change functionality if you are using the WebRTC engine</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_volumering"></a><span style='font-size:12.0pt'>volumering</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default ringback volume in percent from 0 to 100. 0 means muted. 100 means maximum volume, 0 is muted.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 50% (not changed)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: there is no separate ring device for WebRTC (this is not a webphone limitation, but current browsers doesn’t expose such functionality for WebRTC)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_androidspeaker"></a><span style='font-size:12.0pt'>androidspeaker</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Control the default playback device on Android phones and tablets.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: default (most Android smartphones will use the loudspeaker by default as the playback device)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: switch to speakerphone before the first call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: switch to speakerphone before after first call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: switch to speakerphone at start</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default: 1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>You can also use the </span><a href="start.htm#_setloudspeaker_(set)"><span style='line-height:120%'>setloudspeaker</span></a><span style='line-height:120%'> API to change it at runtime.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>There is no similar setting for iOS, because changing an audio device requires "setSinkId()" which is not supported even by the latest versions of Safari.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_transfertype"></a><span style='font-size:12.0pt'>transfertype</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify transfer mode for native SIP.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1=default transfer type (same as 6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=call transfer is disabled</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=transfer immediately and disconnect with the A user when the Transf button is pressed and the number entered (unattended/blind transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2=transfer the call only when the second party is disconnected (attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3=transfer the call when the VoIP phone is disconnected from the second party (attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4=transfer the call when any party is disconnected except when the original caller was initiated the disconnect (attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5=transfer the call when the VoIP phone is disconnected from the second party. Put the caller on hold during the call transfer (standard attended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>6=transfer the call immediately with hold and watch for notifications (unattended transfer)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1 (which is the same as 6)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Unattended means simple immediate transfer (just a REFER message sent)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Attended transfer means that there will be a consultation call first</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If you have any incompatibility issue, then set to 1 (unattended is the simplest way to transfer a call and all sip server and device should support it correctly)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>Only unattended/blind transfer is supported between SIP and WebRTC (if one endpoint is using native SIP while the other is on WebRTC)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%'>More details can be found </span><a href="start.htm#_Transfer_API_usage"><span style='font-size:9.0pt; line-height:120%'>here</span></a></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node88" id="node88"></a><span style='font-size:12.0pt'>transfwithreplace</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify if replace should be used with transfer so the old call (dialog) is not disconnected but just replaced.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This way the A party is never disconnected, just the called party is changed. The A party must be able to handle the replace header for this.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1=auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=no (will create a separate call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=yes (smooth transfer, but not supported by some servers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node89" id="node89"></a><span style='font-size:12.0pt'>changesptoring</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If to treat session progress (183) responses as ringing (180). This is useful because some servers never sends the ringing message, only a session progress and might not start to send in-band ringing (or some announcement). In this circumstances the webphone can generate local ringback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The following values are defined:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: do nothing (no ringback on session progress message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> Will not call startRingbackTone() on 183 (only for 180)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: change status to ring</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: start local ring if needed and be ready to accept media (which is usually a ringtone or announcement and will stop the locally generated ringback once media received)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> Will call startRingbackTone() on 180 and 183 but stop on early media receive.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: start media receive and playback (and media recording if the “earlymedia” parameter is set)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: change status to ringing and start media receive and playback (and media recording if the “earlymedia” parameter is set to true)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5: play early ringback and don’t stop even if incoming early media starts</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> Will call startRingbackTone() on 180 and 183 and do NOT stop on early media receive.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 2.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>*Note: on ringing status the web phone is able to generate local ringback tone. However with the default settings this locally generated ringtone playback is stopped immediately when media is started to be received from the server (allowing the user to hear the server ringback tone or announcements)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_ringtimeout"></a><span style='font-size:12.0pt'>ringtimeout</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Maximum ring time allowed in millisecond.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 90000 (90 second)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also set separate ring timeout for incoming and outgoing calls with the “ringtimeoutin” and “ringtimeoutout” settings.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node90" id="node90"></a><span style='font-size:12.0pt'>calltimeout</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Maximum speech time allowed in millisecond.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 10800000 (3 hours)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node91" id="node91"></a><span style='font-size:12.0pt'>mediatimeout</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>RTP timeout in seconds to protect again dead sessions.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Calls will be disconnected if no media packet is sent and received for this interval.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might increase the value if you expect long call hold or one way audio periods.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 0 to disable call cut off on no media.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is 300 (5 minute).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>At the beginning of the calls, the half of the mediatimeout value is applied (2.5 minute by default if there was no incoming audio at all).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node92" id="node92"></a><span style='font-size:12.0pt'>bargeinheader</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can barge-in or spy on the calls by sending a specific SIP header specified by the “bargeinheader” parameter available for NS and Java engines.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example if you specify the value as “X-barge: yes”, then when your server sends this in the INVITE, the call will be auto-accepted and hidden joining a conference with all calls made by the user/agent.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty (disabled).</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_voicerecupload"></a><span style='font-size:12.0pt'>voicerecupload</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Voice record upload URL (FTP or HTTP).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>With this setting you can setup VoIP call recording (voice recording).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default value is empty (no voice call recording).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If set then calls will be recorded and uploaded to the specified ftp or http address in pcm/wave, gsm, mp3 or ogg format.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#C00000'>Note: mp3 support is not included by default in the NS engine to minimize the package size. Contact Mizutech to include this in your build if you need mp3 recording also from the NS engine</span><span style='line-height:120%;color:gray'> (build option voicerecformat=3;)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#C00000'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The files can be uploaded to </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>your FTP server (any </span><a href="https://filezilla-project.org/"><span style='line-height: 120%;font-style:normal'>FTP server</span></a><span style='line-height:120%; font-style:normal'> with specified user login credentials) </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>or to your HTTP server using HTTP PUT or multipart/form-data POST (in this case you need a server side script to save the uploaded data to file)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The following keywords can be used in the file name as these will be replaced automatically at runtime to their respective values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>DATETIME: will be replaced to current date-time</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>DATE: will be replaced to current date (year/month/day)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>TIME: will be replaced to current time (hour/min/sec)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>CALLID: will be replaced to sip call-id</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>USER: will be replaced to local user name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>CALLER: will be replaced to caller party name (caller id)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>CALLED: will be replaced to callee party name</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>SERVER: the domain or IP of the SIP server</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>COUNTER: an auto-increasing number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If you set a HTTP URI, then the following headers will be also set in the HTTP PUT or POST: X-type, X-filename, X-user, X-caller, X-called, X-callid and X-server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>We recommend to use FTP first (or try this first) as this is very easy to configure and doesn’t require any server side script</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='line-height:120%;font-style:normal'>FTP Example:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a href="ftp://user01:pass1234@ftp.foo.com/voice_DATETIME_CALLER_CALLED"><span style='line-height:120%;font-style:normal'>ftp://user01:pass1234@ftp.foo.com/voice_DATETIME_CALLER_CALLED</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also suggest a particular file format by appending its extension to the file name (for example .wav or .mp3).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example: </span><a href="ftp://user01:pass1234@ftp.foo.com/voice_DATETIME_CALLER_CALLED.wav"><span style='line-height:120%;font-style:normal'>ftp://user01:pass1234@ftp.foo.com/voice_DATETIME_CALLER_CALLED.wav</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:black;font-style:normal'>Since the username:password is part of the URI here, no special characters are allowed in the file path (don’t use ftp accounts with characters like @ ; ‘ “ / \ in the username or in the password).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><b><span style='line-height:120%;font-style:normal'>HTTP Example:</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#984806;font-style:normal'>http://www.foo.com/myfilehandler.php/filename=callrecord_CALLID</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also suggest a particular file format by appending its extension to the file name (for example .wav or .mp3).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>For example: <span style='color: #984806'>http://www.foo.com/myfilehandler.php?filename=callrecord_DATETIME_USER.wav</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example HTTP POST header packet if you set the url to “<span style='color:#984806'>http://yourdomain.com/myapi/voicerecord/anyentry?filename=callrecord_DATE_CALLID.mp3</span><span style='color:#1F497D'>”:</span><span style='color:#984806'><br> <br> </span></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>POST /myapi/voicerecord/anyentry?filename=callrecord_2020_02_12_xxx.mp3 HTTP/1.1</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>Host: yourdomain.com</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>User-Agent: webphone</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>Accept: */*</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>X-type: fileupload</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>X-filename: callrecord_2020_02_12_xxx.mp3</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>X-user: local_username</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>X-caller: caller_party</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>X-called: called_party</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>X-callid: sip_callid</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>X-server: your_sip_server_address</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>Content-Length: 18623</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>Expect: 100-continue</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>Content-Type: multipart/form-data; boundary=------------------------fde9999399e1b8eb</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>--------------------------fde9999399e1b8eb</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>Content-Disposition: form-data; name="file"; filename="callrecord_2020_02_12_xxx.mp3"</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>Content-Type: application/octet-stream</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='font-size:7.0pt; line-height:120%;color:#984806;font-style:normal'>.....</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You will receive “file” as the form name parameter and the name of the file as the form data “filename” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(So you will receive the file name as both the “filename” form parameter and also in the X-filename HTTP header).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The content type can be application/octet-stream, audio/x-wav, audio/mpeg, audio/x-gsm or audio/ogg.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(Regardless of the suggested file name, you can save the files on your server with any name, this is your choice).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>A working example for PHP can be downloaded from </span><a href="https://www.mizu-voip.com/Portals/0/Files/voicerechandler.txt"><span style='line-height:120%;font-style:normal'>here</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>More details about handling HTTP file upload: </span><a href="https://stackoverflow.com/questions/10320232/how-to-accept-a-file-post"><span style='line-height:120%;font-style:normal'>C#</span></a><span style='line-height: 120%;font-style:normal'>, </span><a href="https://www.hanselman.com/blog/ABackToBasicsCaseStudyImplementingHTTPFileUploadWithASPNETMVCIncludingTestsAndMocks.aspx"><span style='line-height:120%;font-style:normal'>ASP.NET</span></a><span style='line-height:120%;font-style:normal'>, </span><a href="http://php.net/manual/en/features.file-upload.php"><span style='line-height:120%;font-style:normal'>.PHP</span></a><span style='line-height:120%;font-style:normal'>, </span><a href="https://www.w3schools.com/nodejs/nodejs_uploadfiles.asp"><span style='line-height:120%;font-style:normal'>NodeJS</span></a><span style='line-height:120%;font-style:normal'>, </span><a href="https://www.tutorialspoint.com/servlets/servlets-file-uploading.htm"><span style='line-height:120%;font-style:normal'>Java</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>You can also use the </span><a href="start.htm#_voicerecord_(start,_url)"><span style='line-height:120%'>voicerecord</span></a><span style='line-height:120%'> API to turn on/off the voice recording at runtime (if not all calls have to be recorded)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>The voicerecord API should be called before the call you wish to record as changing the recording state during the calls might not be supported</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>With the NS or Java engine you can also record to local file. For this, you need to set the voicerecording parameter which has the following values defined: 0=no, 1=record to local file system, 2=remote http/ftp only, 3=both local and remote</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>If you are using the WebRTC engine with FTP voice file storage, avoid using special characters in the ftp username/password</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>Ogg/vorbis format can be also used with NS or Java engines (this is not supported by WebRTC)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%'>If you are using the NS engine with built-in JVM then HTTPS upload might not work (old tiny version of the JVM might not implement the latest TLS protocols). In this case you can still use HTTP or FTP storage (not HTTPS) or notify Mizutech to build with a new full JVM (will increase the size).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665521"></a><a name="_User_interface_related"></a><span style='font-size:12.0pt'>User interface related settings</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Most of these apply only to the Softphone user interface which is shipped with the webphone to further customize the web softphone user interface and behavior (Softphone.html)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node93" id="node93"></a><span style='font-size:12.0pt'>brandname</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Brand name of the softphone to be displayed as the title and at various other places such as SIP headers such as the User-Agent.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: purchased webphones always comes with a predefined brand name as you communicated to Mizutech. This brand must be a short unique name, with no special characters. You can overwrite the default with this setting if needed.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node94" id="node94"></a><span style='font-size:12.0pt'>companyname</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Your company name to be displayed in the about box and various other places.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node95" id="node95"></a><span style='font-size:12.0pt'>logo</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Displayed on login page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Can be text or an image name, ex: "logo.png" (image must be stored in images/folder) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Note: if you set a logo, then this will be placed on the softphone skin (softphone.html), taking up some space of its user interface. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Since the webphone is usually embedded in webpages, you might consider to place logo on other places of your website and not into the softphone skin itself.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_colortheme"></a><span style='font-size:12.0pt'>colortheme</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can easily change the skin of the supplied user interfaces with this setting (softphone, click to call).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-style: normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Default</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Light Blue</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Light Green</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Light Orange</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Light Purple</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>6.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Dark Red</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>7.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Yellow</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>8.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Blue</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>9.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Purple</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>10.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Turquoise</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%; font-style:normal'>11.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Light Skin</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='font-size:9.0pt;line-height:120%;font-style: normal'>12.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt;line-height:120%;font-style:normal'>Green Orange</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a href="start.htm#_User_interface_Skin/Design"><span style='line-height:120%;font-style: normal'>More details about design changes</span></a><span style='line-height: 120%;font-style:normal'>.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node96" id="node96"></a><span style='font-size:12.0pt'>language</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set the language for the user interface.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Two character language code (for example <span style='color:#984806'>en</span> for English or <span style='color:#984806'>it</span> for Italian).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>More details about localization can be found in the </span><a href="start.htm#_How_to_translate?"><span style='line-height: 120%;font-style:normal'>FAQ</span></a><span style='line-height:120%;font-style: normal'>.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_multilinegui"></a><span style='font-size:12.0pt'>featureset</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>User interface complexity level.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>0=minimal </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>5=reduced</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>10=full (default)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt'><span style='line-height:120%; font-style:normal'>15=more (for tech user)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You might set to 5 for novice users or if only basic call features have to be used.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 10.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node97" id="node97"></a><span style='font-size:12.0pt'>showserverinput</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This can be used to hide the server address setting from the user if you already preconfigured the server address in the </span><span style='font-style:normal'>webphone_config.js (“serveraddress” config option), so the enduser have to type only their username/password to use the softphone.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> 0: no (will hide the server input setting for the endusers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> 1: auto (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> 2: yes (will shot the server input setting for the endusers)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_useloginpage"></a><span style='font-size:12.0pt'>useloginpage</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Whether to use a simplified login page with username/password in the middle (instead of list style settings; old haveloginpage).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: auto (will auto set to 1 if featureset is Minimal, otherwise 0)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: only at first login</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is: -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:12.0pt;line-height:120%;font-family:"Cambria",serif; color:#943634'>autologin</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify when to skip the login page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1=Auto</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=Yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is: -1</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>More details can be found </span><a href="start.htm#_How_to_auto"><span style='line-height:120%'>here</span></a><span style='line-height:120%'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:12.0pt;line-height:120%;font-family:"Cambria",serif; color:#943634'>quick_access_list</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable recent important contact list on the main page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable (show only the dial pad)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: enable</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is: 1</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_chatsms"></a><span style='font-size:12.0pt'>textmessaging</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify text messaging mode (IM/chat/SMS/API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1: auto guess or ask (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: disable all</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: disable incoming messages and auto guess outgoing mode</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: disable message sending and auto guess incoming mode</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>3: API (if SMS API URI have been defined)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>4: reserved</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>5: VoIP SMS</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>6: VoIP IM/chat (SIP MESSAGE)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: the old haschat and chatsms parameters are deprecated now but still supported</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node98" id="node98"></a><span style='font-size:12.0pt'>showincomingchatas</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Define how to handle incoming chat messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: open/show chat window if not in call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: just set a notification</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 0.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node99" id="node99"></a><span style='font-size:12.0pt'>callparknumber</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Can be used to add call park and call pickup (will be sent as DTMF for call park and user need to call to pickup number to later reload the call from the same or other device).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>If set, then it will be displayed on the call page as an extra option.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node100" id="node100"></a><span style='font-size:12.0pt'>hasringcounter</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable the time counter during ring-time.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node101" id="node101"></a><span style='font-size:12.0pt'>hasfiletransfer</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to true to enable file transfer.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node102" id="node102"></a><span style='font-size:12.0pt'>filetransferurl</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>HTTP URI used for file transfer. By default Mizutech service is used which is provided for free with the web softphone.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_displaynotification"></a><span style='font-size:12.0pt'>displaynotification</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Show notifications in phone notification bar (usually on the top corner of your phone). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0:No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1:Yes (display missed call and missed chat notifications)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node103" id="node103"></a><span style='font-size:12.0pt'>displayvolumecontrols</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Always display volume controls when in call. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:8.0pt;line-height:120%'>Old/deprecated parameter name was “hasvolume”.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node104" id="node104"></a><span style='font-size:12.0pt'>displayaudiodevice</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Always display audio device when in call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is false.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node105" id="node105"></a><span style='font-size:12.0pt'>displayvideodevice</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Display video preview window on video device select: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values: 0 mean No(default), 1 means Yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>When set to 1, then a video preview will appear when you select a video device on the device form or via the devicepopup() API. This preview window can be closed by the user or it will be closed automatically after 10 seconds once the device form is closed.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node106" id="node106"></a><span style='font-size:12.0pt'>displaypeerdetails</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify where to display the information returned by </span><a href="start.htm#_Custom_HTTP_API"><span style='line-height:120%;font-style:normal'>scurl_displaypeerdetails</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>It can be used display details about the peers from your CRM such as full name, address or other details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(Useful in call-centers and for similar usage)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: show on call page (instead of contact picture)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: on new page</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>div id: display on the specified DIV element </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node107" id="node107"></a><span style='font-size:12.0pt'>savetocontacts</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Whether to (automatically) add new called numbers to your contact list.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0:No</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1:Ask</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2:Yes (will not ask for a contact name)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node108" id="node108"></a><span style='font-size:12.0pt'>messagepopup</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Display custom popup for user once.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_showtoasts"></a><span style='font-size:12.0pt'>showtoasts</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(boolean)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Enable/disable hint popups.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>true: show all toasts (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>false: don't show toasts and popup messages</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="OLE_LINK49"></a><a name="OLE_LINK48"></a><a name="_incomingcallpopup"></a><span style='font-size:12.0pt'>incomingcallpopup</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Whether to display a popup about incoming calls (uses the HTML5 notification API for WebRTC or native popup for NS/Java).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Possible values:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>0.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>No</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Auto (show only if browser window is not in foreground/focused)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Yes</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>Always force from all engines</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 0 to disable (in this case make sure that you handle the incoming call alert from your HTML/JS if required).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set the </span><a href="start.htm#_backgroundcalls"><span style='line-height:120%;font-style:normal'>callreceiver</span></a><span style='line-height:120%;font-style:normal'> parameter to 2 to catch incoming calls even when the webphone is not running.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-size:9.0pt;line-height:120%'>Note: The old name of this parameter name was hasincomingcallpopup and hasincomingcall</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The incoming call HTML5 popup can be optionally customized with the following parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>callnot_title (string) – the title of the notification. By default this is the brand name of the webphone.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>callnot_body (string) – the body text of the notification. By default this is: “Incoming call from: PEERNAME”</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>callnot_icon (string) – URL of the notification icon. By default this is: “notification_icon.png” from “images” directory.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>callnot_image (string) – URL of the notification image. By default this is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node109" id="node109"></a><span style='font-size:12.0pt'>closecall_timeout</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The call page will remain active after call hangup for this amount of time in milliseconds, after which it will close automatically. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set to 0 to disable. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 8000 (8 sec)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node110" id="node110"></a><span style='font-size:12.0pt'>header</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Header text displayed for users on top of softphone windows.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node111" id="node111"></a><span style='font-size:12.0pt'>footer</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Footer text displayed for users on the bottom of softphone windows. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node112" id="node112"></a><span style='font-size:12.0pt'>version</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Version number displayed for users. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty (will load the built-in version number)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node113" id="node113"></a><span style='font-size:12.0pt'>showsynccontactsmenu</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>This is to allow contact synchronization between mobile and desktop.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>-1=don't show</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0=show Sync option in menu and Contacts page (if no contacts available) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1=show in menu only</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is 1</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_defcontacts"></a><span style='font-size:12.0pt'>defcontacts</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Set one or more contacts to be displayed by default in the contact list. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Contact fields: name, number, email, address, notes, website</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Fields must be separated by comma and contacts separated by semicolon:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example: <span style='color:#984806'>defcontacts: 'John Doe,12121;Jill Doe,231231,jill@g.com'</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: Contacts can be added also at runtime using the </span><a href="start.htm#_addcontact_(fullname,_number,"><span style='line-height:120%'>addcontact</span></a><span style='line-height:120%'> API.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_disableoptions"></a><span style='font-size:12.0pt'>disableoptions</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>List of settings options and features to be disabled or hidden.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>To disable entire features, use the upper case keywords such as <span style='color:#984806'>CHAT,VIDEO,VOICEMAIL,CONFERENCE.</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:black;font-style:normal'>To disable settings, use the setting label or name such as </span><span style='line-height:120%; color:#984806;font-style:normal'>Audio device, Call forward.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example: <span style='color:#984806'>disableoptions: 'theme,email,Call forward,callforwardonbusy,callforwardonnoanswer,callforwardalways,VIDEO'</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:black;font-style:normal'>Other examples:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:#984806;font-style:normal'>"chatsms,disablewbforpstn,audiorecorder,audioplayer,speakerphoneplayer,useroutingapi,callback_mode,transfertype,transfwithreplace,balance_uri,rating_uri,creditrequest,ratingrequest,p2p_uri,p2p,callback_uri,callback,sms_uri,sms,</span><span style='font-size:11.0pt;line-height:120%'> </span><span style='line-height: 120%;color:#984806;font-style:normal'>disablecontactmenu";</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:black;font-style:normal'>You can also disable main pages:</span><span style='line-height:120%;color:#984806;font-style:normal'> PAGE_MAIN, PAGE_CONTACTS, PAGE_HISTORY, RECENTS</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node114" id="node114"></a><span style='font-size:12.0pt'>extraoption</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(string)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Custom parameters can be set in a key-value pair list, separated by semicolon Ex: displayname=John; </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Default is empty.</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node115" id="node115"></a><span style='font-size:12.0pt'>logsendto</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Specify allowed actions on the logs page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>0: no options (users will still be able to copy-paste the logs)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>1: upload (default)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>2: email launch (the email address set by the “supportmail” parameter or </span><a href="mailto:support@mizu-voip.com"><span style='line-height:120%;font-style: normal'>support@mizu-voip.com</span></a><span style='line-height:120%; font-style:normal'> if not set)</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_links"></a><span style='font-size:12.0pt'>links</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(strings)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>The webphone GUI can load additional information from your web server application or display some content from your website internally in a WebView or frame. You can integrate the included softphone user interface with your website and/or VoIP server HTTP API (if any) by using the following parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>advertisement: </span></b><span style='line-height:120%;font-style:normal'>Advertisement URL, displayed on bottom of the softphone windows.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>supportmail: </span></b><span style='line-height:120%;font-style:normal'>Company support email address. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>supporturl: </span></b><span style='line-height:120%;font-style:normal'>Company support URL. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>newuser: </span></b><span style='line-height:120%;font-style:normal'>New user registration http request OR link (if API then suffix with star *)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>forgotpasswordurl: </span></b><span style='line-height:120%;font-style:normal'>Will be displayed on login page if set.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>homepage: </span></b><span style='line-height:120%;font-style:normal'>Company home page link. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>accounturi: </span></b><span style='line-height:120%;font-style:normal'>Company user account page link. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>recharge: </span></b><span style='line-height:120%;font-style:normal'>Recharge http request (pin code must be sent) or link. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>p2p: </span></b><span style='line-height:120%;font-style:normal'>Phone to phone http request or link. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>callback: </span></b><span style='line-height:120%;font-style:normal'>Callback http request or link (For example: <span style='color:#984806'>*https://yourdomain.com/callback?user=USERNAME</span>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>sms: </span></b><span style='line-height:120%;font-style:normal'>SMS http request. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>creditrequest: </span></b><span style='line-height:120%;font-style:normal'>Balance http request, result displayed to user. (For example: <span style='color:#984806'>*https://yourdomain.com/balance?user=USERNAME</span>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>ratingrequest: </span></b><span style='line-height:120%;font-style:normal'>Rating http request, result displayed for user on call page. (For example: <span style='color:#984806'>*http://yourdomain.com/rating?destination=CALLEDNUMBER</span>)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>helpurl: </span></b><span style='line-height:120%;font-style:normal'>Company help link. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>licenseurl: </span></b><span style='line-height:120%;font-style:normal'>License agreement link. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>extramenuurl: </span></b><span style='line-height:120%;font-style:normal'>Link specifying custom menu entry. Will be added to main page (dialpad) menu. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>extramenutxt: </span></b><span style='line-height:120%;font-style:normal'>Title of custom menu entry. Will be added to main page (dialpad) menu. </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='line-height:120%;font-style:normal'>serveraddressbook_url: </span></b><span style='line-height:120%;font-style:normal'>address book URL or API</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Parameters can be treated as <b>API requests </b>(specially interpreted) or <b>links</b> (to be opened in built-in webview). For http API request the value must begin with asterisk character: "*http://domain.com/...." For example if the "newuser" is a link, then it will be opened in a browser page; if it's an API http request (begins with *), then a form will be opened in the softphone with fields to be completed.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The followings are always treated as API request: creditrequest, ratingrequest</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The followings can be links OR API http requests: newuser, recharge, p2p, callback, sms</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>The rest will be treated always as links (opened in built-in webview or separate browser tab)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>You can also use keywords in these settings strings which will be replaced automatically by the web softphone. The following keywords are recognized:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>DEVICEID: unique identifier for the client device or browser</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>SESSIONID: session identifier</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>USERNAME: sip account username. preconfigured or entered by the user</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>PASSWORD: sip account password</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>CALLEDNUMBER: dialed number</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>PEERNUM: other party phone number or SIP uri</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>PEERDETAILS: other party display name and other available details</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>DIRECTION: 1=outgoing call, 2=incoming call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>CALLBACKNR,PHONE1, PHONE2: reserved</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>PINCODE: reserved. will be used in some kind of requests such as recharge</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>TEXT: such as chat message</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>STATUS: status messages: onAppStateChange, onRegStateChange, onCallStateChange, inChat, outChat</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>MD5SIMPLE: md5 (pUser + ":" + pPassword)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>MD5NORMAL: md5 (pUser + ":" + pPassword+":"+randomSalt)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in'><span style='line-height:120%;font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='line-height:120%;font-style:normal'>MD5SALT: random salt</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>Example credit http request: </span><a href="https://domain.com/balance/?user=%20USERNAME"><span style='line-height: 120%;font-style:normal'>https://domain.com/balance/?user= USERNAME</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>(Where “USERNAME” will be dynamically replaced with the currently logged in username)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%'>Note: Ensure that you have proper authentication for payable functions such as callback, p2p or sms. Some other functions can also affect user privacy, such as creditrequest. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665522"></a><a name="_Applet_parameter_security"></a><a name="_Parameter_security"></a><span style='font-size:12.0pt'>Parameter security</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>From security perspective the webphone can be treated as any other regular SIP endpoint: make sure to not reveal the password of your SIP accounts and your app will be secure.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Webphone parameters are safe by default since they are used only in the user http session. This means that the enduser can discover its own settings including the password, but other users –including users for the same browser or middle-men such as the ISP- will not be able to see the sensitive parameters if you are using secure http (HTTPS) and don’t statically set a SIP account password in your HTML, which could be discovered from your webpage source.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The only sensitive parameter is the SIP account “password”! This is sent only as digest hash in signaling, but make sure to never display or log from your code.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The easiest way to maintain maximum security is to allow the endusers to type their SIP password as needed, instead of hardcoding or provisioning.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You should not hardcode the password into your website (It should not be found if you check the source of your webpage in the browser. The only exception would be if you offer some free to call service which is not routed to outside paid trunks/carriers). If the password has to be preconfigured then load it via an ajax call or similar method; just make sure to use HTTPS in this case because otherwise all the communication is in clear text between the browser and your server if the page is running on unsecure HTTP. Otherwise just let the endusers to enter their password on a login/settings form and pass it to the webphone with the setsipheader() API call. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the password needs to be passed dynamically then:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>make sure to use HTTPS if it is sent from the server (for example via an AJAX or other API request)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>if you pass it from JavaScript, then you might encrypt or obfuscate it with your preferred method</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Please note that even if you pass the password around in clear text, you are still protected if your page is in secured (on HTTPS). Only the enduser might be able to found its own password from the browser in this case, but this is usually not a problem since the users should know their own password anyway (Or if somehow you don’t wish the enduser to known its own password then you can implement your own custom encryption or obfuscation in JavaScript)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There is no much reason to try to obfuscate or hide other parameters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example the “serveraddress” can be discovered anyway by analyzing the low level network traffic and this is perfectly normal. Most of the other parameters are completely irrelevant. Some sensitive information’s are also managed by the webphone (such as the user contact list) however these are stored only locally in the browser secure web storage or secure cookie by default (on HTTPS) and further encrypted or obfuscated by the webphone.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following methods can be used to further secure the webphone usage:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>set the loglevel to 1 (with loglevel 5 the password might be written in the logs)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>use strong passwords for all your SIP extensions or trunks</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>don’t hardcode the password if possible (let the users to enter it) or if you must hardcode it then use encryption and/or obfuscation</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>restrict the account on the VoIP server (for example if the webphone is used as a support access, then allow to call only your support numbers and disable outbound calls)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>set a maximum simultaneous call limit and rate limiter for your SIP accounts</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>instead of preconfigured parameters you can use the javascript VoIP api (setparameter)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>use HTTPS (secure http / TLS)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>encrypt/obfuscate the password in JavaScript code if you wish to hide it even from its owner or if you need to use a preconfigured account for your app</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:11.0pt;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>for </span><a href="https://www.mizu-voip.com/Portals/0/Files/WebPhoneParameterEncoding.pdf"><span style='font-style:normal'>parameter encoding</span></a><span style='font-style: normal'> (encryption/obfuscation) you can use XOR + base64 with your built-in key (ask from Mizutech), prefixed with the “encrypted__3__” string (you can verify your encryption with </span><a href="http://www.angelwatt.com/coding/character_translator.php"><span style='font-style:normal'>this tool</span></a><span style='font-style:normal'> using selecting XOR Base64 Encrypt)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:11.0pt;font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>you can quickly encrypt any parameter using this link:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>https://mnt.mizu-voip.com/mmexreqvitserverjrsktt/xwencode?wkey=YOURKEY&wstring=YOURSTRING&wversion=3</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Replace YOURKEY with your webphone key provided by mizutech. The key in the demo version is h39idbfqw7116ghh <br> Replace YOURSTRING with a parameter value (for example the password parameter). URI encode if contains special characters such as spaces. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>More details can be found </span><a href="https://www.mizu-voip.com/Portals/0/Files/WebPhoneParameterEncoding.pdf"><span style='font-style:normal'>here</span></a><span class="MsoHyperlink"><span style='font-style:normal'>.</span></span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>secure your VoIP server (account limits, rate-limits, balance limits, fraud detection) and follow the VoIP security best practices. For example </span><a href="https://www.mizu-voip.com/Portals/0/Files/VoIP_Server_Security.pdf"><span style='font-style:normal'>here</span></a><span style='font-style:normal'> you can find some details about mizu VoIP server security.<a name="_User_interface_Skin/Design"></a></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;padding:0in 0in 0in 0in;background:#F2DBDB'> <h1><a name="_Toc499665523"></a><a name="_JavaScript_API"></a><span style='font-size:12.0pt;line-height:112%'>JavaScript API</span></h1> </div> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc499665524"><span style='font-size: 12.0pt;line-height:112%'>About</span></a></h2> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use the webphone javascript library in multiple ways for many purposes:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>create your own web dialer</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>add click to call functionality to your webpage</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>add VoIP capability to your existing web project or website</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>integrate with any CRM, callcenter client or other projects</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>modify one of the existing projects to achieve your goal (see the included softphone and click to call examples) or create yours from scratch</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>and many others</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The public JavaScript API can be found in "webphone_api.js" file, under global javascript namespace "webphone_api".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To be able to use the webphone as a javascript VoIP library, just copy the webphone folder to your web project and add the webphone_api.js to your page.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc499665525"><span style='font-size: 12.0pt;line-height:112%'>Basic example</span></a></h2> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'><head></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'><!-- Include the webphone_api.js to your webpage --></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'><script src="webphone_api.js"></script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'></head></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'><body></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'><script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Wait until the webphone is loaded, before calling any API functions</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>webphone_api.onAppStateChange (function (state) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'> if (state === 'loaded')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'> { </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Set parameters (Replace upper case worlds with your settings)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter('serveraddress', SERVERADDRESS); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter('username', USERNAME); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter('password', PASSWORD); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter(‘other’, MYCUSTOMSETTING);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//See the “Parameters” section below for more options </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Start the webphone (optional but recommended) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.start();</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Make a call (Usually initiated by user action, such as click on a click to call button. Number can be extension, SIP username, SIP URI or mobile/landline phone) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.call(NUMBER); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//Hang-up (usually called from “disconnect” button click)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.hangup(); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> //Send instant message (Number can be extension, SIP username. Usually called from a “send chat” button) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.sendchat(NUMBER, MESSAGETEXT);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style: normal'>});</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-size:9.0pt;color:gray;font-style: normal'>//You should also handle events from the webphone and change your GUI accordingly (onXXX callbacks)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'></script></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'></body></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="https://www.mizu-voip.com/Portals/0/Files/webphone.zip"><span style='font-style:normal'>webphone</span></a><span style='font-style:normal'> package for more examples. You should check especially the tech demo (techdemo_example.html / techdemo_example.js).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: If you don’t have JavaScript/web development experience, you can still fully control and </span><a href="start.htm#_How_to_customize"><span style='font-size:9.0pt'>customize</span></a><span style='font-size:9.0pt'> the webphone:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>by its numerous configuration options which can be passed also as </span><a href="start.htm#_How_to_use"><span style='font-size:9.0pt'>URL parameters</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>from server side as </span><a href="start.htm#_Integration_with_server"><span style='font-size:9.0pt'>described here</span></a></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>we can also send ready to use fully customized web softphone with preconfigured settings, branding and integration with your web and VoIP server</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details can be found </span><a href="start.htm#_Development"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc499665526"></a><a name="_Functions"></a>Functions</h2> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Use the following API calls to control the webphone:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665527"></a><a name="_Toc489789087"></a><a name="_Toc468095538"></a><a name="_Toc463878874"></a><a name="_Toc463876845"></a><a name="_Toc463876695"></a><a name="_Toc463876489"></a><a name="_Toc463876026"></a><a name="_Toc455069991"></a><a name="_Toc449776630"></a><a name="_Toc440858268"></a><a name="_Toc434052787"></a><a name="_Toc434051129"></a><a name="_Toc432326338"></a><a name="_setparameter_(param,_value)"></a><span style='font-size:12.0pt'>setparameter (param, value)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to set the webphone parameters (the various settings which are described in the </span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>Parameters</span></a><span style='font-style:normal'> chapter) dynamically (at run-time) from JavaScript.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(Alternatively you can just hardcode the parameters in the webphone_config.js or pass by URL query parameters)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>setparameter(‘username’,’john’);</span><span style='color:#C0504D;font-style:normal'> </span><span style='color:gray; font-style:normal'>//this will set the SIP username to be used for upcoming registration or call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>All parameters are saved by the webphone so they will persist (except if you clear the browser storage and/or cookies). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>You can easily clear previously set values using the delsettings () API or by using the setparameter with an empty value. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>For example <span style='color:#984806'>setparameter(‘displayname’,’’);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665528"></a><a name="_Toc489789088"></a><a name="_Toc468095539"></a><a name="_Toc463878875"></a><a name="_Toc463876846"></a><a name="_Toc463876696"></a><a name="_Toc463876490"></a><a name="_Toc463876027"></a><a name="_Toc455069992"></a><a name="_Toc449776631"></a><a name="_Toc440858269"></a><a name="_Toc434052788"></a><a name="_Toc434051130"></a><a name="_Toc432326339"><span style='font-size:12.0pt'>getparameter (param)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return type: string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return value of a parameter if exists, otherwise will return empty string.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>var mystringvariable = getparameter(‘displayname’);</span><span style='color:#C0504D;font-style:normal'> </span><span style='color:gray;font-style:normal'>//this will return the display name if it was set previously</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665529"></a><a name="_Toc489789089"></a><a name="_Toc468095540"></a><a name="_Toc463878876"></a><a name="_Toc463876847"></a><a name="_Toc463876697"></a><a name="_Toc463876491"></a><a name="_Toc463876028"></a><a name="_Toc455069993"></a><a name="_Toc449776632"></a><a name="_Toc440858254"></a><a name="_Toc434052773"></a><a name="_Toc434051115"></a><a name="_Toc432326324"></a><a name="_start()"></a><span style='font-size:12.0pt'>start</span><span style='font-size:12.0pt'>()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Optionally you can "start" the phone, before making any other action. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In some circumstances the initialization procedure might take a few seconds (depending on usable engines) so you can prepare the webphone with this method to avoid any delay when the user really needs to use by pressing the call button for example. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set the “<span style='color:#984806'>autostart</span>” parameter to <span style='color:#984806'>0</span><span style='color:black'> </span>if you wish to use this function. Otherwise the webphone will start automatically on your page load.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the <span style='color:#984806'>serveraddress</span>/<span style='color:#984806'>username</span>/<span style='color:#984806'>password</span> is already set and auto <span style='color:#984806'>register</span> is not disabled (not <span style='color:#984806'>0</span>), then the webphone will also register (connect) to the SIP server upon start.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If <span style='color:#984806'>start()</span> is not called, then the webphone will initialize itself the first time when you call some other function such as <span style='color:#984806'>register()</span> or <span style='color:#984806'>call().</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone parameters should be set before you call this method (preset in the js file or by using the <span style='color:#984806'>setparameter()</span> function). See the “</span><a href="start.htm#_Main_Parameters"><span style='font-style:normal'>Parameters</span></a><span style='font-style:normal'>” section for details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665530"></a><a name="_Toc489789090"><span style='font-size:12.0pt'>stop()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Optionally you can "stop" the webphone engine (but this is done automatically on browser close or refresh, so not really needed). Calling the stop() API will also unregister.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665531"></a><a name="_Toc489789091"></a><a name="_Toc468095541"></a><a name="_Toc463878877"></a><a name="_Toc463876848"></a><a name="_Toc463876698"></a><a name="_Toc463876492"></a><a name="_Toc463876029"></a><a name="_Toc455069994"></a><a name="_Toc449776633"></a><a name="_Toc440858255"></a><a name="_Toc434052774"></a><a name="_Toc434051116"></a><a name="_Toc432326325"></a><a name="_register_()"></a><span style='font-size:12.0pt'>register ()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Optionally you can "register" if your SIP server has also registrar roles (most of them have this). This will "connect" to the SIP server by sending a REGISTER request and will authenticate if requested by the server (by sending a second REGISTER with the digest authorization details).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If the <span style='color:#984806'>serveraddress</span>/<span style='color:#984806'>username</span>/<span style='color:#984806'>password</span> is already set and auto <span style='color:#984806'>register</span> is not disabled (not <span style='color:#984806'>0</span>), then the webphone will register (connect) to the SIP server upon start, so no need to use this function in these circumstances.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>There is no need to call the register() multiple times as the webphone will automatically manage the re-registrations (based on the </span><a href="start.htm#_registerinterval"><span style='font-style:normal'>registerinterval</span></a><span style='font-style:normal'> parameter)</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665532"></a><a name="_Toc489789092"></a><a name="_registerex_(accounts)"></a><span style='font-size:12.0pt'>registerex (accounts)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to register with multiple SIP accounts (multi-account feature).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <span style='color:#984806'>accounts</span> are passed as string in the following format: <span style='color:#984806'>server,usr,pwd,ival,proxy,realm,authuser;server2,usr2,pwd2,ival2,proxy2,realm2,authuser2</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For more details read </span><a href="start.htm#_How_to_manage_1"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665533"></a><a name="_Toc489789093"></a><a name="_Toc468095542"></a><a name="_Toc463878878"></a><a name="_Toc463876849"></a><a name="_Toc463876699"></a><a name="_Toc463876493"></a><a name="_Toc463876030"></a><a name="_Toc455069995"></a><a name="_Toc449776634"><span style='font-size:12.0pt'>unregister ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Un-register from your SIP server (will send a REGISTER with Expire header set to 0, which means de-registration). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Unregister is called also automatically at browser close so usually there is no need to call this explicitly.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665534"></a><a name="_Toc489789094"></a><a name="_Toc468095543"></a><a name="_Toc463878879"></a><a name="_Toc463876850"></a><a name="_Toc463876700"></a><a name="_Toc463876494"></a><a name="_Toc463876031"></a><a name="_Toc455069996"></a><a name="_Toc449776635"></a><a name="_Toc440858256"></a><a name="_Toc434052775"></a><a name="_Toc434051117"></a><a name="_Toc432326326"></a><a name="_call_(number)"></a><span style='font-size:12.0pt'>call (number)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Initiate call to a number, extension, sip username or SIP URI.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Perhaps this is the most important function in the whole webphone API.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>It will automatically handle all the details required for call setup (network discover, ICE/STUN/TURN when needed, audio device open and call setup signaling).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>With this function you can make calls via your SIP server or SIP service provider:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>to any SIP endpoint (such as softphone or IP phone)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>to any WebRTC endpoint</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt; font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>to pstn/mobile/landline (if your server allows outbound calls. If you have a SIP subscription then most probably you need a positive balance to be able to make pstn calls)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-size:9.0pt;font-family: Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>to any SIP server (including IVR or callback access numbers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>You can also send dtmf messages once the call connected by appending it to the number after a comma. <span style='color:black'>For example if you make a call to 123,456 then it will call 123 and then it will send dtmf 456 once the call is connected.</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>The number parameter must be a string type!</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>For video chat use the </span><a href="start.htm#_videocall_(number)"><span style='font-size:9.0pt'>videocall</span></a><span style='font-size:9.0pt'> function mentioned below.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665537"></a><a name="_Toc489789097"></a><a name="_Toc468095545"></a><a name="_Toc463878881"></a><a name="_Toc463876852"></a><a name="_Toc463876702"></a><a name="_Toc463876496"></a><a name="_Toc463876033"></a><a name="_Toc455069998"></a><a name="_Toc449776636"></a><a name="_Toc440858257"></a><a name="_Toc434052776"></a><a name="_Toc434051118"></a><a name="_Toc432326327"><span style='font-size:12.0pt'>hangup ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Disconnect current call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Notes about line-management (in case if you are implementing a multi-line user interface, otherwise you don’t need to deal with line numbers):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If the line is set to -2 it will disconnect all active calls.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>If line is set to -1, then it will disconnect the call on the current line (default behavior).</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Otherwise it will disconnect the call on the specified line.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665538"></a><a name="_Toc489789098"></a><a name="_Toc468095546"></a><a name="_Toc463878882"></a><a name="_Toc463876853"></a><a name="_Toc463876703"></a><a name="_Toc463876497"></a><a name="_Toc463876034"></a><a name="_Toc455069999"></a><a name="_Toc449776637"></a><a name="_Toc440858258"></a><a name="_Toc434052777"></a><a name="_Toc434051119"></a><a name="_Toc432326328"></a><a name="_accept_()"></a><span style='font-size:12.0pt'>accept ()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Connect incoming call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665539"></a><a name="_Toc489789099"></a><a name="_Toc468095547"></a><a name="_Toc463878883"></a><a name="_Toc463876854"></a><a name="_Toc463876704"></a><a name="_Toc463876498"></a><a name="_Toc463876035"></a><a name="_Toc455070000"></a><a name="_Toc449776638"></a><a name="_Toc440858259"></a><a name="_Toc434052778"></a><a name="_Toc434051120"></a><a name="_Toc432326329"></a><a name="_reject_()"></a><span style='font-size:12.0pt'>reject ()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Disconnect incoming call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>(You can also use the <span style='color:#984806'>hangup()</span> function for this)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665540"></a><a name="_Toc489789100"></a><a name="_Toc468095548"></a><a name="_Toc463878884"></a><a name="_Toc463876855"></a><a name="_Toc463876705"></a><a name="_Toc463876499"></a><a name="_Toc463876036"></a><a name="_Toc455070001"></a><a name="_Toc449776639"><span style='font-size:12.0pt'>ignore ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Silently ignore incoming call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665541"></a><a name="_Toc489789101"></a><a name="_Toc468095549"></a><a name="_Toc463878885"></a><a name="_Toc463876856"></a><a name="_Toc463876706"></a><a name="_Toc463876500"></a><a name="_Toc463876037"></a><a name="_Toc455070002"></a><a name="_Toc449776640"></a><a name="_forward_(number)"></a><span style='font-size:12.0pt'>forward (number)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Forward incoming call to the specified <span style='color:#984806'>number</span> (phone number, username or extension).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For call forward to work, your SIP server and/or the caller endpoint must support the 301 and 302 response codes (Moved Temporarily/Permanently).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Forward should be used for incoming calls only when the call is not connected yet. Otherwise use transfer() to redirect connected calls.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The number parameter must be a string type!</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665542"></a><a name="_Toc489789103"></a><a name="_Toc468095551"></a><a name="_Toc463878888"></a><a name="_Toc463876859"></a><a name="_Toc463876709"></a><a name="_Toc463876503"></a><a name="_Toc463876040"></a><a name="_Toc455070005"></a><a name="_Toc449776643"></a><a name="_Toc440858264"></a><a name="_Toc434052783"></a><a name="_Toc434051125"></a><a name="_Toc432326334"><span style='font-size:12.0pt'>hold (state)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Hold current call. This will issue an UPDATE or a reinvite with the hold state flag in the SDP (sendrecv, sendonly, recvonly and inactive).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set state to <span style='color:#984806'>true</span> to put the call on hold or <span style='color:#984806'>false</span> to un-hold.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665543"></a><a name="_Toc489789102"></a><a name="_Toc468095550"></a><a name="_Toc463878887"></a><a name="_Toc463876858"></a><a name="_Toc463876708"></a><a name="_Toc463876502"></a><a name="_Toc463876039"></a><a name="_Toc455070004"></a><a name="_Toc449776642"></a><a name="_Toc440858263"></a><a name="_Toc434052782"></a><a name="_Toc434051124"></a><a name="_Toc432326333"><span style='font-size:12.0pt'>mute (state, direction)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Mute current call. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Pass true for the state to mute or false to un-mute.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <span style='color:#984806'>direction</span> can have the following values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>0: mute in and out </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 1: mute out (speakers)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 2: mute in (microphone) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665544"><span style='font-size: 12.0pt'>mutevideo (state, direction)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Disable/enable video(stream) during a video call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Pass true for the state to mute the video or false to un-mute.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <span style='color:#984806'>direction</span> can have the following values:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>0: mute in and out </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 1: mute remote</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 2: mute local</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665546"></a><a name="_Toc489789104"></a><a name="_Toc468095552"></a><a name="_Toc463878889"></a><a name="_Toc463876860"></a><a name="_Toc463876710"></a><a name="_Toc463876504"></a><a name="_Toc463876041"></a><a name="_Toc455070006"></a><a name="_Toc449776644"></a><a name="_Toc440858261"></a><a name="_Toc434052780"></a><a name="_Toc434051122"></a><a name="_Toc432326331"></a><a name="_transfer_(number)"></a><span style='font-size:12.0pt'>transfer (number)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Transfer current call to number which is usually a phone number or a SIP username. (Will use the REFER method after SIP standards).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The number parameter must be a string type.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the number parameter is empty string and there are two calls in progress, then it will transfer line A to line B.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can set the mode of the transfer with the </span><a href="start.htm#_transfertype"><span style='font-style:normal'>transfertype</span></a><span style='font-style:normal'> parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For call transfer to work, your SIP server and/or the caller endpoint must support the SIP REFER message (the standard SIP call transfer as specified in RFC 3515 and RFC 5589).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Transfer should be used for connected calls only. For not connected incoming calls you should use the forward() function to redirect the call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>More details can be found </span><a href="start.htm#_Transfer_API_usage"><span style='line-height:120%;font-style:normal'>here</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665547"></a><a name="_Toc489789105"></a><a name="_Toc468095553"></a><a name="_Toc463878890"></a><a name="_Toc463876861"></a><a name="_Toc463876711"></a><a name="_Toc463876505"></a><a name="_Toc463876042"></a><a name="_Toc455070007"></a><a name="_Toc449776645"></a><a name="_Toc440858260"></a><a name="_Toc434052779"></a><a name="_Toc434051121"></a><a name="_Toc432326330"></a><a name="_conference_(number,_add)"></a><span style='font-size:12.0pt'>conference (number, add)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Add/remove people to conference.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-number: the peer username/number or line number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-add: true if to add, false to remove</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If number is empty than will mix the currently running calls (interconnect existing calls if there is more than one call in progress).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If number is a number between 1 and 9 then it will mean the line number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Otherwise it will call the new number (usually a phone number or a SIP user name) and once connected will join with the current session.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> <span style='color: #984806'>call(‘999’);</span><span style='color:gray'> //normal call to 999</span></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>conference(‘1234’);</span><span style='font-style:normal'> <span style='color:gray'> //will call 1234 and add to conference (conference between local user + 999 + 1234)</span></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>conference(‘2’,false);</span><span style='font-style:normal'> <span style='color:gray'> //remove line 2 from conference</span></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>conference(‘’);</span><span style='font-style:normal'> <span style='color:gray'>//add all current calls to conference</span></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>conference(‘’,false);</span><span style='font-style:normal'> <span style='color:gray'>//destroy conference (but keep the calls on individual lines)</span></span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>setline(3); </span><span style='color:gray;font-style:normal'>//select the third line </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>hangup(); </span><span style='color:gray;font-style:normal'>//will disconnect the third line </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>setline(-2); </span><span style='color:gray;font-style:normal'>//select all lines</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#984806;font-style:normal'>hangup(); </span><span style='color:gray;font-style:normal'>//will disconnect all lines</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>-if number is empty and there are less than 2 active calls, then the conference function can’t be used (you can’t put one single active call into a conference)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>-NS and Java engines also has a local conference mixer thus they are more reliable for conferencing and doesn’t depend on any server/gateway/proxy side conference support. If your main use-case is conferencing then we recommend to force one of these engines instead of WebRTC. More details </span><a href="start.htm#_How_the_conference"><span style='font-size:9.0pt'>here</span></a><span style='font-size:9.0pt'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>-you can also use the webphone with your server conference rooms/conference bridge. In this way, there is no need to call this function (just make a normal call to your server conference bridge/room access number)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>-the number parameter must be a string type!</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665548"></a><a name="_Toc489789106"></a><a name="_Toc468095554"></a><a name="_Toc463878891"></a><a name="_Toc463876862"></a><a name="_Toc463876712"></a><a name="_Toc463876506"></a><a name="_Toc463876043"></a><a name="_Toc455070008"></a><a name="_dtmf_(msg)"></a><span style='font-size:12.0pt'>dtmf (msg)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send DTMF message by SIP INFO or RFC2833 method (depending on the "</span><a href="start.htm#_dtmfmode"><span style='font-style:normal'>dtmfmode</span></a><span style='font-style:normal'>" parameter).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Please note that the msg parameter is a string. This means that multiple dtmf characters can be passed at once and the webphone will streamline them properly. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The dtmf messages are sent with the protocol specified with the “dtmfmode” parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Use the space character to insert delays between the digits.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Valid dtmf characters in the passed string are the followings: 0,1,2,3,4,5,6,7,8,9,*,#,A,B,C,D,space.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .1in;line-height:normal'><span style='color:#984806;font-style:normal'>API_Dtmf(-2,"1");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .1in;line-height:normal'><span style='color:#984806;font-style:normal'>API_Dtmf(-2," 12 345 #");</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .1in;line-height:normal'><span style='color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:8.0pt;color:black'>Note: dtmf messages can be also sent by adding it to the called number after a comma. For example if you make a call to 123,456 then it will call 123 and then it will send dtmf 456 once the call is connected.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665549"></a><a name="_Toc489789107"></a><a name="_Toc468095555"></a><a name="_Toc463878892"></a><a name="_Toc463876863"></a><a name="_Toc463876713"></a><a name="_Toc463876507"></a><a name="_Toc463876044"></a><a name="_Toc455070009"></a><a name="_Toc449776646"></a><a name="_Toc440858265"></a><a name="_Toc434052784"></a><a name="_Toc434051126"></a><a name="_Toc432326335"><span style='font-size:12.0pt'>sendchat (number, msg)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send a chat message via SIP MESSAGE method as specified in </span><a href="https://www.ietf.org/rfc/rfc3428.txt"><span style='font-style:normal'>RFC 3428</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Number can be a phone number or SIP username/extension number (or whatever is accepted by your server).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The message can be clear ASCII or UTF-8 text or html encoded.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In order for IM to work your SIP server needs to support </span><a href="start.htm#_Chat_is_not"><span style='font-style:normal'>SIP MESSAGE</span></a><span style='font-style:normal'>. More details can be found </span><a href="start.htm#_Chat_is_not"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665550"></a><a name="_Toc489789108"></a><a name="_Toc468095556"></a><a name="_Toc463878893"></a><a name="_Toc463876864"></a><a name="_Toc463876714"></a><a name="_Toc463876508"></a><a name="_Toc463876045"></a><a name="_Toc455070010"></a><a name="_Toc449776647"><span style='font-size:12.0pt'>sendsms (number, msg, from)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Send a SMS message if your provider/server has support for SMS.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The number parameter can be any mobile number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The msg is the SMS text.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The from is the local user phone number and it is optional.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>SMS can be handled on your server by:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-converting normal chat message to SMS automatically if the destination is a mobile number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>-or via an HTTP API (you can specify this to the webphone as the “sms” parameter)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details can be found </span><a href="start.htm#_SMS"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node116" id="node116"></a><span style='font-size:12.0pt'>play (start, file, looping, toremotepeer)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Play sound file. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>At least wave (.wav) files (raw linear PCM) are supported in the following format: PCM SIGNED 8000.0 Hz (8 kHz) 16 bit mono (2 bytes/frame) in little-endian (128 kbits).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>start: (number) - 1 for start or 0 to stop the playback</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>file: (string) file name or full path</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>looping: (number) - 1 to repeat, 0 to play once</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>toremotepeer: (boolean) - stream the playback to the connected peer (Works with NS or Java; not implemented with the WebRTC engine)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665551"></a><a name="_Toc489789109"></a><a name="_Toc468095557"></a><a name="_Toc463878894"></a><a name="_Toc463876865"></a><a name="_Toc463876715"></a><a name="_Toc463876509"></a><a name="_Toc463876046"></a><a name="_Toc455070011"></a><a name="_voicerecord_(start,_url)"></a><span style='font-size:12.0pt'>voicerecord (start, url)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Start/stop voice recording at runtime.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set the start parameter to true for start or false to stop.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The url is the address where the recorded voice file will be uploaded as described by the </span><a href="start.htm#_voicerecupload"><span style='font-style:normal'>voicerecupload</span></a><span style='font-style:normal'> setting.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: You can also just set the “voicerecupload” parameter to have all calls recorded.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665535"></a><a name="_Toc489789095"></a><a name="_Toc468095544"></a><a name="_Toc463878880"></a><a name="_Toc463876851"></a><a name="_Toc463876701"></a><a name="_Toc463876495"></a><a name="_Toc463876032"></a><a name="_Toc455069997"></a><a name="_videocall_(number)"></a><span style='font-size:12.0pt'>videocall (number)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Initiate a video call to a number, extension, sip username or SIP URI.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;color:black;font-style:normal'>The WebRTC engine is required for video to work (the webphone will handle this automatically by switching to WebRTC on video request if it is available).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will failback to a simple voice call if you don’t have a camera device or video is not supported by the peer or by the server/gateway. It should always work between WebRTC endpoints if users has a camera device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the webphone is used as SDK (not via the “softphone.html”) and video feature have to be used, then you will have to add the following <div> element to your page as the container of the video that will be displayed:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'><div id="video_container"></div></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>The number parameter must be a string type!</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665536"></a><a name="_Toc489789096"><span style='font-size:12.0pt'>screenshare (number, screenid)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Initiate a screen sharing session with the user specified by the number parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>number: the peer number, username, extension or SIP URI</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>screenid: optional parameter to pass the screen id (It might be useful for some special use-case when you acquire the screen-id via external tools such as the Chrome OS desktop capture API)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Notes: </p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>The number parameter must be a string type!</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>Special permissions might be needed. See also the <a href="start.htm#_screensharing">screensharing</a> parameter for details.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665545"><span style='font-size: 12.0pt'>stopscreenshare ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Stop screen sharing.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665552"><span style='font-size: 12.0pt'>setvideodisplaysize (type,width, height)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Use this function to control the video display size (both for remote and local video).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Accepted parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>type: 1=for remote video container, 2=for local video container</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>width: integer value of width in pixels</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>height: integer value of height in pixels; this parameter can be left empty or null, and the height will be set depending on the video's aspect ratio</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details can be found in webphone_api.js and video.css file respectively (You can also set the size in the video.css file).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665553"><span style='font-size: 12.0pt'>devicepopup ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Open audio/video device selector dialog (built-in user interface)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665554"></a><a name="_Toc489789111"></a><a name="_Toc468095559"></a><a name="_Toc463878896"></a><a name="_Toc463876867"></a><a name="_Toc463876717"></a><a name="_Toc463876511"></a><a name="_Toc463876048"></a><a name="_Toc455070013"><span style='font-size:12.0pt'>getdevicelist(dev, callback)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function and pass a callback, to receive a list of all available audio devices.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For the dev parameter pass 0 for recording device names list, 1 for the playback or ringer devices or 3 for video camera devices.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="OLE_LINK15"></a><a name="OLE_LINK14"></a><a name="OLE_LINK17"></a><a name="OLE_LINK16"><span style='font-style:normal'>The callback will be called with a string parameter which will contain </span></a><span style='font-style: normal'>the audio device names in separate lines (separated by CRLF).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: with the Java or NS engine it might be possible that you receive only the first 31 characters from the device name. This is a limitation coming from the OS audio API but it should not cause any problem, as you can pass it as-is for the other audio device related functions and it will be accepted and recognized as-is. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665555"></a><a name="_Toc489789112"></a><a name="_Toc468095560"></a><a name="_Toc463878897"></a><a name="_Toc463876868"></a><a name="_Toc463876718"></a><a name="_Toc463876512"></a><a name="_Toc463876049"></a><a name="_Toc455070014"><span style='font-size:12.0pt'>getdevice(dev, callback)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function and pass a callback, to receive the currently set audio device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For the “dev” parameter one of the followings are expected:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>0: for recording device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>1: for the playback device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>2: for ringer device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>3: for video camera</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="OLE_LINK19"></a><a name="OLE_LINK18"><span style='font-style: normal'>The callback will be called with a string parameter which will contain the currently selected audio device.</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: WebRTC doesn’t support a separate ringer device at this moment (This is a browser limitation)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665556"></a><a name="_Toc489789113"></a><a name="_Toc468095561"></a><a name="_Toc463878898"></a><a name="_Toc463876869"></a><a name="_Toc463876719"></a><a name="_Toc463876513"></a><a name="_Toc463876050"></a><a name="_Toc455070015"><span style='font-size:12.0pt'>setdevice(dev, devicename, immediate)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Select an audio device. The <span style='color:#984806'>devicename</span> should be a valid audio device name (you can list them with the <span style='color:#984806'>getaudiodevicelist()</span> call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For the “<span style='color:#984806'>dev</span>” parameter pass:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>0: for recording device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>1: for the playback device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>2: for ringer device (Will be skipped if the engine is WebRTC and will use the playback device also for ring)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='font-style:normal'>3: <a name="OLE_LINK41"></a><a name="OLE_LINK40">for video camera</a></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The "<span style='color:#984806'>immediate</span>" parameter can have the following values:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>0: default</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>1: next call only</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>2: immediately for active calls</span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665557"></a><a name="_Toc489789114"></a><a name="_Toc468095562"></a><a name="_Toc463878899"></a><a name="_Toc463876870"></a><a name="_Toc463876720"></a><a name="_Toc463876514"></a><a name="_Toc463876051"></a><a name="_Toc455070016"><span style='font-size:12.0pt'>getvolume(dev, callback)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function, passing a callback and will return the volume (percent) for the selected device.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <span style='color:#984806'>dev</span> parameter can have the following values:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> 0 for the recording (microphone) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> 1 for the playback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> 2 for the ringback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="OLE_LINK13"></a><a name="OLE_LINK12"></a><a name="OLE_LINK11"><span style='font-style:normal'>The callback will be called with the volume parameter which will be 0 (muted), 50 (default volume) or other positive number.</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="OLE_LINK39"></a><a name="OLE_LINK38"></a><a name="OLE_LINK37"><span style='font-size:9.0pt'>Note: the reason why this needs a callback (and doesn’t just returns the volume as the function return value is because for some engines the volume will be requested in an asynchronous way so it might take some time to complete).</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665558"></a><a name="_Toc489789115"></a><a name="_Toc468095563"></a><a name="_Toc463878900"></a><a name="_Toc463876871"></a><a name="_Toc463876721"></a><a name="_Toc463876515"></a><a name="_Toc463876052"></a><a name="_Toc455070017"></a><a name="_Toc449776649"></a><a name="_Toc440858267"></a><a name="_Toc434052786"></a><a name="_Toc434051128"></a><a name="_Toc432326337"><span style='font-size:12.0pt'>setvolume(dev, volume)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set <span style='color:#984806'>volume</span> (percent for the selected device. Default value is 50% -> means no change</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <span style='color:#984806'>dev</span> parameter can have the following values:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>0 for the recording (microphone) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>1 for the playback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>2 for the ringback (speaker) audio device</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>WebRTC limitations: </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>-Changing the recording volume level for WebRTC at run-time will take effect only for the next call. You can also use the <a href="start.htm#_volumein">volumein</a> parameter to change the default volume.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>-Some browsers doesn’t support changing the volume with WebRTC. It is expected that the user will control the volume with the OS volume settings.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>-A separate volume for ring is not supported on WebRTC</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_setloudspeaker_(set)"></a><span style='font-size:12.0pt'>setloudspeaker (set)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function with boolean parameter "true" to set the default playback device to speakerphone on supported devices such as Android phones and tablets. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The speakerphone will be restored if called with “false”.<br> <br> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: You can also use the <a href="start.htm#_androidspeaker">androidspeaker</a> parameter to preconfigure.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665559"></a><a name="_Toc489789116"></a><a name="_Toc468095564"></a><a name="_Toc463878901"></a><a name="_Toc463876872"></a><a name="_Toc463876722"></a><a name="_Toc463876516"></a><a name="_Toc463876053"></a><a name="_Toc455070018"></a><a name="_Toc449776650"></a><a name="_setsipheader(header)"></a><span style='font-size:12.0pt'>setsipheader(header)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set a custom sip header (a line in the SIP signaling) that will be sent with all messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can be used for various integration purposes (for example for sending the http session id or any custom data).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example: <span style='color:#984806'>setsipheader(‘X-MyExtra: whatever’);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can also set extra SIP headers with the </span><a href="start.htm#_customsipheader"><span style='font-style:normal'>customsipheader</span></a><span style='font-style:normal'> parameter (setting this parameter is the easiest way if you have some parameter which have to be sent always, regardless of the circumstances)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>It is recommended to prefix customer headers with X- so it will bypass SIP proxies.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Multiple lines can be separated by semicolon ; Example: setsipheader(‘X-MyExtra1: aaa; X-MyExtra2: bbb’);</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Multiple lines can be also set by calling this function multiple times with different keys.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>There are two kinds of headers that you can set:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Global (set for all lines including the registrar endpoint): if the line is -2 or there is no current call on the selected line (for example if you set it at startup, before any calls or with line set to -2)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>Per line: if the current line is set and there is an active call on that line.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'>Note that you cannot set it for not already existing lines (lines which doesn’t have calls on it yet. For the upcoming call you should set it globally)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>You can remove all the previously passed headers (per line or global) by calling this function with an empty string. Example: setsipheader(‘’);</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-size:9.0pt;font-family:Symbol;font-style: normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-size:9.0pt'>You can remove a previously set header by calling this function with an empty key for that header. Example: setsipheader(‘X-MyExtra:’);</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="OLE_LINK21"></a><a name="OLE_LINK20"></a><a name="_Toc499665560"></a><a name="_Toc489789117"></a><a name="_Toc468095565"></a><a name="_Toc463878902"></a><a name="_Toc463876873"></a><a name="_Toc463876723"></a><a name="_Toc463876517"></a><a name="_Toc463876054"></a><a name="_Toc455070019"></a><a name="_Toc449776651"></a><a name="_getsipheader(header,_callback)"></a><span style='font-size:12.0pt'>getsipheader(header, callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function passing a callback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: <span style='color:#984806'>getsipheader(“Contact”,mycallback)</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called with one parameter, which will be the string value of the requested sip header from the received SIP messages (received from your server of from the other peer). If no such header is found or some other error occurs, then the returned string begins with “ERROR” (for example: “<span style='color:#984806'>ERROR: no such header</span>”) so you might ignore these.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>-The reason why this needs a callback (and doesn’t just returns the last seen header values is because for some engines the signaling messages have to be requested in an asynchronous way so it might take a little time –usually only a few milliseconds- to complete the request).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>-The getsipheader() will send you the headers from the incoming SIP messages (not the headers previously set by the setsipheader() function call)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665561"></a><a name="_Toc489789118"></a><a name="_getsipmessage(dir,_type,_callback)"></a><span style='font-size:12.0pt'>getsipmessage(dir, type, callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return the last SIP signaling message as specified by the current line and the dir/type parameters.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function passing a callback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called with one parameter, which will be the string value of the requested sip message as raw text.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If no such message is found or some other error occurs, then the returned string begins with “ERROR” (for example: “<span style='color:#984806'>ERROR: SIP message not found</span>”) so you might ignore these.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following parameters are defined:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>dir</span><span style='font-style:normal'>:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 0: in (incoming/received message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 1: out (outgoing/sent message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>type</span><span style='font-style:normal'>:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 0: any</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 1: SIP request (such as INVITE, REGISTER, BYE)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 2: SIP answer (such as 200 OK, 401 Unauthorized and other response codes)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 3: INVITE (the last INVITE received or sent)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> 4: the last 200 OK (call connect, ok for register or other)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>callback</span><span style='font-style:normal'>:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> The callback function</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function if you have good SIP knowledge and wish to parse the SIP messages yourself from JavaScript for some reason (for example to extract some part of it to be processed for other purposes).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example to return the last received INVITE message about an incoming call: <span style='color:#984806'>getsipmessage(0,3,mysipmsgrecvcallback)</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: just as other functions, this will take in consideration the active line (set by setline() or auto set on in/out call setup). You can set the active line to “all” [with setline(-2)] to get the last message regardless of the line.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node117" id="node117"></a><span style='font-size:12.0pt'>getlastrecinvite (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get last received SIP INVITE message.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is a helper function, which might be useful only for some specific needs.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function passing a callback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called with one String parameter, which will be the last incoming call's SIP INVITE message.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Might be useful to get the whole INVITE message on call setup.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node118" id="node118"></a><span style='font-size:12.0pt'>getlastsentinvite (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Get last sent SIP INVITE message.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is a helper function, which might be useful only for some specific needs.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function passing a callback. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called with one String parameter, which will be the last outgoing call's SIP INVITE message.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Might be useful to get the whole INVITE message on call setup.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665562"></a><a name="_Toc489789119"><span style='font-size:12.0pt'>getlinedetails (line)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return the state and various parameters of an endpoint as a string in the following format:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>LINEDETAILS,line,state,callid,remoteusername,localusername,type,localaddress,serveraddress,mute,hold,remotefullname</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Basically, the parameters here are very similar with the STATUS parameters described </span><a href="start.htm#_STATUS,line,statustext,peername,loc"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665563"></a><a name="_Toc489789120"></a><a name="_getlastcalldetails_(callback)"></a><span style='font-size:12.0pt'>getlastcalldetails ()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns a string with details about the previously disconnected call.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You should call this function after the call is actually finished. For example after the onCdr callback have been fired.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example in case of the NS engine, this might return something like:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Line: 1 , Direction: outgoing</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Local Username: CALLER , AuthUsername: CALLER</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Peer Username: CALLED , Name: CALLED Called: CALLED</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Server: SERVER<span style='text-transform:uppercase'>DDRESS</span> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Connectime: X msec</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Duration: X msec</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Disc By: Local , Reason: User Hung Up</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>AEC_SETT: 1, AEC_FULL: 2, AEC_FAST: 2, no, AEC_VOL: 1, AGC: 2, Denoise: 2, mediaench: aec: 2, denoise: 2, agc: 2, silencesupress: 0 </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Payload: X CODEC, pf: 1, network: fast </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>CPU: speed: 3500, load: 0.0, reccpuhigh: false, subshigh: 0, highdetected: no, meassured: 0 0</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>Audio: Record: count: 254 ival: 20 last: 5 0 Playback: count: 257 ival: 20 last: 5 0 issues: 2 500 16 Queue: 1 0 2 4 0</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_getcallerdisplayfull_(callback)"></a><span style='font-size:12.0pt'>getcallerdisplayfull (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function and pass a callback, to receive the incoming detailed caller id (might return two lines: caller id \n caller name)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: If you just need the caller id, you should just use the onCallStateChange peer name instead of this function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The callback will be called with a string parameter which will contain the incoming detailed caller id.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>See the </span><a href="start.htm#_Caller_ID_display"><span style='font-style:normal'>Caller-ID FAQ</span></a><span style='font-style:normal'> point for more details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665564"></a><a name="_Toc489789121"><span style='font-size:12.0pt'>getregfailreason ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns a string with the reason about failed connect/registration.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Deprecated! Use the onRegStateChange callback “unregistered” event instead!<br> <br> </span><a name="_getregfailreason_()"></a></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665565"></a><a name="_Toc489789122"></a><a name="_Toc468095566"></a><a name="_Toc463878903"></a><a name="_Toc463876874"></a><a name="_Toc463876724"></a><a name="_Toc463876518"></a><a name="_Toc463876055"></a><a name="_Toc455070020"></a><a name="_Toc449776652"></a><a name="_Toc440858270"></a><a name="_Toc434052789"></a><a name="_Toc434051131"></a><a name="_Toc432326340"></a><a name="_setline_(line)"></a><span style='font-size:12.0pt'>setline (line)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This function can be used for explicit line/channel management and it will set the current active channel. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For the <span style='color:#984806'>line</span> parameter you can pass one of the followings:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> -line number: -2 (all), -1 (current/best), 0 (invalid), 1 (first channel), 2 (second channel) …. 100</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> -sip call id (so the active line will be set to the line number of the endpoint with this sip call id)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> -peer username (so the active line will be set to the line number of the endpoint where the peer is this user)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Use this function only if you present line selection for the users. Otherwise you don’t have to take care about the lines as it is managed automatically (with each call on the first “free” line)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: You can set the line to -2 and -1 only for a short period. After some time the getline() will report the real active line or “best” line.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details about multi-line can be found in the </span><a href="start.htm#_How_to_manage"><span style='font-style:normal'>FAQ</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665566"></a><a name="_Toc489789123"></a><a name="_Toc468095567"></a><a name="_Toc463878904"></a><a name="_Toc463876875"></a><a name="_Toc463876725"></a><a name="_Toc463876519"></a><a name="_Toc463876056"></a><a name="_Toc455070021"></a><a name="_Toc449776653"></a><a name="_Toc440858271"></a><a name="_Toc434052790"></a><a name="_Toc434051132"></a><a name="_Toc432326341"></a><a name="_getline_()"></a><span style='font-size:12.0pt'>getline ()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return type: number</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return the current active line number. This should be the line which you have set previously except after incoming and outgoing calls (the webphone will automatically switch the active line to a new free line for these if the current active line is already occupied by a call). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>More details about multi-line can be found in the </span><a href="start.htm#_How_to_manage"><span style='font-style:normal'>FAQ</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node119" id="node119"></a><span style='font-size:12.0pt'>linetocallid (line, callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Utility function to get the SIP Call-ID for a line number. Might be useful in some circumstances.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called with one parameter, which will be the SIP Call-ID for the passed line number.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node120" id="node120"></a><span style='font-size:12.0pt'>callidtoline (callid, callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Utility function to get the line number for a SIP Call-ID. Might be useful in some circumstances.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called with one parameter, which will be the line number for the passed SIP Call-ID.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665567"></a><a name="_Toc489789124"></a><a name="_Toc468095568"></a><a name="_Toc463878905"></a><a name="_Toc463876876"></a><a name="_Toc463876726"></a><a name="_Toc463876520"></a><a name="_Toc463876057"></a><a name="_Toc455070022"></a><a name="_Toc449776654"></a><a name="_Toc440858272"></a><a name="_Toc434052791"></a><a name="_Toc434051133"></a><a name="_Toc432326342"></a><a name="_isregistered_()"></a><span style='font-size:12.0pt'>isregistered ()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return type: boolean</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return true if the webphone is registered ("connected") to the SIP server.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: you can track the phone state machine also with the </span><a href="start.htm#_Events"><span style='font-style:normal'>events callbacks</span></a><span style='font-style:normal'> or check </span><a href="start.htm#_How_to_find"><span style='font-style:normal'>this FAQ</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665568"></a><a name="_Toc489789125"></a><a name="_Toc468095569"></a><a name="_Toc463878906"></a><a name="_Toc463876877"></a><a name="_Toc463876727"></a><a name="_Toc463876521"></a><a name="_Toc463876058"></a><a name="_Toc455070023"></a><a name="_Toc449776655"><span style='font-size:12.0pt'>isincall ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return type: boolean</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return true if the webphone is in call, otherwise false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Note: you can track the phone state machine also with the </span><a href="start.htm#_onCallStateChange_(callback)"><span style='font-style:normal'>events callbacks</span></a><span style='font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665569"></a><a name="_Toc489789126"></a><a name="_Toc468095570"></a><a name="_Toc463878907"></a><a name="_Toc463876878"></a><a name="_Toc463876728"></a><a name="_Toc463876522"></a><a name="_Toc463876059"></a><a name="_Toc455070024"></a><a name="_Toc449776656"><span style='font-size:12.0pt'>ismuted ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return type: boolean</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return true if the call is muted, otherwise will return false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665570"></a><a name="_Toc489789127"></a><a name="_Toc468095571"></a><a name="_Toc463878908"></a><a name="_Toc463876879"></a><a name="_Toc463876729"></a><a name="_Toc463876523"></a><a name="_Toc463876060"></a><a name="_Toc455070025"></a><a name="_Toc449776657"><span style='font-size:12.0pt'>isonhold ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return type: boolean</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Return true if the call is on hold, otherwise will return false.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665571"></a><a name="_Toc489789128"></a><a name="_Toc468095572"></a><a name="_Toc463878909"></a><a name="_Toc463876880"></a><a name="_Toc463876730"></a><a name="_Toc463876524"></a><a name="_Toc463876061"></a><a name="_Toc455070026"></a><a name="_Toc449776658"></a><a name="_Toc440858275"></a><a name="_Toc434052794"></a><a name="_Toc434051136"></a><a name="_Toc432326345"><span style='font-size:12.0pt'>isencrypted ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Check if communication channel is encrypted: -1=unknown, 0=no, 1=partially, 2=yes, 3=always</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665572"><span style='font-size: 12.0pt'>checkblf (userlist)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Subscribe to call state of other extensions to receive call state change information as BLF notifications by triggering the </span><a href="start.htm#_onBLFStateChange_(callback)"><span style='font-style:normal'>onBlfStateChange</span></a><span style='color:black; font-style:normal'> callback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Userlist</span><span style='font-style:normal'>: list of sip account username separated by comma.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'>In order for BLF (busy lamp field) to work, make sure that your server and peer(s) has support for BLF subscribe/notify with dialog event package as described in RFC 3265 and RFC 4235.</span></p> <p class="MsoNoSpacing"><span style='font-style:normal'> </span></p> <p class="MsoNoSpacing">Note: If BLF is an important feature for you, then we recommend the usage of the NS or Java engines as this is unreliable with WebRTC (set the enginepriority_ns and enginepriority_java to 4) </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665573"></a><a name="_Toc489789129"></a><a name="_Toc468095573"></a><a name="_Toc463878910"></a><a name="_Toc463876881"></a><a name="_Toc463876731"></a><a name="_Toc463876525"></a><a name="_Toc463876062"></a><a name="_Toc455070027"></a><a name="_Toc449776659"></a><a name="_Toc440858273"></a><a name="_Toc434052792"></a><a name="_Toc434051134"></a><a name="_Toc432326343"><span style='font-size:12.0pt'>checkpresence (userlist)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will receive presence information PRESENCE notifications and will trigger the onPresenceStateChange callback.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:black;font-style:normal'>Userlist</span><span style='font-style:normal'>: list of sip account username separated by comma.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>In order for presence to work, make sure that your server has support for </span><a href="start.htm#_Presence_is_not"><span style='font-style:normal'>subscribe/notify</span></a><span style='font-style: normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665574"></a><a name="_Toc489789130"></a><a name="_Toc468095574"></a><a name="_Toc463878911"></a><a name="_Toc463876882"></a><a name="_Toc463876732"></a><a name="_Toc463876526"></a><a name="_Toc463876063"></a><a name="_Toc455070028"></a><a name="_Toc449776660"></a><a name="_Toc440858274"></a><a name="_Toc434052793"></a><a name="_Toc434051135"></a><a name="_Toc432326344"><span style='font-size:12.0pt'>setpresencestatus (status)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Function call to change the user online status with one of the followings strings: Online, Away, DND, Invisible, Offline (case sensitive).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665575"></a><a name="_Toc489789131"></a><a name="_Toc468095575"></a><a name="_Toc463878912"></a><a name="_Toc463876883"></a><a name="_Toc463876733"></a><a name="_Toc463876527"></a><a name="_Toc463876064"></a><a name="_Toc455070029"></a><a name="_Toc449776661"></a><a name="_Toc440858277"></a><a name="_Toc434052796"></a><a name="_Toc434051138"></a><a name="_Toc432326347"><span style='font-size:12.0pt'>getenginename ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns the currently used engine name as string: "java", "webrtc", "ns", "app", "flash", "p2p", "nativedial".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Can return empty string if engine selection is in progress.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Might be used to detect the capabilities at runtime (for example whether you can use the below jvoip function or not)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node121" id="node121"></a><span style='font-size:12.0pt'>listcallhistory ()</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This function will return a String containing the whole call history list. If there are no entries in call history, it will return null.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call history entries will be separated by "carriage return new line": \r\n</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Call history fields will be separated by "tabs": \t </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The order of fields and their meaning:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>type: int - 0=Outgoing call, 1=Incoming call, 2=Missed call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>name: String - can be a name, can be the same as the number or can be empty String</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>number: String - the phone number/SIP URI</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>date: int - timestamp date of call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>duration: int - duration of the call in milliseconds</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:"Courier New"; font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>discreason: String - call disconnnect reason</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: 1 \t Name \t Number \t Date \t Duration \t Discreason</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665576"></a><a name="_Toc489789132"><span style='font-size:12.0pt'>listcontacts (all)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This function will return a String containing the whole contact list. If there are no contacts, it will return null.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Set the all parameter to true to receive also virtual contacts as well, like voicenumber, etc...</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Contacts will be separated by "carriage return new line": \r\n</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> Contact fields will be separated by "tabs": \t </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> A contact can have more than one phone numbers or SIP URIs, so these will be separated by Pipe(Vertical bar): |</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> See example below:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The order of fields and their meaning:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>name: String - the name of the contact</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>number: array of String - the number(s)/SIP URI(s) of the contact</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>favorite: int - 0=No, 1=Yes</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>email: String - email address of the contact</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>address: String - the address of the contact</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>notes: String - notes attached to this contact</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>website: String: web site attached to this contact</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example: Name \t Number1|Number2 \t Favorite \t Email \t Address \t Notes \t Website\r\n</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665577"></a><a name="_Toc489789133"></a><a name="_addcontact_(fullname,_number,"></a><span style='font-size:12.0pt'>addcontact (fullname, number, email, address, notes, website )</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Add a contact to the contact list. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is useful only with the softphone skin (otherwise most probably you don’t need a contact list or you manage it yourself on a custom user interface after your needs).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: Contacts can be prepopulated also by using the <a href="start.htm#_defcontacts">defcontacts</a> parameter.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665578"></a><a name="_Toc489789134"><span style='font-size:12.0pt'>getcontact (name, number)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function passing the name and/or number of the contact.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Will return a String with the following parameters separated by "tabs": \t if found:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>name: String - the name of the contact</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>number: String - number(s)/SIP URI(s) of the contact separated by Pipe(Vertical bar): |</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>favorite: int - 0=No, 1=Yes</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>email: String - email address of the contact</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>address: String - the address of the contact</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>notes: String - notes attached to this contact</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>website: String: web site attached to this contact</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If contact is not found, then it will return null.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665579"></a><a name="_Toc489789135"><span style='font-size:12.0pt'>delcontact (name, number)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Delete contact from the contact list where the name or the number match.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This is useful only with the softphone skin (otherwise most probably you don’t need a contact list or you manage it yourself on a custom user interface after your needs)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665580"></a><a name="_Toc489789136"><span style='font-size:12.0pt'>getworkdir ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns the working directory for the NS and Java engines (not applicable for WebRTC and Flash).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The working directory is the folder which is used to save any files (configurations, logs, voice recordings).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665581"></a><a name="_Toc489789137"></a><a name="_Toc468095576"></a><a name="_Toc463878913"></a><a name="_Toc463876884"></a><a name="_Toc463876734"></a><a name="_Toc463876528"></a><a name="_Toc463876065"></a><a name="_Toc455070030"></a><a name="_Toc449776662"></a><a name="_Toc440858276"></a><a name="_Toc434052795"></a><a name="_Toc434051137"></a><a name="_Toc432326346"></a><a name="_delsettings_(level)"></a><span style='font-size:12.0pt'>delsettings (level)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Delete stored data (from cookie, config file and local-storage).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For the level parameters the following are defined:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .1in;line-height:normal'><span style='font-style:normal'>1: just settings file</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .1in;line-height:normal'><span style='font-style:normal'>2: delete everything: settings, contacts, call history, messages</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Warning: this will delete all settings, even those that should be remembered between sessions, such as “Have we already asked X from the enduser?”. To deal with different settings we recommend using the <a href="start.htm#_profile">profiles</a> instead of using this API or just set unneeded settings to NULL. More details can be found <a href="start.htm#_New_settings_not">here</a>.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>This API might stop or restart the SIP engine.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>You should call this on logout (not at start) if for some reason you wish to delete the stored phone settings.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_jvoip(name,_jargs)"></a><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665583"></a><a name="_Toc489789139"></a><a name="_Toc468095578"></a><a name="_Toc463878915"></a><a name="_Toc463876886"></a><a name="_Toc463876736"></a><a name="_Toc463876530"></a><a name="_Toc463876067"></a><a name="_Toc455070032"></a><a name="_Toc449776664"><span style='font-size:12.0pt'>getlogs ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns a string containing all the accumulated logs by the webphone (the logs are limited on size, so old logs will be lost after long run).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='line-height:120%;font-style:normal'>More details about logs can be found </span><a href="start.htm#_How_to_get"><span style='line-height:120%;font-style:normal'>here</span></a><span style='line-height:120%;font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665584"></a><a name="_Toc489789140"></a><a name="_Toc468095579"></a><a name="_Toc463878916"></a><a name="_Toc463876887"></a><a name="_Toc463876737"></a><a name="_Toc463876531"></a><a name="_Toc463876068"></a><a name="_Toc455070033"></a><a name="_Toc449776665"></a><a name="_Toc440858279"><span style='font-size:12.0pt'>getstatus ()</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Returns the webphone global status. The possible returned texts are the same like for getEvenetsnotifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might use the events described below instead of polling this function.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node122" id="node122"></a><span style='font-size:12.0pt'>others</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>We have listed all the important and commonly used API’s in this documentation, however, there are some other advanced/deprecated/internal API’s that can be accessed.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><u><span style='font-style:normal'>Advanced functions</span></u></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There are a few additional not so important functions provided in the <span style='color:#984806'>webphone_api.js</span>. Inspect the webphone_api.js file for the details.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><u><span style='font-style:normal'>Helper functions</span></u></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>There are a few helper/internal/not so important functions that can be accessed from <span style='color:#984806'>\js\lib\api_helper.js</span>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><u><span style='font-style:normal'>Deprecated functions</span></u></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The webphone is fully backward and forward compatible and we never remove old function. All the old deprecated functions can be still used as-is, without the need to change your code. These functions are declared in the webphone_api.js or moved to \js\lib\api_helper.js (they are still available via the webphone_api object). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The major deprecated functions are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>onLoaded, onStart, onStop (replaced with onAppStateChange)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>onRegistered, onRegisterFailed, onUnRegistered (replaced with onRegStateChange)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>callSetup, callRinging, callConnected, callDisconnected (replaced with onCallStateChange)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>onDisplay, onLog, onEvents (replaced with onEvent)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><u><span style='font-style:normal'>Internal engines</span></u></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If engine is Java or the NS Service plugin, then you can access the full low-level API as described in the </span><a href="http://www.mizu-voip.com/Software/JVoIP_Doc.pdf"><span style='font-style: normal'>JVoIP SDK documentation</span></a><span style='font-style:normal'>.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This can be done with the <span style='color:#984806'>jvoip</span> function call:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='color:#984806;font-style:normal'>jvoip(name, jargs)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Name: name of the function</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Jargs: array of arguments passed to the called function. Must be an array, if API function has parameters. If API function has no parameters, then it can be an empty array, null, or omitted altogether.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example the low level API function: API_Call(number) can be called like this: <span style='color:#984806'>webphone_api.jvoip('API_Call', line, number);</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:solid #C0504D 1.0pt;border-left:solid #C0504D 6.0pt; padding:0in 4.0pt 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h2 style='margin-left:0in'><a name="_Toc499665585"></a><a name="_Events"></a>Events</h2> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following callback functions can be used to receive events from the webphone such as the phone state machine status (registered/call init/call connected/disconnected) and other important events and notifications:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_onAppStateChange_(callback)"></a><span style='font-size:12.0pt'>onAppStateChange (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to track app state changes.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called on every webphone app state change. The callback function has a state string parameter containing the new state of the application.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The states are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#943634'>loaded</span>" - the webphone library is completely loaded so you can start the usage (call any other API functions only after this state is received!).</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#943634'>started</span>" - the VoIP engine has successfully started (ready to register or make calls). Note: you can initiate calls also from the “loaded” event and it will be queued to be executed after started.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#943634'>stopped</span>" - the VoIP engine has stopped (all endpoints unregistered/disconnected and the sipstack was destroyed). Usually triggered at page unload.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Example:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>webphone_api.onAppStateChange(function (state) </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//watch for webphone state changes</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>if (state === 'loaded')</span><span style='font-size:9.0pt;color:gray;font-style:normal'> //webphone library loaded</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> webphone_api.setparameter("name", "value"); </span><span style='font-size:9.0pt;color:gray;font-style: normal'>//set any parameter</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>webphone_api.start(); </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//start if not started automatically</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:gray;font-style:normal'>//setup call state machine watcher</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>webphone_api.onCallStateChange(function (event, direction, peername, peerdisplayname, line, callid)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> //handle any call events here. For example to catch the call connect events:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> if (event === 'callConnected')</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'> </span><span style='font-size:9.0pt;color:#984806;font-style:normal'>alert("Call connected with " + peername);</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> } </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//else if (event === '</span><span style='font-size:11.0pt;color:gray'> </span><span style='font-size:9.0pt; color:gray;font-style:normal'>callDisconnected') … </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>});</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>}</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>else if (state === 'started') </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//sip stack started</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:1.0in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>webphone_api.call('NUMBER'); </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//make a call immediately once started</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>}</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>});</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: the onAppStateChange deprecated to old onLoaded, onStart and onStop functions but these are still available and you don’t need to change any old code.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_onLoaded_(callback)"></a><a name="_onRegStateChange_(callback)"></a><span style='font-size:12.0pt'>onRegStateChange (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to track register state changes. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>The REGISTER method in SIP is used to “connect” to the SIP server, so the server can learn the device location to be used to route incoming calls and other messages.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called on every register state change with a state string parameter. <br> The states are the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#943634'>registered</span>" – registered successfully to the SIP server</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#943634'>unregistered</span>" – unregistered from the SIP server (if user closes the webpage, then you might not have enough time to catch this event)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#943634'>failed</span>" – register failed. You can receive the cause of the failure in a second reason string parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><a name="_onRegistered_(callback)"></a><a name="_onRegisterFailed_(callback)"></a><a name="_onUnRegistered_(callback)"></a><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665591"></a><a name="_Toc489789147"></a><a name="_Toc468095585"></a><a name="_Toc463878923"></a><a name="_Toc463876894"></a><a name="_Toc463876744"></a><a name="_Toc463876538"></a><a name="_Toc463876075"></a><a name="_Toc455070040"></a><a name="_Toc449776672"></a><a name="_Toc440858286"></a><a name="_onCallStateChange_(callback)"></a><span style='font-size:12.0pt'>onCallStateChange (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to track call state changes. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called on every call state change (triggered when the webphone is in call).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>event: can have following string values: callSetup, callRinging, callConnected, callDisconnected</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>direction: <a name="OLE_LINK34"></a><a name="OLE_LINK33"></a><a name="OLE_LINK32">1 (for outgoing call), 2 (for incoming call)</a></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>peername: is the other party username (or phone number or extension)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><a name="OLE_LINK31"></a><a name="OLE_LINK30"></a><a name="OLE_LINK29"><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>peerdisplayname: is the other party display name if any</span></a></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line: channel number (this might be important only if you wish to handle multi-line management explicitly)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>callid: SIP Call-ID </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>A simple usage example can be found </span><a href="start.htm#_How_to_catch"><span style='font-style:normal'>here</span></a><span style='font-style:normal'>. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: </p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>the call might change from callSetup state directly into callDisconnected state if it was connected</p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>callRinging state is optional (it is not a definitive answer for the INVITE transaction so it is not mandatory in SIP)</p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span>you might receive other event strings which can be just safely ignored</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665592"><span style='font-size: 12.0pt'>onPresenceStateChange (callback)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to track presence changes.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called on every presence (online/offline/others) state change (of the remote users). </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To initiate presence requests, you can use the <span style='color:#984806'>checkpresence()</span> API or the <span style='color:#984806'>presenceuserlist</span> parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>peername: is the other party username (or phone number or extension)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>presence: can have following values: CallMe,Available,Pending,Other,CallForward,Speaking,Busy,Idle,DoNotDisturb,Unknown,Away,Offline,Exists,NotExists,Unknown</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>displayname: optional peer display name if sent as part of presence</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>email: optional peer email address if sent as part of presence</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665593"></a><a name="_onBLFStateChange_(callback)"></a><span style='font-size:12.0pt'>onBLFStateChange (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to track BLF changes. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called on every call state change (of the remote users) which might be used as BLF (busy lamp field)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To initiate presence requests, you can use the <span style='color:#984806'>checkblf()</span> API or the <span style='color:#984806'>blfuserlist</span> parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>peername: is the other party username (or phone number or extension)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>direction: can have one of following values: undefined, initiator (outgoing call) or receiver (incoming call)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>undefined </span><span style='font-style:normal'>(not for calls or no announced by the peer)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>initiator </span><span style='font-style:normal'>(outgoing call)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>receiver </span><span style='font-style:normal'>(incoming call)</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>state: can have one of following values: trying , proceeding, early, comfirmed, terminated, unknown or failed</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>trying </span><span style='font-style:normal'>(call connect initiated)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>proceeding </span><span style='font-style:normal'>(call connecting)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>early </span><span style='font-style:normal'>(ringing or session progress)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>confirmed </span><span style='font-style:normal'>(call connected)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>terminated </span><span style='font-style:normal'>(call disconnected)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";color:black;font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>unknown</span><span style='color:black; font-style:normal'> (unrecognized call state received)</span></p> <p class="MsoNoSpacing" style='margin-left:1.0in;text-indent:-.25in'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>failed </span><span style='font-style:normal'>(BLF subscribe or notify failed)</span></p> <p class="MsoListParagraph" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>callid: optional SIP call-id of the call (if reported by the BLF notify)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665594"></a><a name="_Toc489789148"></a><a name="_Toc468095586"></a><a name="_Toc463878924"></a><a name="_Toc463876895"></a><a name="_Toc463876745"></a><a name="_Toc463876539"></a><a name="_Toc463876076"></a><a name="_Toc455070041"></a><a name="_Toc449776673"></a><a name="_Toc440858287"><span style='font-size:12.0pt'>onChat (callback)</span></a></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called when chat message is received.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>from: username, phone number or SIP URI of the sender</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>msg: the content of the text message</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line number</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>group: group name; the name of the group if it's group chat, otherwise it will be an empty string or “null” (“null” might be received if other endpoint has group chat support but this message is not part of a group chat</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="node123" id="node123"></a><span style='font-size:12.0pt'>onSMS (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called when an SMS message is received. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Might be triggered only if the server has VoIP SMS support or SMS API implemented.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>from: username, phone number or SIP URI of the sender</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>msg: the content of the text message</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665595"></a><a name="_Toc489789149"></a><a name="_onDTMF_(callback)"></a><span style='font-size:12.0pt'>onDTMF (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called when a DTMF digit is received.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>dtmf: received DTMF character as string</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line: channel number</span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="OLE_LINK36"></a><a name="OLE_LINK35"></a><a name="_Toc499665596"></a><a name="_Toc489789150"></a><a name="_Toc468095587"></a><a name="_Toc463878925"></a><a name="_Toc463876896"></a><a name="_Toc463876746"></a><a name="_Toc463876540"></a><a name="_Toc463876077"></a><a name="_Toc455070042"></a><a name="_Toc449776674"></a><a name="_Toc440858288"></a><a name="_onCdr_(callback)"></a><span style='font-size:12.0pt'>onCdr (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The passed callback function will be called at each call disconnect. You will receive a CDR (call detail record).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-bottom:0in;margin-bottom:.0001pt; text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>caller: the caller party username (or number or sip uri)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>called: called party username<a name="OLE_LINK28"></a><a name="OLE_LINK27"></a><a name="OLE_LINK26"> (or number or sip uri)</a></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>connect time: milliseconds elapsed between call initiation and call connect (includes the call setup time + the ring time)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>duration: milliseconds elapsed between call connect and hangup (0 for not connected calls. Divide by 1000 to obtain seconds)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>direction: 1 (outgoing call), 2 (incoming call)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>peerdisplayname: is the other party display name if any</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>reason: disconnect reason as string</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>line: channel number</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-bottom:0in;margin-bottom: .0001pt;text-indent:-.25in;line-height:normal'><span style='font-family:Symbol; font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>callid: SIP Call-ID </span></p> <p class="MsoListParagraphCxSpLast" style='margin-bottom:0in;margin-bottom:.0001pt; line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt'>Note: you can get some more details about the call by using the </span><a href="start.htm#_getlastcalldetails_(callback)"><span style='font-size:9.0pt'>getlastcalldetails()</span></a><span style='font-size: 9.0pt'> function.</span><br> <br> <a name="_onDisplay_(callback)"></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border-top:none;border-left:solid #C0504D 6.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 0in 2.0pt;margin-left:.1in;margin-right:0in'> <h3 style='margin-left:0in'><a name="_Toc499665599"></a><a name="_Toc489789153"></a><a name="_Toc468095589"></a><a name="_Toc463878918"></a><a name="_Toc463876889"></a><a name="_Toc463876739"></a><a name="_Toc463876533"></a><a name="_Toc463876070"></a><a name="_Toc455070035"></a><a name="_Toc449776667"></a><a name="_Toc440858281"></a><a name="_Toc434052772"></a><a name="_Toc434051114"></a><a name="_Toc432326323"></a><a name="_getEvents_(callback)"></a><a name="_onEvent_(callback)"></a><span style='font-size:12.0pt'>onEvent (callback)</span></h3> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You can use this function to receive internal events, logs and messages that should be displayed to users.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Call this function once and pass a callback, to receive important events, which should be displayed for the user and/or parsed to perform other actions after your software custom logic. You will also receive all log messages depending on the value of "loglevel" parameter.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For the included softphone these are already handled, so no need to use this, except if you need some extra custom actions or functionality which depends on the notifications.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Parameters:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>type</span><span style='font-style:normal'>: the type of the message. This can have the following values:</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>event</span><span style='font-style: normal'>: low level notifications which can be parsed as string.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Example: STATUS,1,Ringing,2222,1111,2,Katie,[callid]</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Instead of parsing these low level string notifications, you should use the callback functions instead such as onAppStateChange, onCallStateChange, onChat and the other onXXX functions.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>See the “</span><a href="start.htm#_Notifications"><span style='font-style:normal'>Notifications</span></a><span style='font-style:normal'>” section below for all possible strings.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>log</span><span style='font-style:normal'>: log messages </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Usually you don't need to check for the logs.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>You might watch for this only if you wish to collect the logs for some purpose or you have to watch for a log string to be triggered.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.75in;margin-bottom:.0001pt;text-indent:.5in;line-height:normal'><span style='font-style:normal'>It can be used for debugging or for log redirection if the </span><a href="start.htm#_How_to_get"><span style='font-style:normal'>other possibilities</span></a><span style='font-style:normal'> don’t fit your needs.</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>display</span><span style='font-style: normal'>: important messages to be displayed for the user. </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>If you wish to handle the popups yourself, then disable popups by settings </span><a href="start.htm#_showtoasts"><span style='font-style:normal'>showtoasts</span></a><span style='font-style:normal'> parameter to "false". From here on you will be responsible for presenting these messages to the user.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>If type is "display", then the "message" parameter will be composed of a "title" until the first comma and a "text". </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.25in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The title can be an empty string, in which case the message begins with a comma.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:Symbol;font-style:normal'>·<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>message</span><span style='font-style:normal'>: the text of the event/log/display</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>webphone_api.onEvent( function (type, message)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>{</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> // For example the following status means that there is an incoming call ringing from 2222 on the first line: </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> // STATUS,1,Ringing,2222,1111,2,Katie,[callid] </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> // You can find more detailed explanation about events in the documentation "Notifications" section.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:gray;font-style:normal'> // example for detecting incoming call:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> if (type === 'event')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> var evtarray = message.split(',');</span><span style='font-size:9.0pt;color:gray; font-style:normal'> //parameters are separated by comma (,) </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> if (evtarray[0] === 'STATUS' && evtarray[2] === 'Ringing')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> if (evtarray[5] === '1') </span><span style='font-size:9.0pt;color:gray; font-style:normal'>// 1 means it is an outgoing call</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//add any custom logic here, for example you might lookup the caller from a database </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> alert('Incoming call from: '+evtarray[3] + ' ' + evtarray[6]); </span><span style='font-size: 9.0pt;color:gray;font-style:normal'>//of course, instead of alert you should use some better html display</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> } </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>// example for handling displayable messages</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> else if (type === 'display')</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> {</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> var position = message.indexOf(',');</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> var title = message.substring(0, position); </span><span style='font-size:9.0pt; color:gray;font-style:normal'>// NOTE: title can be empty string</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> var text = message.substring(position + 1); </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> alert(title+'\r\n'+text); </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//of course, instead of alert you should use some better html display</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span><span style='font-size:9.0pt;color:gray;font-style:normal'>//NOTE: If you wish to handle the popups yourself, then disable popups by settings "showtoasts" parameter to "false".</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> }</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'>});</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-size:9.0pt;color:#984806;font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Notes: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>This is a new function in v.3.0 to replace the old onDisplay, onLog and onEvents callback.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>It is possible to use this function to catch all the event notifications to track all state machine changes instead of the onAppStateChange, onCallStateChange, onChat and the other onXXX functions. However we recommend to use the high level callback functions instead of error prone string parsing from this onEvent function.</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>You might also check the basic_example.html included in the package regarding the onEvent function usage.</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.25in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='color:#984806;font-style:normal'>display</span><span style='font-style: normal'> type events:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>With the display messages you can receive important events and notifications (as strings) that should be displayed to the user.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>For example: </span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#404040'>Invalid phone number or SIP URI or username</span>" (displayed if user is trying to call an invalid peer)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>"<span style='color:#404040'>Waiting for permission. Please push the Allow/Share button in your browser...</span><span style='color:black'>"</span> (when waiting for WebRTC browser permission)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>“<span style='color:#404040'>Check your microphone! No audio record detected.</span>” (which is displayed after 6 seconds in calls if the VAD doesn’t report any activity).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The text of the message is language dependent, meaning if the language of the webphone is changed, the message/title language is also changed.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Engine selection related popups are always handled by the webphone (However these are presented only when really necessary and can be suppressed by forcing the webphone to a single engine)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt;font-style:normal'>N</span><span style='font-style:normal'>otifications will be displayed as auto-hiding popups if not disabled with the </span><a href="start.htm#_showtoasts"><span style='font-style:normal'>showtoasts</span></a><span style='font-style:normal'> parameter</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border-top:none;border-left:solid #C0504D 1.0pt;border-bottom:solid #C0504D 1.0pt; border-right:none;padding:0in 0in 2.0pt 2.0pt;margin-left:4.3pt;margin-right: 0in'> <h4 style='margin-left:0in'><a name="_Toc414335122"></a><a name="_Toc255049844"></a><a name="_Notifications"></a><span style='font-size:12.0pt'>Notifications</span></h4> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>“Notifications” means simple string messages received from the webphone which you can parse from the </span><a href="start.htm#_getEvents_(callback)"><span style='font-style:normal'>onEvent</span></a><span style='font-style:normal'>(callback) to receive notifications and events from the sip web phone about its state machine, calls states and important events.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Skip this section if you are not using the onEvent() function catching the “event” messages. (You can use the functions such as onRegStateChange/onCallStateChange/others to catch the important events in which you are interested in and completely skip this section about the low-level notification strings handling).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If you are using the <span style='color:black'>onEvent() </span>function then you can parse the received event strings from your java script code. Each notification is received in a separate line (separated by CRLF). Parameters are separated by comma ‘,’. For the included softphone and click to call these are already handled, so no need to change, except if you need some extra custom actions or functionality.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following messages are defined:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Toc463878928"></a><a name="_Toc463876899"></a><a name="_Toc463876749"></a><a name="_Toc463876543"></a><a name="_Toc463876080"></a><a name="_Toc455070045"></a><a name="_Toc449776677"></a><a name="_STATUS,line,statustext,peername,loc"></a><span style='font-size:12.0pt'>STATUS,line,statustext,peername,localname,endpointtype</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You will receive STATUS notifications when the SIP session state is changed (SIP session state machine changes) or periodically even if there was no any change.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>A typical status strings looks like this:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='color:#548DD4;font-style:normal'>STATUS,line,statustext,peername,localname,endpointtype,peerdisplayname,[callid],online,registered,incall,mute,hold,encrypted,isvideo</span></b></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The <b>line</b> parameter can be -1 for general status or a positive value for the different lines.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>General status means the status for the “best” endpoint.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This means that you will usually see the same status twice (or more). Once for general sip client status and once for line status. </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example you can receive the following two messages consecutively: S<span style='color:black'>TATUS,-1,Connected,…</span></span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You might decide to parse only general status messages (where the line is -1), messages for specific line (where line is zero or positive) or both.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Status notifications are sent on state change but also at a regular interval (so you can see the same notification again and again even if there was no state change).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following <b>statustext</b> values are defined <b>for general status (line set to -1):</b></span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Initializing</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Ready</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Register…</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Registering…</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Register Failed</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Registered</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Accept</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Starting Call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call Initiated</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Calling…</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Ringing…</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Incoming…</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>In Call (xxx sec)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Hangup</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Call Finished </span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Chat</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'>Note: general status means the “best” status among all lines. For example if one line is speaking, then the general status will be “In Call”.</p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'> </p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following <b>statustext</b> values are defined <b>for individual lines</b> (line set to a positive value representing the channel number starting with 1):</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Unknown (you should not receive this)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Init (started)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Ready (sip stack started)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Outband (notify/options/etc. you should skip this)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>Register</span></b><span style='font-style:normal'> (from register endpoints)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Subscribe (presence or BLF)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Chat (IM)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:2.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>CallSetup</span></b><span style='font-style:normal'> (one time event: call begin)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Setup (call init)<b> </b></span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>InProgress (call init)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Routed (call init)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Ringing (SIP 180 received or similar)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:2.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>CallConnect</span></b><span style='font-style:normal'> (one time event: call was just connected)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>InCall (call is connected)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Muted (connected call in muted status)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Hold (connected call in hold status)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Transfer</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Conference</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Speaking (call is connected) </span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Midcall (might be received for transfer, conference, etc. you should treat it like the Speaking status)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:2.0in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><b><span style='font-style:normal'>CallDisconnect</span></b><span style='font-style: normal'> (one time event: call was just disconnected)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Finishing (call is about to be finished. Disconnect message sent: BYE, CANCEL or 400-600 code)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Finished (call is finished. ACK or 200 OK was received or timeout)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Deletable (endpoint is about to be destroyed. You should skip this)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:1.5in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-family:"Courier New";font-style:normal'>o<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Error (you should not receive this)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-size:9.0pt'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>You will usually have to display the call status for the user, and when a call arrives you might have to display an accept/reject button.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For simplified call management, you can just check for the one-time events (CallSetup, CallConnect, CallDisconnect)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Peername</span></b><span style='font-style:normal'> is the other party username (if any)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Localname</span></b><span style='font-style:normal'> is the local user name (or username).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Endpointtype</span></b><span style='font-style:normal'> is 1 from client endpoints and 2 from server endpoints.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Peerdisplayname </span></b><span style='font-style:normal'>is the other party display name if any</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>Optional values (you might not always receive these):</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>CallID</span></b><span style='font-style:normal'>: SIP session id</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Online</span></b><span style='font-style:normal'>: network status. 0 if no network or internet connection, 1 if connectivity detected (always the global status)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Registered</span></b><span style='font-style:normal'>: registration state. 0=unknown,1=not needed,2=yes,3=working yes,4=working unknown,5=working no,6=unregistered, 7+ =no (failed) (always the global status)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>InCall</span></b><span style='font-style:normal'>: phone/line is in call. 0=no,1=setup or ringing,2=speaking</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Mute</span></b><span style='font-style:normal'>: is muted status. 0=no,1=undefined,2=hold,3=other party hold,4=both in hold (or if you wish to simplify: 0 means no, others means yes)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Hold</span></b><span style='font-style:normal'>: is on hold status: 0=no,1= undefined,2=hold,3=other party hold,4=both in hold (or if you wish to simplify: 0 means no, others means yes)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Encrypted</span></b><span style='font-style:normal'>: encryption status: -1: unknown, 0=no,1=partially/weak yes,2=yes,3=always strong (or if you wish to simplify: 0 and -1 means no, others means yes)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><b><span style='font-style:normal'>Isvideo</span></b><span style='font-style:normal'>: set to 1 for video calls (with video media offer). Otherwise 0.</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>For example the following status means that there is an incoming call ringing from 2222 on the first line:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'><span style='color:#548DD4;font-style:normal'>STATUS,1,Ringing,2222,1111,<b>2</b>,Katie,[callid]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>The following status means an outgoing call in progress to 2222 on the second line:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='color:#548DD4;font-style:normal'>STATUS,2,Speaking,2222,1111,<b>1</b>,[callid]</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>To display the “global” phone status, you will have to do the followings:</span></p> <p class="MsoListParagraphCxSpFirst" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>1.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Parse the received string (parameters separated by comma)</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>2.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>If the first parameter is “STATUS” then continue</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>3.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Check the second parameter. It “-1” continue otherwise nothing to do</span></p> <p class="MsoListParagraphCxSpMiddle" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>4.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Display the third parameter (Set the caption of a custom html control)</span></p> <p class="MsoListParagraphCxSpLast" style='margin-top:0in;margin-right:0in; margin-bottom:0in;margin-left:.75in;margin-bottom:.0001pt;text-indent:-.25in; line-height:normal'><span style='font-style:normal'>5.<span style='font:7.0pt "Times New Roman"'> </span></span><span style='font-style:normal'>Depending on the status, you might need to do some other action. For example display your “Hangup” button if the status is between “Setup” and “Finishing” or popup a new window on “Ringing” status if the endpointtype is “2” (for incoming calls only; not for outgoing)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>If the “jsscripstats” is on (set to a value higher than 0) then you will receive extended status messages containing also media parameters at the end of each call:</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> <span style='color:#548DD4'>STATUS,1,Connected,peername,localname,endpointtype,peerdisplayname,<b>rtpsent,rtprec,rtploss,rtplosspercet,serverstats_if_received</b>,[callid]</span></span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node124" id="node124"></a><span style='font-size:12.0pt'>PRESENCE,peername,state,details,displayname,email</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is received for incoming chat messages.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Line: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Peername: username of the peer</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>State and details: presence status string; one of the followings: CallMe,Available,Open,Pending,Other,CallForward,Speaking,Busy,Idle,DoNotDisturb,DND,Unknown,Away,Offline,Closed,Close,Unreacheable,</span><span style='font-size:11.0pt'> </span><span style='font-style:normal'>Unregistered,Invisible,Exists,NotExists,Unknown,Not Set</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Displayname: peer full name (it can be empty)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Email: peer email address (it can be empty)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><u><span style='font-style:normal'>Notes for the state and details fields:</span></u></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>One of these fields might be empty in some circumstances and might not be a string in the above list (especially the details).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>The <span style='color:#984806'>details </span>field will provide a more exact description (for example “Unreachable”) while the <span style='color:#984806'>state </span>field will provide a more exact one (for example “Close”). For this reason if you have a <u>presence control</u> to be changed, check the <span style='color:#984806'>details </span>string first and if you can’t recognize its content, then check the <span style='color:#984806'>state</span> string. For <u>displaying the state as text</u>, you should display the <span style='color:#984806'>details </span>field (and display the <span style='color:#984806'>state </span>field only if the <span style='color:#984806'>details </span>string is empty).</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node125" id="node125"></a><span style='font-size:12.0pt'>BLF,peername,direction,state,callid</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>These notifications are received as an answer for a previous <span style='color:#984806'>checkblf()</span> request or if the <span style='color:#984806'>blfuserlist</span> was set and it represents the call state of the peer.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Peername: username of the peer extension</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>direction: undefined, initiator or receiver</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>state: trying, proceeding, early, confirmed, terminated, unknown or failed</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>callid: option sip call-id of the call</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Toc463878930"></a><a name="_Toc463876901"></a><a name="_Toc463876751"></a><a name="_Toc463876545"></a><a name="_Toc463876082"></a><a name="_Toc455070047"></a><a name="_Toc449776679"><span style='font-size:12.0pt'>CHAT,line,peername,text</span></a></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is received for incoming chat messages.</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Line: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Peername: username of the sender</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Text: the chat message body</span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Toc463878931"></a><a name="_Toc463876902"></a><a name="_Toc463876752"></a><a name="_Toc463876546"></a><a name="_Toc463876083"></a><a name="_Toc455070048"></a><a name="_Toc449776680"><span style='font-size:12.0pt'>CHATCOMPOSING,line,peername,composing</span></a></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification might be received when the other peer start/stop typing (RFC 3994):</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Line: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Peername: username of the sender</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Composing: 0=idle, 1=typing</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Toc463878932"></a><a name="_Toc463876903"></a><a name="_Toc463876753"></a><a name="_Toc463876547"></a><a name="_Toc463876084"></a><a name="_Toc455070049"></a><a name="_Toc449776681"><span style='font-size:12.0pt'>CHATREPORT,line,peername,status,text</span></a></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>This notification is received for the last outgoing chat message to report success/fail:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Line: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Peername: username of the sender</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Status: 0=unknown,1=sending,2=successfully sent,3=failed to send</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Text: failure reason (if Status is 3)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;text-indent: .5in;line-height:normal'> </p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="_Toc463878933"></a><a name="_Toc463876904"></a><a name="_Toc463876754"></a><a name="_Toc463876548"></a><a name="_Toc463876085"></a><a name="_Toc455070050"></a><a name="_Toc449776682"><span style='font-size:12.0pt'>CDR,line,peername,caller,called,peeraddress,connecttime,duration,discparty</span></a></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'>After each call, you will receive a CDR (call detail record) with the following parameters:</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Line: used phone line</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Peername: other party username, phone number or SIP URI</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Caller: the caller party name (our username in case when we are initiated the call, otherwise the remote username, displayname, phone number or URI)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Called: called party name (our username in case when we are receiving the call, otherwise the remote username, phone number or URI)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Peeraddress: other endpoint address (usually the VoIP server IP or domain name)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Connecttime: milliseconds elapsed between call initiation and call connect</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Duration: milliseconds elapsed between call connect and hangup (0 for not connected calls. Divide by 1000 to obtain seconds.)</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Discparty: the party which was initiated the disconnect: 0=not set, 1=local, 2=peer, 3=undefined</span></p> <p class="MsoNormal" style='margin-top:0in;margin-right:0in;margin-bottom:0in; margin-left:.5in;margin-bottom:.0001pt;line-height:normal'><span style='font-style:normal'>Disconnect reason: a text about the reason of the call disconnect (SIP disconnect code, CANCEL, BYE or some other error text)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt;line-height: normal'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node126" id="node126"></a><span style='font-size:12.0pt'>DTMF,line,peername,status,text</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><a name="_Toc463878934"></a><a name="_Toc463876905"></a><a name="_Toc463876755"></a><a name="_Toc463876549"></a><a name="_Toc463876086"></a><a name="_Toc455070051"></a><a name="_Toc449776683"><span style='font-style:normal'>Incoming DTMF notification (the digit is passed in the msg parameter)</span></a></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'> </span></p> <div style='border:none;border-bottom:solid #E5B8B7 1.0pt;padding:0in 0in 2.0pt 0in'> <h6><a name="node127" id="node127"></a><span style='font-size:12.0pt'>VREC,line,stage,type,path,reason</span></h6> </div> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>Voice upload status (for voice recording / call recording).</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>line: channel number (note: with stage 3 and 4 it will always report -1 or -2 means default/not specified)</span></p> <p class="MsoNormal" style='margin-bottom:0in;margin-bottom:.0001pt'><span style='font-style:normal'>stage: 0:disabled, 1:call record begin,2:upload begin, 3: upload success, 4: uplo
