swagger updated for call records

* support use sips scheme for outbound tls gateway

* support use sips scheme for outbound tls gateway

* update license

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Drachtio Communications Services, LLC
+Copyright (c) 2018-2024 FirstFive8, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

db/jambones-sql.sql

@@ -459,6 +459,7 @@ outbound BOOLEAN NOT NULL COMMENT 'if true, include in least-cost routing when p
 voip_carrier_sid CHAR(36) NOT NULL,
 is_active BOOLEAN NOT NULL DEFAULT 1,
 send_options_ping BOOLEAN NOT NULL DEFAULT 0,
+use_sips_scheme BOOLEAN NOT NULL DEFAULT 0,
 pad_crypto BOOLEAN NOT NULL DEFAULT 0,
 protocol ENUM('udp','tcp','tls', 'tls/srtp') DEFAULT 'udp' COMMENT 'Outbound call protocol',
 PRIMARY KEY (sip_gateway_sid)

db/jambones.sqs

@@ -2332,7 +2332,7 @@
         </location>
         <size>
             <width>281.00</width>
-            <height>260.00</height>
+            <height>280.00</height>
         </size>
         <zorder>7</zorder>
         <SQLField>
@@ -2406,6 +2406,13 @@
             <notNull><![CDATA[1]]></notNull>
             <uid><![CDATA[E04C19A2-12BF-443F-AB61-96990224A18D]]></uid>
         </SQLField>
+        <SQLField>
+            <name><![CDATA[use_sips_scheme]]></name>
+            <type><![CDATA[BOOLEAN]]></type>
+            <defaultValue><![CDATA[0]]></defaultValue>
+            <notNull><![CDATA[1]]></notNull>
+            <uid><![CDATA[5DCBDD48-913B-4580-B78C-9B06C939FEA8]]></uid>
+        </SQLField>
         <SQLField>
             <name><![CDATA[pad_crypto]]></name>
             <type><![CDATA[BOOLEAN]]></type>
@@ -3111,11 +3118,11 @@
         <SourceSidebarWidth><![CDATA[312.000000]]></SourceSidebarWidth>
         <SQLEditorFileFormatVersion><![CDATA[4]]></SQLEditorFileFormatVersion>
         <uid><![CDATA[58C99A00-06C9-478C-A667-C63842E088F3]]></uid>
-        <windowHeight><![CDATA[1027.000000]]></windowHeight>
-        <windowLocationX><![CDATA[1728.000000]]></windowLocationX>
-        <windowLocationY><![CDATA[65.000000]]></windowLocationY>
+        <windowHeight><![CDATA[1079.000000]]></windowHeight>
+        <windowLocationX><![CDATA[0.000000]]></windowLocationX>
+        <windowLocationY><![CDATA[0.000000]]></windowLocationY>
         <windowScrollOrigin><![CDATA[{1, 0}]]></windowScrollOrigin>
-        <windowWidth><![CDATA[1675.000000]]></windowWidth>
+        <windowWidth><![CDATA[1676.000000]]></windowWidth>
     </SQLDocumentInfo>
     <AllowsIndexRenamingOnInsert><![CDATA[1]]></AllowsIndexRenamingOnInsert>
     <defaultLabelExpanded><![CDATA[1]]></defaultLabelExpanded>

db/upgrade-jambonz-db.js

@@ -196,6 +196,7 @@ const sql = {
     'ALTER TABLE sip_gateways ADD COLUMN send_options_ping BOOLEAN NOT NULL DEFAULT 0',
     'ALTER TABLE applications MODIFY COLUMN speech_synthesis_voice VARCHAR(256)',
     'ALTER TABLE applications MODIFY COLUMN fallback_speech_synthesis_voice VARCHAR(256)',
+    'ALTER TABLE sip_gateways ADD COLUMN use_sips_scheme BOOLEAN NOT NULL DEFAULT 0',
   ]
 };
 

lib/routes/api/speech-credentials.js

@@ -458,6 +458,7 @@ router.put('/:sid', async(req, res) => {
           options,
           deepgram_stt_uri,
           deepgram_stt_use_tls,
+          engine_version
         } = req.body;
 
         const newCred = {
@@ -484,6 +485,7 @@ router.put('/:sid', async(req, res) => {
           options,
           deepgram_stt_uri,
           deepgram_stt_use_tls,
+          engine_version
         };
         logger.info({o, newCred}, 'updating speech credential with this new credential');
         obj.credential = encryptCredential(newCred);

lib/swagger/swagger.yaml

@@ -130,7 +130,71 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/GeneralError'      
+                $ref: '#/components/schemas/GeneralError'
+  /Accounts/{accountSid}/RecentCalls/{callSid}/record/{year}/{month}/{day}/{format}:
+    get:
+      tags:
+        - Call Records
+      summary: 'Retrieve a recording of a recent call in specified format'
+      description: 'Gets the recording of a recent call by specifying the account ID, call ID, the date of the call, and the format of the recording (e.g., MP3 or WAV).'
+      operationId: getRecordingByFormat
+      security:
+        - ApiKeyAuth: [ ]
+      parameters:
+        - name: accountSid
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: callSid
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: year
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: month
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: day
+          in: path
+          required: true
+          schema:
+            type: string
+        - name: format
+          in: path
+          required: true
+          schema:
+            type: string
+            enum:
+              - mp3
+              - wav
+      responses:
+        200:
+          description: Successfully retrieved the recording file.
+          content:
+            audio/*:
+              schema:
+                type: string
+                format: binary
+        404:
+          description: Call record not found
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GeneralError'
+        500:
+          description: System error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GeneralError'
+
   /Sbcs:
     post:
       tags:

lib/utils/speech-utils.js

@@ -183,7 +183,10 @@ const testAwsStt = async(logger, getAwsAuthToken, credentials) => {
     } else if (roleArn) {
       client = new TranscribeClient({
         region,
-        credentials: await getAwsAuthToken(null, null, region, roleArn),
+        credentials: await getAwsAuthToken({
+          region,
+          roleArn
+        }),
       });
     } else {
       client = new TranscribeClient({region});

package-lock.json

@@ -19,7 +19,7 @@
         "@jambonz/lamejs": "^1.2.2",
         "@jambonz/mw-registrar": "^0.2.7",
         "@jambonz/realtimedb-helpers": "^0.8.9",
-        "@jambonz/speech-utils": "^0.1.3",
+        "@jambonz/speech-utils": "^0.1.11",
         "@jambonz/time-series": "^0.2.8",
         "@jambonz/verb-specifications": "^0.0.72",
         "@soniox/soniox-node": "^1.2.2",
@@ -2027,9 +2027,9 @@
       }
     },
     "node_modules/@jambonz/speech-utils": {
-      "version": "0.1.3",
-      "resolved": "https://registry.npmjs.org/@jambonz/speech-utils/-/speech-utils-0.1.3.tgz",
-      "integrity": "sha512-Ess3yc8XyJAoUvXFz9maLq4NgxkTkTgiN2uW3rgOFiRr7b6l9A3oNQrN/ZJCJc9Ge+I3CypFmcwCiLNehuqF/g==",
+      "version": "0.1.11",
+      "resolved": "https://registry.npmjs.org/@jambonz/speech-utils/-/speech-utils-0.1.11.tgz",
+      "integrity": "sha512-VgljBLUF871adib/3yWpzd7kv26ioxiLVkAIxm94CSk9WeZuzX1lVcE2SohojW3mjCYdYY6+B8FRyzlTD+en3g==",
       "dependencies": {
         "@aws-sdk/client-polly": "^3.496.0",
         "@aws-sdk/client-sts": "^3.496.0",

package.json

@@ -29,7 +29,7 @@
     "@jambonz/lamejs": "^1.2.2",
     "@jambonz/mw-registrar": "^0.2.7",
     "@jambonz/realtimedb-helpers": "^0.8.9",
-    "@jambonz/speech-utils": "^0.1.3",
+    "@jambonz/speech-utils": "^0.1.11",
     "@jambonz/time-series": "^0.2.8",
     "@jambonz/verb-specifications": "^0.0.72",
     "@soniox/soniox-node": "^1.2.2",

test/sip-gateways.js

@@ -75,6 +75,44 @@ test('sip gateway tests', async(t) => {
     });
     //console.log(`result: ${JSON.stringify(result)}`);
     t.ok(result.statusCode === 204, 'successfully deleted sip gateway');
+
+    /* add a sip gateway */
+    result = await request.post('/SipGateways', {
+      resolveWithFullResponse: true,
+      auth: authAdmin,
+      json: true,
+      body: {
+        voip_carrier_sid,
+        ipv4: '192.168.1.2',
+        netmask: 32,
+        inbound: true,
+        outbound: true,
+        protocol: 'tls',
+        use_sips_scheme: true
+      }
+    });
+    t.ok(result.statusCode === 201, 'successfully created sip gateway ');
+    const sipsSid = result.body.sid;
+
+    /* query one sip gateway */
+    result = await request.get(`/SipGateways/${sipsSid}`, {
+      auth: authAdmin,
+      json: true,
+    });
+    //console.log(`result: ${JSON.stringify(result)}`);
+    t.ok(result.ipv4 === '192.168.1.2' , 'successfully retrieved voip carrier by sid');
+    t.ok(result.protocol === 'tls' , 'successfully retrieved voip carrier by sid');
+    t.ok(result.use_sips_scheme, 'successfully retrieved voip carrier by sid');
+
+    /* delete sip gateways */
+    result = await request.delete(`/SipGateways/${sipsSid}`, {
+      resolveWithFullResponse: true,
+      simple: false,
+      json: true,
+      auth: authAdmin
+    });
+    //console.log(`result: ${JSON.stringify(result)}`);
+    t.ok(result.statusCode === 204, 'successfully deleted sip gateway');
     
     await deleteObjectBySid(request, '/VoipCarriers', voip_carrier_sid);
 

test/speech-credentials.js

@@ -750,7 +750,7 @@ test('speech credentials tests', async(t) => {
       json: true,
       body: {
         vendor: 'aws',
-        labe: 'aws_polly_with_arn',
+        label: 'aws_polly_with_arn',
         use_for_tts: true,
         use_for_stt: false,
         role_arn: 'Arn::aws::role',
@@ -767,6 +767,58 @@ test('speech credentials tests', async(t) => {
     });
     t.ok(result.statusCode === 204, 'successfully deleted speech credential');
 
+    /* add a credential for verbio */
+    result = await request.post(`/Accounts/${account_sid}/SpeechCredentials`, {
+      resolveWithFullResponse: true,
+      auth: authUser,
+      json: true,
+      body: {
+        vendor: 'verbio',
+        use_for_tts: true,
+        use_for_stt: true,
+        client_id: 'client:id',
+        client_secret: 'client:secret',
+        engine_version: 'V1'
+      }
+    });
+    t.ok(result.statusCode === 201, 'successfully added speech credential for Verbio');
+    const verbioSid = result.body.sid;
+
+    result = await request.get(`/Accounts/${account_sid}/SpeechCredentials/${verbioSid}`, {
+      resolveWithFullResponse: true,
+      simple: false,
+      auth: authAdmin,
+      json: true,
+    });
+    t.ok(result.body.engine_version === "V1", 'successfully get verbio speech credential');
+
+    result = await request.put(`/Accounts/${account_sid}/SpeechCredentials/${verbioSid}`, {
+      resolveWithFullResponse: true,
+      auth: authUser,
+      json: true,
+      body: {
+        use_for_tts: true,
+        use_for_stt: true,
+        engine_version: 'V2'
+      }
+    });
+    t.ok(result.statusCode === 204, 'successfully updated speech credential for verbio');
+
+    result = await request.get(`/Accounts/${account_sid}/SpeechCredentials/${verbioSid}`, {
+      resolveWithFullResponse: true,
+      simple: false,
+      auth: authAdmin,
+      json: true,
+    });
+    t.ok(result.body.engine_version === "V2", 'successfully Updated verbio speech credential');
+
+    /* delete the credential */
+    result = await request.delete(`/Accounts/${account_sid}/SpeechCredentials/${verbioSid}`, {
+      auth: authUser,
+      resolveWithFullResponse: true,
+    });
+    t.ok(result.statusCode === 204, 'successfully deleted speech credential');
+
     /* Check google supportedLanguagesAndVoices */
     result = await request.get(`/Accounts/${account_sid}/SpeechCredentials/speech/supportedLanguagesAndVoices?vendor=google`, {
       resolveWithFullResponse: true,