ringcentral-softphone 1.2.0 → 1.2.2

package/README.md

@@ -138,6 +138,20 @@ For complete examples, see [demos/](demos/)
 - receive audio stream from peer
 - stream local audio to remote peer
 - call transfer
+- hold / unhold
+
+## call transfer
+
+```ts
+await callSession.transfer("12345678987");
+```
+
+## hold / unhold
+
+```ts
+await callSession.hold();
+await callSession.unhold();
+```
 
 ## Audio codec
 
@@ -267,15 +281,16 @@ callSession1.on("rtpPacket", (rtpPacket: RtpPacket) => {
 });
 ```
 
-## Telephony Session ID
+## Telephony Session ID (& Call Party ID)
 
 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
+However, for inbound calls, the SIP server doesn't tell us anything about the
+Telephony Session ID. You may use
+[this workaround](https://github.com/tylerlong/rc-softphone-call-id-test).
 
 ## 🔧 `ignoreTlsCertErrors` (optional)
 
@@ -288,7 +303,7 @@ certificate validation errors when establishing a TLS connection.
 To bypass these errors, you can set the `ignoreTlsCertErrors` flag to `true`:
 
 ```ts
-const phone = new SoftPhone({
+const softphone = new Softphone({
   ...
   ignoreTlsCertErrors: true
 });
@@ -324,6 +339,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/inbound.js

@@ -27,6 +27,7 @@ a=fmtp:101 0-15
 a=sendrecv
 a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${utils_js_1.localKey}
 `.trim();
+        this.sdp = answerSDP;
         const newMessage = new index_js_2.OutboundMessage("SIP/2.0 200 OK", {
             Via: this.sipMessage.headers.Via,
             "Call-ID": this.sipMessage.getHeader("Call-ID"),

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

@@ -21,6 +21,7 @@ declare abstract class CallSession extends EventEmitter {
     decoder: {
         decode: (audio: Buffer) => Buffer;
     };
+    sdp: string;
     ssrc: number;
     sequenceNumber: number;
     timestamp: number;
@@ -35,5 +36,8 @@ declare abstract class CallSession extends EventEmitter {
     protected startLocalServices(): void;
     protected dispose(): void;
     transfer(transferTo: string): Promise<void>;
+    toggleReceive(toReceive: boolean): Promise<void>;
+    hold(): Promise<void>;
+    unhold(): Promise<void>;
 }
 export default CallSession;

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

@@ -23,6 +23,7 @@ class CallSession extends node_events_1.default {
     srtpSession;
     encoder;
     decoder;
+    sdp;
     // for audio streaming
     ssrc = (0, utils_js_1.randomInt)();
     sequenceNumber = (0, utils_js_1.randomInt)();
@@ -192,5 +193,34 @@ class CallSession extends node_events_1.default {
             this.softphone.on("message", notifyHandler);
         });
     }
+    async toggleReceive(toReceive) {
+        let newSDP = this.sdp;
+        if (!toReceive) {
+            newSDP = newSDP.replace(/a=sendrecv/, "a=sendonly");
+        }
+        const requestMessage = new index_js_1.RequestMessage(`INVITE ${(0, utils_js_1.extractAddress)(this.remotePeer)} SIP/2.0`, {
+            "Call-Id": this.callId,
+            From: this.localPeer,
+            To: this.remotePeer,
+            Via: `SIP/2.0/TLS ${this.softphone.client.localAddress}:${this.softphone.client.localPort};rport;branch=${(0, utils_js_1.branch)()};alias`,
+            "Content-Type": "application/sdp",
+            Contact: ` <sip:${this.softphone.sipInfo.username}@${this.softphone.client.localAddress}:${this.softphone.client.localPort};transport=TLS;ob>`,
+        }, newSDP);
+        const replyMessage = await this.softphone.send(requestMessage, true);
+        const ackMessage = new index_js_1.RequestMessage(`ACK ${(0, utils_js_1.extractAddress)(this.remotePeer)} SIP/2.0`, {
+            "Call-Id": this.callId,
+            From: this.localPeer,
+            To: this.remotePeer,
+            Via: replyMessage.headers.Via,
+            CSeq: replyMessage.headers.CSeq.replace(" INVITE", " ACK"),
+        });
+        await this.softphone.send(ackMessage);
+    }
+    async hold() {
+        return this.toggleReceive(false);
+    }
+    async unhold() {
+        return this.toggleReceive(true);
+    }
 }
 exports.default = CallSession;

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

@@ -198,7 +198,9 @@ a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${utils_js_1.localKey}
         const newMessage = inviteMessage.fork();
         newMessage.headers["Proxy-Authorization"] = (0, utils_js_1.generateAuthorization)(this.sipInfo, nonce, "INVITE");
         const progressMessage = await this.send(newMessage, true);
-        return new outbound_js_1.default(this, progressMessage);
+        const outboundCallSession = new outbound_js_1.default(this, progressMessage);
+        outboundCallSession.sdp = offerSDP;
+        return outboundCallSession;
     }
 }
 exports.default = Softphone;

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

@@ -22,6 +22,7 @@ a=fmtp:101 0-15
 a=sendrecv
 a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${localKey}
 `.trim();
+        this.sdp = answerSDP;
         const newMessage = new OutboundMessage("SIP/2.0 200 OK", {
             Via: this.sipMessage.headers.Via,
             "Call-ID": this.sipMessage.getHeader("Call-ID"),

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

@@ -21,6 +21,7 @@ declare abstract class CallSession extends EventEmitter {
     decoder: {
         decode: (audio: Buffer) => Buffer;
     };
+    sdp: string;
     ssrc: number;
     sequenceNumber: number;
     timestamp: number;
@@ -35,5 +36,8 @@ declare abstract class CallSession extends EventEmitter {
     protected startLocalServices(): void;
     protected dispose(): void;
     transfer(transferTo: string): Promise<void>;
+    toggleReceive(toReceive: boolean): Promise<void>;
+    hold(): Promise<void>;
+    unhold(): Promise<void>;
 }
 export default CallSession;

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

@@ -4,7 +4,7 @@ import { Buffer } from "node:buffer";
 import { RtpHeader, RtpPacket, SrtpSession } from "werift-rtp";
 import DTMF from "../dtmf.js";
 import { RequestMessage, ResponseMessage, } from "../sip-message/index.js";
-import { branch, localKey, randomInt } from "../utils.js";
+import { branch, extractAddress, localKey, randomInt } from "../utils.js";
 import Streamer from "./streamer.js";
 class CallSession extends EventEmitter {
     softphone;
@@ -18,6 +18,7 @@ class CallSession extends EventEmitter {
     srtpSession;
     encoder;
     decoder;
+    sdp;
     // for audio streaming
     ssrc = randomInt();
     sequenceNumber = randomInt();
@@ -187,5 +188,34 @@ class CallSession extends EventEmitter {
             this.softphone.on("message", notifyHandler);
         });
     }
+    async toggleReceive(toReceive) {
+        let newSDP = this.sdp;
+        if (!toReceive) {
+            newSDP = newSDP.replace(/a=sendrecv/, "a=sendonly");
+        }
+        const requestMessage = new RequestMessage(`INVITE ${extractAddress(this.remotePeer)} SIP/2.0`, {
+            "Call-Id": this.callId,
+            From: this.localPeer,
+            To: this.remotePeer,
+            Via: `SIP/2.0/TLS ${this.softphone.client.localAddress}:${this.softphone.client.localPort};rport;branch=${branch()};alias`,
+            "Content-Type": "application/sdp",
+            Contact: ` <sip:${this.softphone.sipInfo.username}@${this.softphone.client.localAddress}:${this.softphone.client.localPort};transport=TLS;ob>`,
+        }, newSDP);
+        const replyMessage = await this.softphone.send(requestMessage, true);
+        const ackMessage = new RequestMessage(`ACK ${extractAddress(this.remotePeer)} SIP/2.0`, {
+            "Call-Id": this.callId,
+            From: this.localPeer,
+            To: this.remotePeer,
+            Via: replyMessage.headers.Via,
+            CSeq: replyMessage.headers.CSeq.replace(" INVITE", " ACK"),
+        });
+        await this.softphone.send(ackMessage);
+    }
+    async hold() {
+        return this.toggleReceive(false);
+    }
+    async unhold() {
+        return this.toggleReceive(true);
+    }
 }
 export default CallSession;

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

@@ -193,7 +193,9 @@ a=crypto:1 AES_CM_128_HMAC_SHA1_80 inline:${localKey}
         const newMessage = inviteMessage.fork();
         newMessage.headers["Proxy-Authorization"] = generateAuthorization(this.sipInfo, nonce, "INVITE");
         const progressMessage = await this.send(newMessage, true);
-        return new OutboundCallSession(this, progressMessage);
+        const outboundCallSession = new OutboundCallSession(this, progressMessage);
+        outboundCallSession.sdp = offerSDP;
+        return outboundCallSession;
     }
 }
 export default Softphone;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ringcentral-softphone",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "homepage": "https://github.com/ringcentral/ringcentral-softphone-ts",
   "license": "MIT",
   "types": "dist/esm/index.d.ts",