Webphone usage

Home

Note : Il est également possible de configurer une adresse proxy (sortante) et un nom d'utilisateur sip / nom d'utilisateur authentifié différent. Ces paramètres peuvent également être demandés sur la page de connexion de l'interface utilisateur du softphone

JavaScript API

The public JavaScript API can be found in "webphone_api.js" file, under global javascript namespace "webphone_api". 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. Simple example:

<head>
      
      <script src="webphone_api.js"></script>
</head>
<body>
      <script>
      // IMPORTANT: Wait until the webphone is loaded, before calling any API functions
      webphone_api.onAppStateChange(function (state) {
      if (state === 'loaded') {

            //set parameters (alternatively these can be also preset in your html)
            webphone_api.setparameter('serveraddress', SERVERADDRESS); // Replace the word in uppercase with your SIP server IP or domain name (add also the :port number if not using the standard UDP 5060)
            webphone_api.setparameter('username', USERNAME); // Replace the word in uppercase with a valid SIP extension username
            webphone_api.setparameter('password', PASSWORD); // Replace the word in uppercase with the password for the above user
            //see the "Parameters" section in the documentation for more options

            //start the webphone (optional but recommended)
            webphone_api.start();
            //make a call (usually initiated by user action, such as click on a click to call button)
            webphone_api.call(number);
            //hangup
            webphone_api.hangup();
            //send instant message
            webphone_api.sendchat(number, message);
      }
      });
      </script>
</body>

For more details consult the Javascript API section in the documentation.