@telegenta/webclient 3.3.0 → 3.4.1

package/README.md

@@ -50,7 +50,8 @@ remembered there, so you will be prompted for the microphone every time.
 #### Example: phone with a provisioning token
 
 `demos/phone_client.html` is a complete softphone - start/stop, outbound calls, transfer, listen-in,
-incoming calls and the event client.
+incoming calls and the event client. A hosted copy is published with the docs:
+https://www.telegenta.com/docs/webclient/latest/demos/phone_client.html
 
 First create a static API token in the admin interface
 (https://admin.telegenta.com/integration/access-tokens). Open the demo and paste the token in; it then

package/demos/phone_client.html

@@ -116,7 +116,10 @@
 
     <!-- Javascript stuff -->
     <script>
-        const API_URL = 'https://api.telegenta.com/api';
+        // The demo is published with the docs on both www.telegenta.com and www.telegenta-test.com
+        const API_URL = location.hostname.endsWith('telegenta-test.com')
+            ? 'https://api.telegenta-test.com/api'
+            : 'https://api.telegenta.com/api';
         let phoneClient = null;
         let logger;
         let transferSession;
@@ -245,6 +248,9 @@
 
                                 // Enable call initialized tone
                                 playCallInitializedTone: true,
+
+                                // Enable call ended tone
+                                playCallEndedTone: true,
                             };
 
                             try {

package/dist/telegenta.js

@@ -1567,6 +1567,7 @@ const options = {
     autoRemoveSessionTime: 3000,
     playRingOnIncoming: true,
     playCallInitializedTone: false,
+    playCallEndedTone: false,
 };
 
 // DTMF Frequency table
@@ -1603,6 +1604,11 @@ const ST_CALLINIT = [
     { d: 200, f1: 500, f2: 0, g: 0 },
     { d: 200, f1: 700, f2: 0, g: 5000 },
 ];
+const ST_CALLENDED = [
+    { d: 150, f1: 600, f2: 0, g: 50 },
+    { d: 150, f1: 500, f2: 0, g: 50 },
+    { d: 150, f1: 400, f2: 0, g: 0 },
+];
 const ST_RINGBACK = [{ d: 1000, f1: 425, f2: 0, g: 4000 }];
 const ST_INCOMING = [
     { d: 150, f1: 400, f2: 0, g: 0 },
@@ -1783,6 +1789,7 @@ class Phone extends EventEmitter {
      * @param {number} [phoneOptions.autoRemoveSessionTime=3000] Automatically remove session after interval specified
      * @param {number} [phoneOptions.playRingOnIncoming=true] Play ringing tones on incoming calls
      * @param {number} [phoneOptions.playCallInitializedTone=false] Play tone when call has been initiated (before progress/ringback tones)
+     * @param {boolean} [phoneOptions.playCallEndedTone=false] Play tone once when an answered call ends without the agent hanging up (remote hangup, server hangup, connection loss, timeouts)
      *
      * @throws MediaNotPrepared - If {@link prepareMedia} was not called and resolved prior to calling this method
      * @throws InvalidOptions - If one or more options are invalid
@@ -2218,14 +2225,18 @@ class Phone extends EventEmitter {
 
         // Set timer to stop tone again
         const self = this;
-        this._toneTimer = setTimeout(function () {
-            self.stopTone();
+        const timer = setTimeout(function () {
+            // A later playTone() has taken over the oscillators; don't silence it or cancel its timer
+            if (self._toneTimer === timer) {
+                self.stopTone();
+            }
 
             // Handle callback now
             if (callback) {
                 callback();
             }
         }, duration);
+        this._toneTimer = timer;
     }
 
     /**
@@ -2268,6 +2279,18 @@ class Phone extends EventEmitter {
         }
     }
 
+    // Play a tone sequence once. A repeat tone starting meanwhile (e.g. a new call's ringing) cancels the rest.
+    _playToneSequence(sequence, pos = 0) {
+        const toneDef = sequence[pos];
+        if (!toneDef || this._repeatToneActive) {
+            return;
+        }
+        const self = this;
+        this.playTone(toneDef.d, toneDef.f1, toneDef.f2, function () {
+            setTimeout(self._playToneSequence.bind(self, sequence, pos + 1), toneDef.g);
+        });
+    }
+
     // End repeating tones
     _endRepeatTone() {
         if (this._repeatToneActive) {
@@ -2597,6 +2620,8 @@ class Session extends EventEmitter {
         this._isListenCall = false;
         this._whisperMode = null;
         this._manualDisposition = null;
+        this._transferInitiated = false;
+        this._voicemailDrop = false;
 
         // Quality report
         this._rtcpStatsTimer = null;
@@ -2863,10 +2888,18 @@ class Session extends EventEmitter {
             self._setSessionState('ACTIVE');
         });
 
-        this._webRTCSession.on('ended', function (/* data */) {
+        this._webRTCSession.on('ended', function (data) {
             // End any ringsbacks if needed
             self._phone._endRepeatTone();
 
+            // jssip fires 'ended' once a call is answered. Its own errors (connection loss, timeouts, ICE failure)
+            // also end as 'local' but with their own cause, so only a local BYE is the agent hanging up.
+            const agentHangup = data.originator === 'local' && data.cause === JsSIP.C.causes.BYE;
+            const agentEnded = agentHangup || self._transferInitiated || self._voicemailDrop;
+            if (self._phone.options.playCallEndedTone && !agentEnded) {
+                self._phone._playToneSequence(ST_CALLENDED);
+            }
+
             self._callEndTime = Date.now();
 
             // Clear answer call timeout timer if needed
@@ -3308,6 +3341,10 @@ class Session extends EventEmitter {
     transfer(dstSession) {
         this.log.info(`Transferring ${this.uuid} => ${dstSession.uuid}`);
 
+        // The server hangs up both legs once the transfer completes - that's the agent's doing, no call-ended tone
+        this._transferInitiated = true;
+        dstSession._transferInitiated = true;
+
         // Create ReferSubscriber event class
         const referSubscriber = this._webRTCSession.refer(this._webRTCSession._request.ruri, {
             replaces: dstSession._webRTCSession,
@@ -3322,10 +3359,15 @@ class Session extends EventEmitter {
 
         referSubscriber.on('requestFailed', function (cause) {
             self.log.error(`Transfer rejected: ${cause}`);
+            // Legs stay up, so a later hangup by the other party should get the cue
+            self._transferInitiated = false;
+            dstSession._transferInitiated = false;
         });
 
         referSubscriber.on('failed', function (cause) {
             self.log.error(`Transfer failed: ${cause}`);
+            self._transferInitiated = false;
+            dstSession._transferInitiated = false;
         });
     }
 
@@ -3356,6 +3398,9 @@ class Session extends EventEmitter {
 
         // When playback is acknowledged and 'hangup_after' is true, we set session state into PLAYBACK
         if (hangup_after) {
+            // The server hangs up after the voicemail drop - that's the agent's doing, no call-ended tone
+            this._voicemailDrop = true;
+
             // Stop remote audio
             this._phone._remoteAudioElement.srcObject = null;
 
@@ -3363,10 +3408,16 @@ class Session extends EventEmitter {
             this._webRTCSession.mute();
 
             // When playback starts set state to playback
-            p.then(() => {
-                // Set session state
-                this._setSessionState('PLAYBACK');
-            });
+            p.then(
+                () => {
+                    // Set session state
+                    this._setSessionState('PLAYBACK');
+                },
+                () => {
+                    // Call stays up, so a later hangup by the other party should get the cue
+                    this._voicemailDrop = false;
+                }
+            );
         }
 
         return p;