ringcentral-softphone 1.1.7 → 1.1.9

package/README.md

@@ -6,6 +6,9 @@ the
 
 Users are recommended to use this SDK instead of the JavaScript SDK.
 
+This SDK allows you to create a softphone without GUI that runs on server-side
+without a web browser.
+
 ## Installation
 
 ```
@@ -19,19 +22,39 @@ yarn install ringcentral-softphone
 1. Login to https://service.ringcentral.com
 2. Find the user/extension you want to use
 3. Check the user's "Devices & Numbers"
-4. Find a phone/device that you want to use
-5. if there is none, you need to create one. Check steps below for more details
-6. Click the "Set Up and Provision" button
-7. Click the link "Set up manually using SIP"
-8. You will find "SIP Domain", "Outbound Proxy", "User Name", "Password" and
+4. Find a phone/device that you want to use (Phone type **must** be "Existing
+   Phone"), if there is none, you need to create one.
+5. Click the "Set Up and Provision" button
+6. Click the link "Set up manually using SIP"
+7. You will find "SIP Domain", "Outbound Proxy", "User Name", "Password" and
    "Authorization ID"
 
 Please note that, "SIP Domain" name should come without port number. I don't
 know why it shows a port number on the page. This SDK requires a "domain" which
 is "SIP Domain" but without the port number.
 
+Please also note that, not every device/phone can be used with the softphone
+SDK. Some phones/devices with type "RingCentral Phone app" cannot be used with
+the softphone SDK. You will need to have a device/phone with type **"Exsting
+Phone"**.
+
 ### Programmatically
 
+Invoke this API to list all devices under an extension:
+https://developers.ringcentral.com/api-reference/Devices/listExtensionDevices
+
+Please note that, not every device can be used for this softphone SDK. You will
+need to find an device with **`type: 'OtherPhone'`**. Devices with
+`type: 'SoftPhone'` can **NOT** be used for this softphone SDK.
+
+I know this is confusing. `type: 'SoftPhone'` in API response is the same as
+`type = "RingCentral Phone app"` in the GUI (mentioned in the Manually section
+above). `type: 'OtherPhone'` in API response is the same as
+`type = "Exiting Phone"` in the GUI.
+
+If you cannot find an appropriate device, you will need to create a device
+manually. Please refer to the previous section.
+
 Invoke this RESTful API:
 https://developers.ringcentral.com/api-reference/Devices/readDeviceSipInfo
 
@@ -246,6 +269,18 @@ However, for inbound calls, the server doesn't tell us anything about the
 Telephony Session ID. Here is a workaround solution:
 https://github.com/tylerlong/rc-softphone-call-id-test
 
+## Troubleshooting (Common issues)
+
+### `SIP/2.0 486 Busy Here` for outbound call
+
+First of all, make sure that the target number is valid. If the target number is
+invalid, you will get `SIP/2.0 486 Busy Here`.
+
+Secondly, make sure that the device has a "Emergency Address" configured and
+there is no complains about Emergency address by checking the details of the
+device on https://service.ringcentral.com. It is an known issue that, if the
+Emergency Address is not configured properly, outbound call will not work.
+
 ---
 
 ## Dev Notes

package/dist/cjs/call-session/inbound.js

@@ -29,7 +29,7 @@ a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${utils_js_1.localKey}
 `.trim();
         const newMessage = new index_js_2.OutboundMessage("SIP/2.0 200 OK", {
             Via: this.sipMessage.headers.Via,
-            "Call-ID": this.sipMessage.headers["Call-ID"],
+            "Call-ID": this.sipMessage.getHeader("Call-ID"),
             From: this.sipMessage.headers.From,
             To: this.sipMessage.headers.To,
             CSeq: this.sipMessage.headers.CSeq,

package/dist/cjs/call-session/index.js

@@ -50,7 +50,7 @@ class CallSession extends node_events_1.default {
         });
     }
     get callId() {
-        return this.sipMessage.headers["Call-ID"];
+        return this.sipMessage.getHeader("Call-ID");
     }
     send(data) {
         this.socket.send(data, this.remotePort, this.remoteIP);
@@ -143,7 +143,7 @@ class CallSession extends node_events_1.default {
         // send a message to remote server so that it knows where to reply
         this.send("hello");
         const byeHandler = (inboundMessage) => {
-            if (inboundMessage.headers["Call-ID"] !== this.callId) {
+            if (inboundMessage.getHeader("Call-ID") !== this.callId) {
                 return;
             }
             if (inboundMessage.headers.CSeq.endsWith(" BYE")) {

package/dist/cjs/index.js

@@ -80,8 +80,7 @@ class Softphone extends node_events_1.default {
                 // sometimes the server will return 200 OK directly
                 return;
             }
-            const wwwAuth = inboundMessage.headers["Www-Authenticate"] ||
-                inboundMessage.headers["WWW-Authenticate"];
+            const wwwAuth = inboundMessage.getHeader("Www-Authenticate");
             const nonce = wwwAuth.match(/, nonce="(.+?)"/)[1];
             const newMessage = requestMessage.fork();
             newMessage.headers.Authorization = (0, utils_js_1.generateAuthorization)(this.sipInfo, nonce, "REGISTER");
@@ -90,14 +89,14 @@ class Softphone extends node_events_1.default {
         await sipRegister();
         this.intervalHandle = setInterval(() => {
             sipRegister();
-        }, 3 * 60 * 1000);
+        }, 30 * 1000);
         this.on("message", (inboundMessage) => {
             if (!inboundMessage.subject.startsWith("INVITE sip:")) {
                 return;
             }
             const outboundMessage = new index_js_1.OutboundMessage("SIP/2.0 100 Trying", {
                 Via: inboundMessage.headers.Via,
-                "Call-ID": inboundMessage.headers["Call-ID"],
+                "Call-ID": inboundMessage.getHeader("Call-ID"),
                 From: inboundMessage.headers.From,
                 To: inboundMessage.headers.To,
                 CSeq: inboundMessage.headers.CSeq,
@@ -181,7 +180,7 @@ a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${utils_js_1.localKey}
             "Content-Type": "application/sdp",
         }, offerSDP);
         const inboundMessage = await this.send(inviteMessage, true);
-        const proxyAuthenticate = inboundMessage.headers["Proxy-Authenticate"];
+        const proxyAuthenticate = inboundMessage.getHeader("Proxy-Authenticate");
         const nonce = proxyAuthenticate.match(/, nonce="(.+?)"/)[1];
         const newMessage = inviteMessage.fork();
         newMessage.headers["Proxy-Authorization"] = (0, utils_js_1.generateAuthorization)(this.sipInfo, nonce, "INVITE");

package/dist/cjs/sip-message/sip-message.d.ts

@@ -6,5 +6,6 @@ declare class SipMessage {
     body: string;
     constructor(subject?: string, headers?: {}, body?: string);
     toString(): string;
+    getHeader(key: string): string | undefined;
 }
 export default SipMessage;

package/dist/cjs/sip-message/sip-message.js

@@ -24,5 +24,11 @@ class SipMessage {
         ].join("\r\n");
         return r;
     }
+    getHeader(key) {
+        const foundKey = Object.keys(this.headers).find((k) => k.toLowerCase() === key.toLowerCase());
+        if (foundKey) {
+            return this.headers[foundKey];
+        }
+    }
 }
 exports.default = SipMessage;

package/dist/esm/call-session/inbound.js

@@ -24,7 +24,7 @@ a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${localKey}
 `.trim();
         const newMessage = new OutboundMessage("SIP/2.0 200 OK", {
             Via: this.sipMessage.headers.Via,
-            "Call-ID": this.sipMessage.headers["Call-ID"],
+            "Call-ID": this.sipMessage.getHeader("Call-ID"),
             From: this.sipMessage.headers.From,
             To: this.sipMessage.headers.To,
             CSeq: this.sipMessage.headers.CSeq,

package/dist/esm/call-session/index.js

@@ -45,7 +45,7 @@ class CallSession extends EventEmitter {
         });
     }
     get callId() {
-        return this.sipMessage.headers["Call-ID"];
+        return this.sipMessage.getHeader("Call-ID");
     }
     send(data) {
         this.socket.send(data, this.remotePort, this.remoteIP);
@@ -138,7 +138,7 @@ class CallSession extends EventEmitter {
         // send a message to remote server so that it knows where to reply
         this.send("hello");
         const byeHandler = (inboundMessage) => {
-            if (inboundMessage.headers["Call-ID"] !== this.callId) {
+            if (inboundMessage.getHeader("Call-ID") !== this.callId) {
                 return;
             }
             if (inboundMessage.headers.CSeq.endsWith(" BYE")) {

package/dist/esm/index.js

@@ -75,8 +75,7 @@ class Softphone extends EventEmitter {
                 // sometimes the server will return 200 OK directly
                 return;
             }
-            const wwwAuth = inboundMessage.headers["Www-Authenticate"] ||
-                inboundMessage.headers["WWW-Authenticate"];
+            const wwwAuth = inboundMessage.getHeader("Www-Authenticate");
             const nonce = wwwAuth.match(/, nonce="(.+?)"/)[1];
             const newMessage = requestMessage.fork();
             newMessage.headers.Authorization = generateAuthorization(this.sipInfo, nonce, "REGISTER");
@@ -85,14 +84,14 @@ class Softphone extends EventEmitter {
         await sipRegister();
         this.intervalHandle = setInterval(() => {
             sipRegister();
-        }, 3 * 60 * 1000);
+        }, 30 * 1000);
         this.on("message", (inboundMessage) => {
             if (!inboundMessage.subject.startsWith("INVITE sip:")) {
                 return;
             }
             const outboundMessage = new OutboundMessage("SIP/2.0 100 Trying", {
                 Via: inboundMessage.headers.Via,
-                "Call-ID": inboundMessage.headers["Call-ID"],
+                "Call-ID": inboundMessage.getHeader("Call-ID"),
                 From: inboundMessage.headers.From,
                 To: inboundMessage.headers.To,
                 CSeq: inboundMessage.headers.CSeq,
@@ -176,7 +175,7 @@ a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${localKey}
             "Content-Type": "application/sdp",
         }, offerSDP);
         const inboundMessage = await this.send(inviteMessage, true);
-        const proxyAuthenticate = inboundMessage.headers["Proxy-Authenticate"];
+        const proxyAuthenticate = inboundMessage.getHeader("Proxy-Authenticate");
         const nonce = proxyAuthenticate.match(/, nonce="(.+?)"/)[1];
         const newMessage = inviteMessage.fork();
         newMessage.headers["Proxy-Authorization"] = generateAuthorization(this.sipInfo, nonce, "INVITE");

package/dist/esm/sip-message/sip-message.d.ts

@@ -6,5 +6,6 @@ declare class SipMessage {
     body: string;
     constructor(subject?: string, headers?: {}, body?: string);
     toString(): string;
+    getHeader(key: string): string | undefined;
 }
 export default SipMessage;

package/dist/esm/sip-message/sip-message.js

@@ -22,5 +22,11 @@ class SipMessage {
         ].join("\r\n");
         return r;
     }
+    getHeader(key) {
+        const foundKey = Object.keys(this.headers).find((k) => k.toLowerCase() === key.toLowerCase());
+        if (foundKey) {
+            return this.headers[foundKey];
+        }
+    }
 }
 export default SipMessage;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ringcentral-softphone",
-  "version": "1.1.7",
+  "version": "1.1.9",
   "homepage": "https://github.com/ringcentral/ringcentral-softphone-ts",
   "license": "MIT",
   "types": "dist/esm/index.d.ts",
@@ -34,10 +34,11 @@
     "werift-rtp": "^0.8.4"
   },
   "devDependencies": {
-    "@types/node": "^22.13.14",
+    "@types/node": "^22.15.18",
     "dotenv-override-true": "^6.2.2",
-    "tsx": "^4.19.3",
-    "typescript": "^5.8.2",
+    "tsx": "^4.19.4",
+    "typescript": "^5.8.3",
     "yarn-upgrade-all": "^0.7.5"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }