Filter phone numbers result (#227)

Co-authored-by: eglehelms <e.helms@cognigy.com>
Co-authored-by: Hoan Luu Huu <110280845+xquanluu@users.noreply.github.com>

db/jambones-sql.sql

@@ -484,12 +484,12 @@ speech_recognizer_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
 speech_recognizer_language VARCHAR(64) NOT NULL DEFAULT 'en-US',
 speech_recognizer_label VARCHAR(64),
 use_for_fallback_speech BOOLEAN DEFAULT false,
-fallback_speech_synthesis_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
-fallback_speech_synthesis_language VARCHAR(12) NOT NULL DEFAULT 'en-US',
+fallback_speech_synthesis_vendor VARCHAR(64),
+fallback_speech_synthesis_language VARCHAR(12),
 fallback_speech_synthesis_voice VARCHAR(64),
 fallback_speech_synthesis_label VARCHAR(64),
-fallback_speech_recognizer_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
-fallback_speech_recognizer_language VARCHAR(64) NOT NULL DEFAULT 'en-US',
+fallback_speech_recognizer_vendor VARCHAR(64),
+fallback_speech_recognizer_language VARCHAR(64),
 fallback_speech_recognizer_label VARCHAR(64),
 created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
 record_all_calls BOOLEAN NOT NULL DEFAULT false,

db/jambones.sqs

@@ -2354,7 +2354,7 @@
             <y>917.00</y>
         </location>
         <size>
-            <width>363.00</width>
+            <width>345.00</width>
             <height>540.00</height>
         </size>
         <zorder>0</zorder>
@@ -2509,15 +2509,13 @@
         <SQLField>
             <name><![CDATA[fallback_speech_synthesis_vendor]]></name>
             <type><![CDATA[VARCHAR(64)]]></type>
-            <defaultValue><![CDATA[google]]></defaultValue>
-            <notNull><![CDATA[1]]></notNull>
+            <notNull><![CDATA[0]]></notNull>
             <uid><![CDATA[26BBDEEF-E179-4280-9917-6F2BD6367459]]></uid>
         </SQLField>
         <SQLField>
             <name><![CDATA[fallback_speech_synthesis_language]]></name>
             <type><![CDATA[VARCHAR(12)]]></type>
-            <defaultValue><![CDATA[en-US]]></defaultValue>
-            <notNull><![CDATA[1]]></notNull>
+            <notNull><![CDATA[0]]></notNull>
             <uid><![CDATA[E008D6D7-9BB7-4372-8B46-F92C0EB15082]]></uid>
         </SQLField>
         <SQLField>
@@ -2535,15 +2533,13 @@
         <SQLField>
             <name><![CDATA[fallback_speech_recognizer_vendor]]></name>
             <type><![CDATA[VARCHAR(64)]]></type>
-            <defaultValue><![CDATA[google]]></defaultValue>
-            <notNull><![CDATA[1]]></notNull>
+            <notNull><![CDATA[0]]></notNull>
             <uid><![CDATA[14ECF5EA-81C5-4EAE-9575-9785CEB672E6]]></uid>
         </SQLField>
         <SQLField>
             <name><![CDATA[fallback_speech_recognizer_language]]></name>
             <type><![CDATA[VARCHAR(64)]]></type>
-            <defaultValue><![CDATA[en-US]]></defaultValue>
-            <notNull><![CDATA[1]]></notNull>
+            <notNull><![CDATA[0]]></notNull>
             <uid><![CDATA[EC792500-6B2B-4E54-AA89-43E7A0FD8642]]></uid>
         </SQLField>
         <SQLField>

lib/models/phone-number.js

@@ -16,7 +16,7 @@ class PhoneNumber extends Model {
   }
 
   static async retrieveAll(account_sid) {
-    if (!account_sid) return super.retrieveAll();
+    if (!account_sid) return await super.retrieveAll();
     const [rows] = await promisePool.query(sql, account_sid);
     return rows;
   }

lib/routes/api/accounts.js

@@ -176,6 +176,7 @@ function validateUpdateCall(opts) {
     'child_call_hook',
     'call_status',
     'listen_status',
+    'transcribe_status',
     'conf_hold_status',
     'conf_mute_status',
     'mute_status',

lib/routes/api/phone-numbers.js

@@ -94,9 +94,9 @@ decorate(router, PhoneNumber, ['add', 'update', 'delete'], preconditions);
 router.get('/', async(req, res) => {
   const logger = req.app.locals.logger;
   try {
-    const results = req.user.hasAdminAuth ?
-      await PhoneNumber.retrieveAll(req.user.hasAccountAuth ? req.user.account_sid : null) :
-      await PhoneNumber.retrieveAllForSP(req.user.service_provider_sid);
+    const results = req.user.hasServiceProviderAuth ?
+      await PhoneNumber.retrieveAllForSP(req.user.service_provider_sid) :
+      await PhoneNumber.retrieveAll(req.user.hasAccountAuth ? req.user.account_sid : null);
     res.status(200).json(results);
   } catch (err) {
     sysError(logger, res, err);
@@ -120,6 +120,9 @@ router.get('/:sid', async(req, res) => {
         throw new DbErrorBadRequest('insufficient privileges');
       }
     }
+    if (req.user.hasAccountAuth && results.length > 1) {
+      return res.status(200).json(results.filter((r) => r.phone_number_sid === sid)[0]);
+    }
     return res.status(200).json(results[0]);
   }
   catch (err) {

lib/routes/api/recent-calls.js

@@ -4,7 +4,14 @@ const {DbErrorBadRequest} = require('../../utils/errors');
 const {getHomerApiKey, getHomerSipTrace, getHomerPcap} = require('../../utils/homer-utils');
 const {getJaegerTrace} = require('../../utils/jaeger-utils');
 const Account = require('../../models/account');
-const { getS3Object, getGoogleStorageObject, getAzureStorageObject } = require('../../utils/storage-utils');
+const {
+  getS3Object,
+  getGoogleStorageObject,
+  getAzureStorageObject,
+  deleteS3Object,
+  deleteGoogleStorageObject,
+  deleteAzureStorageObject
+} = require('../../utils/storage-utils');
 
 const parseAccountSid = (url) => {
   const arr = /Accounts\/([^\/]*)/.exec(url);
@@ -146,10 +153,51 @@ router.get('/:call_sid/record/:year/:month/:day/:format', async(req, res) => {
     res.set({
       'Content-Type': `audio/${format || 'mp3'}`
     });
-    stream.pipe(res);
+    if (stream) {
+      stream.pipe(res);
+    } else {
+      return res.sendStatus(404);
+    }
   }  catch (err) {
     logger.error({err}, ` error retrieving recording ${call_sid}`);
     res.sendStatus(404);
   }
 });
+
+router.delete('/:call_sid/record/:year/:month/:day/:format', async(req, res) => {
+  const {logger} = req.app.locals;
+  const {call_sid, year, month, day, format} = req.params;
+
+  try {
+    const account_sid = parseAccountSid(req.originalUrl);
+    const r = await Account.retrieve(account_sid);
+    if (r.length === 0 || !r[0].bucket_credential) return res.sendStatus(404);
+    const {bucket_credential} = r[0];
+
+    const deleteOptions  = {
+      ...bucket_credential,
+      key: `${year}/${month}/${day}/${call_sid}.${format || 'mp3'}`
+    };
+
+    switch (bucket_credential.vendor) {
+      case 'aws_s3':
+        await deleteS3Object(logger, deleteOptions);
+        break;
+      case 'google':
+        await deleteGoogleStorageObject(logger, deleteOptions);
+        break;
+      case 'azure':
+        await deleteAzureStorageObject(logger, deleteOptions);
+        break;
+      default:
+        logger.error(`There is no handler for deleting record from ${bucket_credential.vendor}`);
+        return res.sendStatus(500);
+    }
+
+    res.sendStatus(204);
+  }  catch (err) {
+    logger.error({err}, ` error deleting recording ${call_sid}`);
+    res.sendStatus(404);
+  }
+});
 module.exports = router;

lib/routes/api/speech-credentials.js

@@ -114,8 +114,10 @@ const encryptCredential = (obj) => {
     nuance_stt_uri,
     use_custom_tts,
     custom_tts_endpoint,
+    custom_tts_endpoint_url,
     use_custom_stt,
     custom_stt_endpoint,
+    custom_stt_endpoint_url,
     tts_api_key,
     tts_region,
     stt_api_key,
@@ -147,15 +149,19 @@ const encryptCredential = (obj) => {
       return encrypt(awsData);
 
     case 'microsoft':
-      assert(region, 'invalid azure speech credential: region is required');
-      assert(api_key, 'invalid azure speech credential: api_key is required');
+      if (!custom_tts_endpoint_url && !custom_stt_endpoint_url) {
+        assert(region, 'invalid azure speech credential: region is required');
+        assert(api_key, 'invalid azure speech credential: api_key is required');
+      }
       const azureData = JSON.stringify({
-        region,
-        api_key,
+        ...(region && {region}),
+        ...(api_key && {api_key}),
         use_custom_tts,
         custom_tts_endpoint,
+        custom_tts_endpoint_url,
         use_custom_stt,
-        custom_stt_endpoint
+        custom_stt_endpoint,
+        custom_stt_endpoint_url
       });
       return encrypt(azureData);
 
@@ -295,8 +301,10 @@ router.get('/', async(req, res) => {
         obj.region = o.region;
         obj.use_custom_tts = o.use_custom_tts;
         obj.custom_tts_endpoint = o.custom_tts_endpoint;
+        obj.custom_tts_endpoint_url = o.custom_tts_endpoint_url;
         obj.use_custom_stt = o.use_custom_stt;
         obj.custom_stt_endpoint = o.custom_stt_endpoint;
+        obj.custom_stt_endpoint_url = o.custom_stt_endpoint_url;
         logger.info({obj, o}, 'retrieving azure speech credential');
       }
       else if ('wellsaid' === obj.vendor) {
@@ -383,8 +391,10 @@ router.get('/:sid', async(req, res) => {
       obj.region = o.region;
       obj.use_custom_tts = o.use_custom_tts;
       obj.custom_tts_endpoint = o.custom_tts_endpoint;
+      obj.custom_tts_endpoint_url = o.custom_tts_endpoint_url;
       obj.use_custom_stt = o.use_custom_stt;
       obj.custom_stt_endpoint = o.custom_stt_endpoint;
+      obj.custom_stt_endpoint_url = o.custom_stt_endpoint_url;
     }
     else if ('wellsaid' === obj.vendor) {
       const o = JSON.parse(decrypt(credential));
@@ -488,8 +498,10 @@ router.put('/:sid', async(req, res) => {
         const {
           use_custom_tts,
           custom_tts_endpoint,
+          custom_tts_endpoint_url,
           use_custom_stt,
           custom_stt_endpoint,
+          custom_stt_endpoint_url,
           custom_stt_url,
           custom_tts_url
         } = req.body;
@@ -501,8 +513,10 @@ router.put('/:sid', async(req, res) => {
           aws_region,
           use_custom_tts,
           custom_tts_endpoint,
+          custom_tts_endpoint_url,
           use_custom_stt,
           custom_stt_endpoint,
+          custom_stt_endpoint_url,
           stt_region,
           tts_region,
           riva_server_uri,
@@ -622,8 +636,10 @@ router.get('/:sid/test', async(req, res) => {
         region,
         use_custom_tts,
         custom_tts_endpoint,
+        custom_tts_endpoint_url,
         use_custom_stt,
-        custom_stt_endpoint
+        custom_stt_endpoint,
+        custom_stt_endpoint_url
       } = credential;
       if (cred.use_for_tts) {
         try {
@@ -632,8 +648,10 @@ router.get('/:sid/test', async(req, res) => {
             region,
             use_custom_tts,
             custom_tts_endpoint,
+            custom_tts_endpoint_url,
             use_custom_stt,
-            custom_stt_endpoint
+            custom_stt_endpoint,
+            custom_stt_endpoint_url
           });
           results.tts.status = 'ok';
           SpeechCredential.ttsTestResult(sid, true);

lib/utils/storage-utils.js

@@ -1,8 +1,10 @@
-const { S3Client, PutObjectCommand, GetObjectCommand } = require('@aws-sdk/client-s3');
+const { S3Client, PutObjectCommand, GetObjectCommand, DeleteObjectCommand } = require('@aws-sdk/client-s3');
 const {Storage} = require('@google-cloud/storage');
 const fs = require('fs');
 const { BlobServiceClient } = require('@azure/storage-blob');
 
+// Azure
+
 async function testAzureStorage(logger, opts) {
   const blobServiceClient = BlobServiceClient.fromConnectionString(opts.connection_string);
   const containerClient = blobServiceClient.getContainerClient(opts.name);
@@ -19,16 +21,29 @@ async function getAzureStorageObject(logger, opts) {
   return response.readableStreamBody;
 }
 
-function testGoogleStorage(logger, opts) {
+async function deleteAzureStorageObject(logger, opts) {
+  const blobServiceClient = BlobServiceClient.fromConnectionString(opts.connection_string);
+  const containerClient = blobServiceClient.getContainerClient(opts.name);
+  const blockBlobClient = containerClient.getBlockBlobClient(opts.key);
+  await blockBlobClient.delete();
+}
+
+// Google
+
+function _initGoogleClient(opts) {
+  const serviceKey = JSON.parse(opts.service_key);
+  return new Storage({
+    projectId: serviceKey.project_id,
+    credentials: {
+      client_email: serviceKey.client_email,
+      private_key: serviceKey.private_key
+    },
+  });
+}
+
+async function testGoogleStorage(logger, opts) {
   return new Promise((resolve, reject) => {
-    const serviceKey = JSON.parse(opts.service_key);
-    const storage = new Storage({
-      projectId: serviceKey.project_id,
-      credentials: {
-        client_email: serviceKey.client_email,
-        private_key: serviceKey.private_key
-      },
-    });
+    const storage = _initGoogleClient(opts);
 
     const blob = storage.bucket(opts.name).file('jambonz-sample.text');
 
@@ -40,29 +55,39 @@ function testGoogleStorage(logger, opts) {
 }
 
 async function getGoogleStorageObject(logger, opts) {
-  const serviceKey = JSON.parse(opts.service_key);
-  const storage = new Storage({
-    projectId: serviceKey.project_id,
-    credentials: {
-      client_email: serviceKey.client_email,
-      private_key: serviceKey.private_key
-    },
-  });
+  const storage = _initGoogleClient(opts);
+
+  const bucket = storage.bucket(opts.name);
+  const file = bucket.file(opts.key);
+  const [exists] = await file.exists();
+  if (exists) {
+    return file.createReadStream();
+  }
+}
+
+async function deleteGoogleStorageObject(logger, opts) {
+  const storage = _initGoogleClient(opts);
 
   const bucket = storage.bucket(opts.name);
   const file = bucket.file(opts.key);
 
-  return file.createReadStream();
+  await file.delete();
 }
 
-async function testAwsS3(logger, opts) {
-  const s3 = new S3Client({
+// AWS S3
+
+function _initS3Client(opts) {
+  return new S3Client({
     credentials: {
       accessKeyId: opts.access_key_id,
       secretAccessKey: opts.secret_access_key,
     },
     region: opts.region || 'us-east-1'
   });
+}
+
+async function testAwsS3(logger, opts) {
+  const s3 = _initS3Client(opts);
 
   const input = {
     'Body': 'Hello From Jambonz',
@@ -76,26 +101,37 @@ async function testAwsS3(logger, opts) {
 }
 
 async function getS3Object(logger, opts) {
-  const s3 = new S3Client({
-    credentials: {
-      accessKeyId: opts.access_key_id,
-      secretAccessKey: opts.secret_access_key,
-    },
-    region: opts.region || 'us-east-1'
-  });
-  const command = new GetObjectCommand({
-    Bucket: opts.name,
-    Key: opts.key
-  });
+  const s3 = _initS3Client(opts);
+  const command = new GetObjectCommand(
+    {
+      Bucket: opts.name,
+      Key: opts.key
+    }
+  );
   const res = await s3.send(command);
   return res.Body;
 }
 
+async function deleteS3Object(logger, opts) {
+  const s3 = _initS3Client(opts);
+
+  const command = new DeleteObjectCommand(
+    {
+      Bucket: opts.name,
+      Key: opts.key
+    }
+  );
+  await s3.send(command);
+}
+
 module.exports = {
   testAwsS3,
   getS3Object,
+  deleteS3Object,
   testGoogleStorage,
   getGoogleStorageObject,
+  deleteGoogleStorageObject,
   testAzureStorage,
-  getAzureStorageObject
+  getAzureStorageObject,
+  deleteAzureStorageObject
 };