Merge branch 'next' of github.com:webex/webex-js-sdk into MULTI_PARTY_CONFERENCE

Author: rsarika

.nvmrc

@@ -1 +1 @@
-lts/gallium
+lts/jod

docs/samples/contact-center/app.js

@@ -15,6 +15,7 @@ let consultationData = null; // Track who we consulted with for conference
 let entryPointId = '';
 let stateTimer;
 let currentConsultQueueId;
+let outdialANIId; // Store outdial ANI ID from agent profile
 
 const authTypeElm = document.querySelector('#auth-type');
 const credentialsFormElm = document.querySelector('#credentials');
@@ -95,6 +96,7 @@ const agentLoginInputError = document.getElementById('agent-login-input-error');
 const applyupdateAgentProfileBtn = document.querySelector('#applyupdateAgentProfile');
 const autoWrapupTimerElm = document.getElementById('autoWrapupTimer');
 const timerValueElm = autoWrapupTimerElm.querySelector('.timer-value');
+const outdialAniSelectElm = document.querySelector('#outdialAniSelect');
 deregisterBtn.style.backgroundColor = 'red';
 
 function isIncomingTask(task, agentId) {
@@ -897,28 +899,84 @@ function updateConferenceButtonState(task, isConsultationInProgress) {
   }
 }
 
+// Function to load outdial ANI entries
+async function loadOutdialAniEntries(outdialANIId) {
+
+  try {
+    console.log('Using outdial ANI ID:', outdialANIId);
+    // Call the getOutdialAniEntries method from the SDK
+    const aniResponse = await webex.cc.getOutdialAniEntries({
+      outdialANI: outdialANIId
+    });
+    console.log('The request to get outdial ANI entries was successful, the response is:', aniResponse)
+
+    // Clear existing options except the first one
+    outdialAniSelectElm.innerHTML = '<option value="">Select Outdial Ani...</option>';
+
+    // Get the ANI list from the response - it's directly an array
+    const aniList = aniResponse || [];
+    if (aniList.length === 0) {
+      const option = document.createElement('option');
+      option.value = '';
+      option.text = 'No ANI numbers available';
+      option.disabled = true;
+      outdialAniSelectElm.add(option);
+      console.log('No outdial ANI entries found');
+      return;
+    }
+
+    // Map and populate the select with ANI options
+    aniList.forEach((ani) => {
+      const option = document.createElement('option');
+      option.value = ani.number;  // Use number as value
+      option.text = ani.name;     // Use name as display text
+      outdialAniSelectElm.add(option);
+    });
+
+    console.log(`Loaded ${aniList.length} outdial ANI entries`);
+
+  } catch (error) {
+    console.error('Failed to load outdial ANI entries:', error);
+    alert('Failed to load outdial ANI entries', error)
+    // Add error option to select
+    outdialAniSelectElm.innerHTML = '<option value="">Select Caller ID...</option>';
+    const errorOption = document.createElement('option');
+    errorOption.value = '';
+    errorOption.text = 'Error loading ANI numbers';
+    errorOption.disabled = true;
+    outdialAniSelectElm.add(errorOption);
+  }
+}
 // Function to start an outdial call.
 async function startOutdial() {
 
   const destination = document.getElementById('outBoundDialNumber').value;
+  const selectedAni = outdialAniSelectElm.value;
 
   if (!destination || !destination.trim()) {
       alert('Destination number is required');
       return;
   }
 
-  if (!entryPointId) {
-      alert('Entry point ID is not configured');
+  if (!entryPointId || !entryPointId.trim()) {
+      alert('Entry Point ID is required for outdial');
       return;
   }
 
   try {
     console.log('Making an outdial call');
-    await webex.cc.startOutdial(destination);
-    console.log('Outdial call initiated successfully');
+    console.log('Destination:', destination);
+    console.log('Selected ANI:', selectedAni || 'None selected');
+    
+    // Use selected ANI as the origin parameter
+    if (selectedAni) {
+      await webex.cc.startOutdial(destination, selectedAni);
+      console.log('Outdial call initiated successfully with ANI:', selectedAni);
+    } 
+    
   } catch (error) {
     console.error('Failed to initiate outdial call', error);
-    alert('Failed to initiate outdial call');
+    alert('Failed to initiate outdial call: ' + (error.message || error));
   }
 }
 
@@ -1444,6 +1502,11 @@ function register() {
         wrapupCodes = agentProfile.wrapupCodes;
         agentDeviceType = agentProfile.deviceType;
         populateWrapupCodesDropdown();
+        outdialANIId = agentProfile.outdialANIId;
+        loadOutdialAniEntries(agentProfile.outdialANIId).catch(error => {
+            console.warn('Failed to load ANI entries during registration:', error);
+        })
+
         listTeams.forEach((team) => {
             const option = document.createElement('option');
             option.value = team.id;
@@ -1557,7 +1620,6 @@ function register() {
         dialNumber.disabled = false;
         dialNumber.value = data.dn || '';
       }
-
       const auxId  = data.auxCodeId?.trim() || '0';
       const idx    = [...idleCodesDropdown.options].findIndex(o => o.value === auxId);
       idleCodesDropdown.selectedIndex = idx >= 0 ? idx : 0;
@@ -1716,6 +1778,10 @@ function logoutAgent() {
       logoutAgentElm.classList.add('hidden');
       agentLogin.selectedIndex = 0;
       timerElm.innerHTML = '00:00:00';
+      
+      // Clear outdial ANI select
+      outdialAniSelectElm.innerHTML = '<option value="">Select Caller ID...</option>';
+      
       updateUnregisterButtonState();
     }, 1000);
 

docs/samples/contact-center/index.html

@@ -271,6 +271,12 @@ <h2 class="collapsible">
         <fieldset>
           <legend>Outdial Call</legend>
           <div class="keypad">
+            <div style="margin-bottom: 10px;">
+              <label for="outdialAniSelect">Caller ID (ANI):</label>
+              <select id="outdialAniSelect" style="width: 100%; margin-bottom: 10px;">
+                <option value="">Select Outdial Ani...</option>
+              </select>
+            </div>
             <input id="outBoundDialNumber" placeholder="Enter number to dial">
             <div class="keys">
               <div class="key" onclick="pressKey('1')">1</div>

package.json

@@ -20,8 +20,8 @@
   "license": "Cisco's General Terms (https://www.cisco.com/site/us/en/about/legal/contract-experience/index.html)",
   "author": "[email protected]",
   "engines": {
-    "node": "16.x",
-    "npm": ">=6.x"
+    "node": "18.x",
+    "npm": ">=10.5"
   },
   "main": "src/index.js",
   "repository": {
@@ -82,7 +82,7 @@
   },
   "devDependencies": {
     "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.17.10",
+    "@babel/core": "^7.27.1",
     "@babel/eslint-parser": "^7.17.0",
     "@babel/generator": "^7.24.7",
     "@babel/node": "^7.14.9",

packages/@webex/common-evented/package.json

@@ -10,7 +10,7 @@
     "directory": "packages/@webex/common-evented"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "browserify": {
     "transform": [

packages/@webex/common-timers/package.json

@@ -10,7 +10,7 @@
     "directory": "packages/@webex/common-timers"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "browserify": {
     "transform": [

packages/@webex/contact-center/package.json

@@ -56,6 +56,7 @@
     "lodash": "^4.17.21"
   },
   "devDependencies": {
+    "@babel/core": "^7.22.11",
     "@babel/preset-typescript": "7.22.11",
     "@types/jest": "27.4.1",
     "@typescript-eslint/eslint-plugin": "5.38.1",

packages/@webex/contact-center/src/cc.ts

@@ -38,14 +38,20 @@ import {
   MERCURY_DISCONNECTED_SUCCESS,
   METHODS,
 } from './constants';
+import {AGENT_STATE_AVAILABLE, AGENT_STATE_AVAILABLE_ID} from './services/config/constants';
 import {AGENT, WEB_RTC_PREFIX} from './services/constants';
 import Services from './services';
 import WebexRequest from './services/core/WebexRequest';
 import LoggerProxy from './logger-proxy';
 import {StateChange, Logout, StateChangeSuccess, AGENT_EVENTS} from './services/agent/types';
 import {getErrorDetails, isValidDialNumber} from './services/core/Utils';
-import {Profile, WelcomeEvent, CC_EVENTS} from './services/config/types';
-import {AGENT_STATE_AVAILABLE, AGENT_STATE_AVAILABLE_ID} from './services/config/constants';
+import {
+  Profile,
+  WelcomeEvent,
+  CC_EVENTS,
+  OutdialAniEntriesResponse,
+  OutdialAniParams,
+} from './services/config/types';
 import {ConnectionLostDetails} from './services/core/websocket/types';
 import TaskManager from './services/task/TaskManager';
 import WebCallingService from './services/WebCallingService';
@@ -1330,6 +1336,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
    * Makes an outbound call to a specified phone number.
    *
    * @param {string} destination - The phone number to dial (e.g., '+1234567890').
+   * @param {string} origin - The contact center number that will be used while making a call to the customer.
    * Should include country code and be in E.164 format.
    * @returns {Promise<TaskResponse>} Resolves with the task response containing:
    *   - interactionId: Unique identifier for the outbound call
@@ -1365,7 +1372,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
    *
    *   // Start the outbound call
    *   const destination = '+1234567890';
-   *   const task = await cc.startOutdial(destination);
+   *   const task = await cc.startOutdial(destination, origin);
    *
    *   // Listen for all relevant task events
    *   task.on('task:ringing', () => {
@@ -1433,7 +1440,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
    * }
    * ```
    */
-  public async startOutdial(destination: string): Promise<TaskResponse> {
+  public async startOutdial(destination: string, origin: string): Promise<TaskResponse> {
     LoggerProxy.info('Starting outbound dial', {
       module: CC_FILE,
       method: METHODS.START_OUTDIAL,
@@ -1447,6 +1454,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
       // Construct the outdial payload.
       const outDialPayload: DialerPayload = {
         destination,
+        origin,
         entryPointId: this.agentConfig.outDialEp,
         direction: OUTDIAL_DIRECTION,
         attributes: ATTRIBUTES,
@@ -1461,6 +1469,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
         {
           ...MetricsManager.getCommonTrackingFieldForAQMResponse(result),
           destination,
+          origin,
           mediaType: OUTDIAL_MEDIA_TYPE,
         },
         ['behavioral', 'business', 'operational']
@@ -1481,6 +1490,7 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
         {
           ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(failure),
           destination,
+          origin,
           mediaType: OUTDIAL_MEDIA_TYPE,
         },
         ['behavioral', 'business', 'operational']
@@ -1490,6 +1500,124 @@ export default class ContactCenter extends WebexPlugin implements IContactCenter
     }
   }
 
+  /**
+   * Fetches outdial ANI (Automatic Number Identification) entries for an outdial ANI ID.
+   *
+   * This method retrieves the list of phone numbers that can be used as caller ID when making
+   * outbound calls. The ANI data is associated with an outdial ANI ID and can be filtered
+   * and paginated as needed.
+   *
+   * @param {string} outdialANI - The outdial ANI ID to fetch ANI data for
+   * @param {number} [page] - Optional page number for pagination (0-based)
+   * @param {number} [pageSize] - Optional number of items per page
+   * @param {string} [search] - Optional search term to filter results by name or number
+   * @param {string} [filter] - Optional filter string
+   * @param {string} [attributes] - Optional attributes to include in response
+   * @returns {Promise<OutdialAniEntriesResponse>} Promise resolving to outdial ANI response containing:
+   *   - data: Array of ANI entries with number and name
+   *   - meta: Pagination metadata
+   * @throws {Error} If the operation fails or agent is not registered
+   * @public
+   * @example
+   * ```typescript
+   * const cc = webex.cc;
+   * await cc.register();
+   *
+   * // Get agent profile to obtain outdial ANI ID
+   * const agentProfile = cc.agentConfig;
+   * const outdialANI = agentProfile.outdialANIId;
+   *
+   * // Basic usage - get all ANI data for an outdial ANI ID
+   * const aniData = await cc.getOutdialAniEntries({ outdialANI });
+   *
+   * // With pagination and search
+   * const paginatedAni = await cc.getOutdialAniEntries({
+   *   outdialANI,
+   *   page: 0,
+   *   pageSize: 50,
+   *   search: '555' // search for numbers containing '555'
+   * });
+   *
+   * // Process the results
+   * paginatedAni.forEach(ani => {
+   *   console.log(`ANI: ${ani.number} - ${ani.name}`);
+   * });
+   * ```
+   */
+  public async getOutdialAniEntries(params: OutdialAniParams): Promise<OutdialAniEntriesResponse> {
+    const {outdialANI, page, pageSize, search, filter, attributes} = params;
+
+    LoggerProxy.info('Fetching outdial ANI entries', {
+      module: CC_FILE,
+      method: METHODS.GET_OUTDIAL_ANI_ENTRIES,
+    });
+
+    const orgId = this.$webex.credentials.getOrgId();
+
+    if (!orgId) {
+      LoggerProxy.error('Org ID not found.', {
+        module: CC_FILE,
+        method: METHODS.GET_OUTDIAL_ANI_ENTRIES,
+      });
+
+      throw new Error('Org ID not found.');
+    }
+
+    try {
+      const result = await this.services.config.getOutdialAniEntries(orgId, {
+        outdialANI,
+        page,
+        pageSize,
+        search,
+        filter,
+        attributes,
+      });
+
+      this.metricsManager.trackEvent(
+        METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_SUCCESS,
+        {
+          outdialANI,
+          resultCount: result?.length || 0,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+
+      LoggerProxy.log(`Successfully retrieved outdial ANI entries for ANI ID ${outdialANI}`, {
+        module: CC_FILE,
+        method: METHODS.GET_OUTDIAL_ANI_ENTRIES,
+      });
+
+      return result;
+    } catch (error) {
+      const failure = error.details as Failure;
+      this.metricsManager.trackEvent(
+        METRIC_EVENT_NAMES.OUTDIAL_ANI_EP_FETCH_FAILED,
+        {
+          ...MetricsManager.getCommonTrackingFieldForAQMResponseFailed(failure),
+          outdialANI,
+          error,
+        },
+        ['behavioral', 'business', 'operational']
+      );
+
+      LoggerProxy.error(
+        `Failed to fetch outdial ANI entries for ANI ID ${outdialANI} due to: ${error}`,
+        {
+          module: CC_FILE,
+          method: METHODS.GET_OUTDIAL_ANI_ENTRIES,
+          trackingId: failure.trackingId,
+        }
+      );
+
+      const {error: detailedError} = getErrorDetails(
+        error,
+        METHODS.GET_OUTDIAL_ANI_ENTRIES,
+        CC_FILE
+      );
+      throw detailedError;
+    }
+  }
+
   /**
    * Uploads logs to help troubleshoot SDK issues.
    *