@webex/contact-center 3.9.0-next.15 → 3.9.0-next.17

package/dist/types/services/task/types.d.ts

@@ -997,6 +997,8 @@ export type DialerPayload = {
     mediaType: 'telephony' | 'chat' | 'social' | 'email';
     /** The outbound type for the task */
     outboundType: 'OUTDIAL' | 'CALLBACK' | 'EXECUTE_FLOW';
+    /** The Outdial ANI number that will be used while making a call to the customer.  */
+    origin: string;
 };
 /**
  * Data structure for cleaning up contact resources

package/dist/webex.js

@@ -29,7 +29,7 @@ if (!global.Buffer) {
  */
 const Webex = _webexCore.default.extend({
   webex: true,
-  version: `3.9.0-next.15`
+  version: `3.9.0-next.17`
 });
 
 /**

package/package.json

@@ -45,7 +45,7 @@
   },
   "dependencies": {
     "@types/platform": "1.3.4",
-    "@webex/calling": "3.9.0-next.8",
+    "@webex/calling": "3.9.0-next.9",
     "@webex/internal-plugin-mercury": "3.9.0-next.3",
     "@webex/internal-plugin-metrics": "3.9.0-next.3",
     "@webex/internal-plugin-support": "3.9.0-next.5",
@@ -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",
@@ -79,5 +80,5 @@
     "typedoc": "^0.25.0",
     "typescript": "4.9.5"
   },
-  "version": "3.9.0-next.15"
+  "version": "3.9.0-next.17"
 }

package/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.
    *

package/src/constants.ts

@@ -42,6 +42,7 @@ export const METHODS = {
   HANDLE_DEVICE_TYPE: 'handleDeviceType',
   START_OUTDIAL: 'startOutdial',
   GET_QUEUES: 'getQueues',
+  GET_OUTDIAL_ANI_ENTRIES: 'getOutdialAniEntries',
   UPLOAD_LOGS: 'uploadLogs',
   UPDATE_AGENT_PROFILE: 'updateAgentProfile',
   GET_DEVICE_ID: 'getDeviceId',

package/src/metrics/constants.ts

@@ -37,7 +37,6 @@ type Enum<T extends Record<string, unknown>> = T[keyof T];
  * @property {string} TASK_HOLD_FAILED - Event name for failed task hold.
  * @property {string} TASK_RESUME_SUCCESS - Event name for successful task resume.
  * @property {string} TASK_RESUME_FAILED - Event name for failed task resume.
- *
  * @property {string} TASK_CONSULT_START_SUCCESS - Event name for successful consult start.
  * @property {string} TASK_CONSULT_START_FAILED - Event name for failed consult start.
  * @property {string} TASK_CONSULT_END_SUCCESS - Event name for successful consult end.
@@ -69,6 +68,9 @@ type Enum<T extends Record<string, unknown>> = T[keyof T];
  * @property {string} AGENT_DEVICE_TYPE_UPDATE_SUCCESS - Event name for successful agent device type update.
  * @property {string} AGENT_DEVICE_TYPE_UPDATE_FAILED - Event name for failed agent device type update.
  *
+ * @property {string} OUTDIAL_ANI_EP_FETCH_SUCCESS - Event name for successful outdial ANI entries fetch.
+ * @property {string} OUTDIAL_ANI_EP_FETCH_FAILED - Event name for failed outdial ANI entries fetch.
+ *
  * @readonly
  */
 export const METRIC_EVENT_NAMES = {
@@ -149,6 +151,10 @@ export const METRIC_EVENT_NAMES = {
   // Queue API Events
   QUEUE_FETCH_SUCCESS: 'Queue Fetch Success',
   QUEUE_FETCH_FAILED: 'Queue Fetch Failed',
+
+  // Outdial ANI Entries API Events
+  OUTDIAL_ANI_EP_FETCH_SUCCESS: 'Outdial ANI Entries Fetch Success',
+  OUTDIAL_ANI_EP_FETCH_FAILED: 'Outdial ANI Entries Fetch Failed',
 } as const;
 
 /**

package/src/services/config/constants.ts

@@ -270,4 +270,20 @@ export const endPointMap = {
    */
   addressBookEntries: (orgId: string, addressBookId: string, queryParams: string) =>
     `/organization/${orgId}/v2/address-book/${addressBookId}/entry?${queryParams}`,
+
+  /**
+   * Gets the endpoint for outdial ANI entries with custom query parameters.
+   * @param orgId - Organization ID.
+   * @param outdialANI - Outdial ANI ID.
+   * @param queryParams - Query parameters string.
+   * @returns The endpoint URL string.
+   * @public
+   * @example
+   * const url = endPointMap.outdialAniEntries('org123', 'ani456', 'page=0&pageSize=10');
+   * @ignore
+   */
+  outdialAniEntries: (orgId: string, outdialANI: string, queryParams: string) =>
+    `organization/${orgId}/v2/outdial-ani/${outdialANI}/entry${
+      queryParams ? `?${queryParams}` : ''
+    }`,
 };

package/src/services/config/index.ts

@@ -9,9 +9,9 @@ import {
   DesktopProfileResponse,
   ListAuxCodesResponse,
   AgentResponse,
+  TenantData,
   OrgInfo,
   OrgSettings,
-  TenantData,
   URLMapping,
   TeamList,
   DialPlanEntity,
@@ -20,10 +20,12 @@ import {
   AuxCode,
   MultimediaProfileResponse,
   SiteInfo,
+  OutdialAniEntriesResponse,
+  OutdialAniParams,
 } from './types';
 import WebexRequest from '../core/WebexRequest';
 import {WCC_API_GATEWAY} from '../constants';
-import {CONFIG_FILE_NAME} from '../../constants';
+import {CONFIG_FILE_NAME, METHODS as MAIN_METHODS} from '../../constants';
 import {parseAgentConfigs} from './Util';
 import {
   DEFAULT_AUXCODE_ATTRIBUTES,
@@ -686,4 +688,56 @@ export default class AgentConfigService {
   }
 
   // getQueues removed - use Queue instead
+
+  /**
+   * Fetches outdial ANI (Automatic Number Identification) entries for the given orgId and outdial ANI ID.
+   * @ignore
+   * @param {string} orgId - organization ID for which the outdial ANI entries are to be fetched.
+   * @param {OutdialAniParams} params - parameters object containing outdialANI and optional pagination/filtering options
+   * @returns {Promise<OutdialAniEntriesResponse>} - A promise that resolves to the outdial ANI entries response.
+   * @throws {Error} - Throws an error if the API call fails or if the response status is not 200.
+   * @private
+   */
+  public async getOutdialAniEntries(
+    orgId: string,
+    params: OutdialAniParams
+  ): Promise<OutdialAniEntriesResponse> {
+    const {outdialANI, page, pageSize, search, filter, attributes} = params;
+
+    LoggerProxy.info('Fetching outdial ANI entries', {
+      module: CONFIG_FILE_NAME,
+      method: MAIN_METHODS.GET_OUTDIAL_ANI_ENTRIES,
+    });
+
+    try {
+      const queryParams = [];
+      if (page !== undefined) queryParams.push(`page=${page}`);
+      if (pageSize !== undefined) queryParams.push(`pageSize=${pageSize}`);
+      if (search) queryParams.push(`search=${search}`);
+      if (filter) queryParams.push(`filter=${filter}`);
+      if (attributes) queryParams.push(`attributes=${attributes}`);
+
+      const queryString = queryParams.length > 0 ? queryParams.join('&') : '';
+      const resource = endPointMap.outdialAniEntries(orgId, outdialANI, queryString);
+
+      const response = await this.webexReq.request({
+        service: WCC_API_GATEWAY,
+        resource,
+        method: HTTP_METHODS.GET,
+      });
+
+      LoggerProxy.log('getOutdialAniEntries API success.', {
+        module: CONFIG_FILE_NAME,
+        method: MAIN_METHODS.GET_OUTDIAL_ANI_ENTRIES,
+      });
+
+      return response.body?.data;
+    } catch (error) {
+      LoggerProxy.error(`getOutdialAniEntries API call failed with ${error}`, {
+        module: CONFIG_FILE_NAME,
+        method: MAIN_METHODS.GET_OUTDIAL_ANI_ENTRIES,
+      });
+      throw error;
+    }
+  }
 }

package/src/services/config/types.ts

@@ -1072,3 +1072,47 @@ export type CallDistributionGroup = {
   /** Distribution time duration in seconds */
   duration: number;
 };
+
+/**
+ * Represents a single outdial ANI (Automatic Number Identification) entry
+ * @public
+ */
+export type OutdialAniEntry = {
+  /** Unique identifier for the ANI entry */
+  id: string;
+  /** Display name for the ANI entry */
+  name: string;
+  /** Phone number associated with this ANI entry */
+  number: string;
+  /** Related links for this ANI entry */
+  links: string[];
+  /** Timestamp when this entry was created (Unix timestamp in milliseconds) */
+  createdTime: number;
+  /** Timestamp when this entry was last updated (Unix timestamp in milliseconds) */
+  lastUpdatedTime: number;
+};
+
+/**
+ * Response structure for outdial ANI entries API call
+ * @public
+ */
+export type OutdialAniEntriesResponse = OutdialAniEntry[];
+
+/**
+ * Parameters for fetching outdial ANI entries
+ * @public
+ */
+export type OutdialAniParams = {
+  /** Outdial ANI ID from agent profile */
+  outdialANI: string;
+  /** Page number for pagination (optional) */
+  page?: number;
+  /** Number of entries per page (optional) */
+  pageSize?: number;
+  /** Search string to filter entries (optional) */
+  search?: string;
+  /** Filter expression for advanced filtering (optional) */
+  filter?: string;
+  /** Comma-separated list of attributes to include in response (optional) */
+  attributes?: string;
+};

package/src/services/task/types.ts

@@ -1064,6 +1064,8 @@ export type DialerPayload = {
   mediaType: 'telephony' | 'chat' | 'social' | 'email';
   /** The outbound type for the task */
   outboundType: 'OUTDIAL' | 'CALLBACK' | 'EXECUTE_FLOW';
+  /** The Outdial ANI number that will be used while making a call to the customer.  */
+  origin: string;
 };
 
 /**

package/test/unit/spec/cc.ts

@@ -1316,7 +1316,7 @@ describe('webex.cc', () => {
   });
 
   describe('startOutdial', () => {
-    it('should make outdial call successfully.', async () => {
+    it('should make outdial call successfully without origin.', async () => {
       // Setup outDialEp.
       webex.cc.agentConfig = {
         outDialEp: 'test-entry-point',
@@ -1325,9 +1325,10 @@ describe('webex.cc', () => {
       // destination number required for making outdial call.
       const destination = '1234567890';
 
-      // Construct Payload for startOutdial.
+      // Construct Payload for startOutdial without origin.
       const newPayload = {
         destination,
+        origin: undefined,
         entryPointId: 'test-entry-point',
         direction: OUTDIAL_DIRECTION,
         attributes: ATTRIBUTES,
@@ -1357,6 +1358,49 @@ describe('webex.cc', () => {
       expect(result).toEqual(mockResponse);
     });
 
+    it('should make outdial call successfully with origin.', async () => {
+      // Setup outDialEp.
+      webex.cc.agentConfig = {
+        outDialEp: 'test-entry-point',
+      };
+
+      // destination number and origin for making outdial call.
+      const destination = '1234567890';
+      const origin = '+19403016307';
+
+      // Construct Payload for startOutdial with origin.
+      const newPayload = {
+        destination,
+        origin,
+        entryPointId: 'test-entry-point',
+        direction: OUTDIAL_DIRECTION,
+        attributes: ATTRIBUTES,
+        mediaType: OUTDIAL_MEDIA_TYPE,
+        outboundType: OUTBOUND_TYPE,
+      } as const;
+
+      const mockResponse = {} as AgentContact;
+
+      const startOutdialMock = jest
+        .spyOn(webex.cc.services.dialer, 'startOutdial')
+        .mockResolvedValue(mockResponse);
+
+      const result = await webex.cc.startOutdial(destination, origin);
+
+      // Verify logging calls
+      expect(LoggerProxy.info).toHaveBeenCalledWith('Starting outbound dial', {
+        module: CC_FILE,
+        method: 'startOutdial',
+      });
+      expect(LoggerProxy.log).toHaveBeenCalledWith('Outbound dial completed successfully', {
+        module: CC_FILE,
+        method: 'startOutdial',
+      });
+
+      expect(startOutdialMock).toHaveBeenCalledWith({data: newPayload});
+      expect(result).toEqual(mockResponse);
+    });
+
     it('should handle error during startOutdial', async () => {
       // Setup outDialEp.
       webex.cc.agentConfig = {