Updates Voice Client Quickstart to support incoming number

voice-client-javascript/.env

@@ -10,4 +10,14 @@ APP_NAME=voice-client-javascript
 # description: Set a password for your app. Users who want to use the admin interface will have to use this password to access it
 # format: text
 # required: true
-ADMIN_PASSWORD=default
+ADMIN_PASSWORD=default
+
+# description: The Client username to wire up the examples and incoming number
+# format: text
+# required: true
+DEFAULT_CLIENT_NAME=alice
+
+# description: The Incoming Twilio Number to wire up to your Client
+# format: phone_number
+# required: true
+TWILIO_PHONE_NUMBER=

voice-client-javascript/assets/admin/actions.private.js

@@ -1,6 +1,7 @@
 const assets = Runtime.getAssets();
 const { urlForSiblingPage } = require(assets["/admin/shared.js"].path);
 
+const DEFAULT_TWILIO_WEBHOOK = "https://demo.twilio.com/welcome/voice/";
 
 class Actions {
   constructor(client, options) {
@@ -15,21 +16,34 @@ class Actions {
     env = Object.assign(env, results);
     const voiceUrl = `https://${this.options.DOMAIN_NAME}${urlForSiblingPage(
       "client-voice-twiml-app",
-      this.options.PATH, 
-      "..")}`;
+      this.options.PATH,
+      ".."
+    )}`;
     console.log(
       `Wiring up TwiML Application ${env.TWIML_APPLICATION_SID} to the function: ${voiceUrl}`
     );
     await this.updateTwimlAppVoiceUrl({
       twimlApplicationSid: env.TWIML_APPLICATION_SID,
-      voiceUrl
+      voiceUrl,
     });
     console.log("Generating new REST API Key");
     results = await this.generateNewKey(this.options);
     env = Object.assign(env, results);
-    const number = await this.chooseLogicalCallerId();
-    results = await this.setCallerId({ number });
-    env = Object.assign(env, results);
+    const incomingNumber = await this.chooseLogicalIncomingNumber(this.options.CHOSEN_TWILIO_NUMBER);
+    if (incomingNumber !== undefined) {
+      results = await this.updateIncomingNumber({
+        sid: incomingNumber.sid,
+        voiceApplicationSid: env.TWIML_APPLICATION_SID,
+      });
+      env = Object.assign(env, results);
+      results = await this.setCallerId({ number: incomingNumber.phoneNumber });
+      env = Object.assign(env, results);
+    } else {
+      // Did not find an incoming number, so we'll just choose a number
+      const callerIdNumber = await this.chooseLogicalCallerId();
+      results = await this.setCallerId({ number: callerIdNumber });
+      env = Object.assign(env, results);
+    }
     env.INITIALIZED = "voice-client-quickstart";
     env.INITIALIZATION_DATE = new Date().toISOString();
     return env;
@@ -38,7 +52,7 @@ class Actions {
   async createTwimlApp({ friendlyName }) {
     const result = await this.client.applications.create({ friendlyName });
     return {
-      TWIML_APPLICATION_SID: result.sid
+      TWIML_APPLICATION_SID: result.sid,
     };
   }
 
@@ -52,20 +66,32 @@ class Actions {
     const result = await this.client.newKeys.create({ friendlyName });
     return {
       API_KEY: result.sid,
-      API_SECRET: result.secret
+      API_SECRET: result.secret,
     };
   }
 
+  async chooseLogicalIncomingNumber(preferredNumber) {
+    const incomingNumbers = await this.client.incomingPhoneNumbers.list();
+    if (preferredNumber !== undefined) {
+      return incomingNumbers.find(number => number.phoneNumber === preferredNumber);
+    }
+    return incomingNumbers.find(
+      (number) =>
+        number.voiceUrl === DEFAULT_TWILIO_WEBHOOK || number.voiceUrl === ""
+    );
+  }
+
   async chooseLogicalCallerId() {
+    // This is only needed if we don't get a logical incoming number
     const incomingNumbers = await this.client.incomingPhoneNumbers.list({
-      limit: 1
+      limit: 1,
     });
     let number;
     if (incomingNumbers.length > 0) {
       number = incomingNumbers[0].phoneNumber;
     } else {
       const outgoingCallerIds = await this.client.outgoingCallerIds.list({
-        limit: 1
+        limit: 1,
       });
       // Required right?
       number = outgoingCallerIds[0].phoneNumber;
@@ -75,13 +101,34 @@ class Actions {
 
   async setCallerId({ number }) {
     return {
-      CALLER_ID: number
+      CALLER_ID: number,
+    };
+  }
+
+  async clearCallerId() {
+    return {
+      CALLER_ID: undefined,
+    };
+  }
+
+  async updateIncomingNumber({ sid, voiceApplicationSid }) {
+    const incomingNumber = await this.client.incomingPhoneNumbers(sid).update({
+      voiceApplicationSid,
+    });
+    return {
+      INCOMING_NUMBER: incomingNumber.phoneNumber,
+    };
+  }
+
+  async clearIncomingNumber() {
+    return {
+      INCOMING_NUMBER: undefined,
     };
   }
 
   async useExistingTwimlApp({ twimlApplicationSid }) {
     return {
-      TWIML_APPLICATION_SID: twimlApplicationSid
+      TWIML_APPLICATION_SID: twimlApplicationSid,
     };
   }
 }

voice-client-javascript/assets/admin/shared.private.js

@@ -61,7 +61,6 @@ async function getEnvironmentVariables(context, environment) {
 }
 
 async function getEnvironmentVariable(context, environment, key) {
-  const client = context.getTwilioClient();
   // The list filter method isn't implemented yet.
   const envVars = await getEnvironmentVariables(context, environment);
   return envVars.find(variable => variable.key === key);
@@ -78,8 +77,13 @@ async function setEnvironmentVariable(context, environment, key, value, override
     if (currentVariable) {
       if (currentVariable.value !== value) {
         if (override) {
-          console.log(`Updating ${key}...`);
-          await currentVariable.update({ value });
+          if (value === undefined) {
+            console.log(`Removing ${key}...`);
+            await currentVariable.remove();
+          } else {
+            console.log(`Updating ${key}...`);
+            await currentVariable.update({ value });
+          }
           return true;
         } else {
           console.log(`Not overriding existing variable '${key}' which is set to '${currentVariable.value}'`);