ringcentral-softphone 1.1.12 → 1.2.1

package/README.md

@@ -271,12 +271,34 @@ callSession1.on("rtpPacket", (rtpPacket: RtpPacket) => {
 
 For outbound calls, you will be able to find header like this
 `p-rc-api-ids: party-id=p-a0d17e323f0fez1953f50f90dz296e3440000-1;session-id=s-a0d17e323f0fez1953f50f90dz296e3440000`
-from `callSession.sipMessage.headers`.
+from `outbounCallSession.sipMessage.headers`. I have added two sugar methods:
+`outboundCallSession.sessionId` and `outboundCallSession.partyId`.
 
 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
 
+## 🔧 `ignoreTlsCertErrors` (optional)
+
+Most developers **do not need this option**.
+
+However, in rare cases — such as testing in a **lab or development environment**
+with self-signed or improperly configured TLS certificates — you may encounter
+certificate validation errors when establishing a TLS connection.
+
+To bypass these errors, you can set the `ignoreTlsCertErrors` flag to `true`:
+
+```ts
+const softphone = new Softphone({
+  ...
+  ignoreTlsCertErrors: true
+});
+```
+
+> ⚠️ Warning: Enabling this option disables certificate verification and makes
+> the TLS connection vulnerable to man-in-the-middle (MITM) attacks. Use only in
+> trusted, controlled environments — never in production.
+
 ## Troubleshooting (Common issues)
 
 ### `SIP/2.0 486 Busy Here` for outbound call
@@ -303,6 +325,14 @@ Content below is for the maintainer/contributor of this SDK.
 - Caller Id feature is not supported. `P-Asserted-Identity` doesn't work. I
   think it is by design, since hardphone cannot support it.
 
+## Conferences
+
+Conference involves RESTful API which is out of scope of this SDK. With this
+being said, this SDK works well with conferences. Here is a
+[demo project for this SDK work with conferences](https://github.com/tylerlong/softphone-invite-agent-to-conference-demo).
+The demo is about making a call to a call queue number, it would be even simpler
+if there is no call queue.
+
 #### Code style
 
 We use `deno fmt && deno lint --fix` to format and lint all code.

package/dist/cjs/call-session/outbound.d.ts

@@ -5,5 +5,7 @@ declare class OutboundCallSession extends CallSession {
     constructor(softphone: Softphone, answerMessage: InboundMessage);
     init(): void;
     cancel(): Promise<void>;
+    get sessionId(): string;
+    get partyId(): string;
 }
 export default OutboundCallSession;

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

@@ -52,5 +52,15 @@ class OutboundCallSession extends index_js_1.default {
         });
         await this.softphone.send(requestMessage);
     }
+    get sessionId() {
+        const header = this.sipMessage.headers["p-rc-api-ids"];
+        let match = header.match(/party-id=([^;]+);session-id=([^;]+)/);
+        return match[2];
+    }
+    get partyId() {
+        const header = this.sipMessage.headers["p-rc-api-ids"];
+        let match = header.match(/party-id=([^;]+);session-id=([^;]+)/);
+        return match[1];
+    }
 }
 exports.default = OutboundCallSession;

package/dist/cjs/index.js

@@ -39,7 +39,11 @@ class Softphone extends node_events_1.default {
             this.sipInfo.outboundProxy = "sip10.ringcentral.com:5096";
         }
         const tokens = this.sipInfo.outboundProxy.split(":");
-        this.client = node_tls_1.default.connect({ host: tokens[0], port: parseInt(tokens[1], 10) }, () => {
+        this.client = node_tls_1.default.connect({
+            host: tokens[0],
+            port: parseInt(tokens[1], 10),
+            rejectUnauthorized: !this.sipInfo.ignoreTlsCertErrors,
+        }, () => {
             this.connected = true;
         });
         let cache = "";

package/dist/cjs/types.d.ts

@@ -5,4 +5,5 @@ export type SoftPhoneOptions = {
     password: string;
     authorizationId: string;
     codec?: "OPUS/16000" | "OPUS/48000/2" | "PCMU/8000";
+    ignoreTlsCertErrors?: boolean;
 };

package/dist/esm/call-session/outbound.d.ts

@@ -5,5 +5,7 @@ declare class OutboundCallSession extends CallSession {
     constructor(softphone: Softphone, answerMessage: InboundMessage);
     init(): void;
     cancel(): Promise<void>;
+    get sessionId(): string;
+    get partyId(): string;
 }
 export default OutboundCallSession;

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

@@ -47,5 +47,15 @@ class OutboundCallSession extends CallSession {
         });
         await this.softphone.send(requestMessage);
     }
+    get sessionId() {
+        const header = this.sipMessage.headers["p-rc-api-ids"];
+        let match = header.match(/party-id=([^;]+);session-id=([^;]+)/);
+        return match[2];
+    }
+    get partyId() {
+        const header = this.sipMessage.headers["p-rc-api-ids"];
+        let match = header.match(/party-id=([^;]+);session-id=([^;]+)/);
+        return match[1];
+    }
 }
 export default OutboundCallSession;

package/dist/esm/index.js

@@ -34,7 +34,11 @@ class Softphone extends EventEmitter {
             this.sipInfo.outboundProxy = "sip10.ringcentral.com:5096";
         }
         const tokens = this.sipInfo.outboundProxy.split(":");
-        this.client = tls.connect({ host: tokens[0], port: parseInt(tokens[1], 10) }, () => {
+        this.client = tls.connect({
+            host: tokens[0],
+            port: parseInt(tokens[1], 10),
+            rejectUnauthorized: !this.sipInfo.ignoreTlsCertErrors,
+        }, () => {
             this.connected = true;
         });
         let cache = "";

package/dist/esm/types.d.ts

@@ -5,4 +5,5 @@ export type SoftPhoneOptions = {
     password: string;
     authorizationId: string;
     codec?: "OPUS/16000" | "OPUS/48000/2" | "PCMU/8000";
+    ignoreTlsCertErrors?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ringcentral-softphone",
-  "version": "1.1.12",
+  "version": "1.2.1",
   "homepage": "https://github.com/ringcentral/ringcentral-softphone-ts",
   "license": "MIT",
   "types": "dist/esm/index.d.ts",
@@ -35,9 +35,9 @@
     "werift-rtp": "^0.8.4"
   },
   "devDependencies": {
-    "@types/node": "^22.15.29",
+    "@types/node": "^24.0.15",
     "dotenv-override-true": "^6.2.2",
-    "tsx": "^4.19.4",
+    "tsx": "^4.20.3",
     "typescript": "^5.8.3",
     "yarn-upgrade-all": "^0.7.5"
   },