ringcentral-softphone 1.1.8 → 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
 
 ```
@@ -30,8 +33,28 @@ 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/index.js

@@ -89,7 +89,7 @@ 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;

package/dist/esm/index.js

@@ -84,7 +84,7 @@ 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;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ringcentral-softphone",
-  "version": "1.1.8",
+  "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"
 }