@webex/contact-center 3.12.0-next.3 → 3.12.0-next.30

package/dist/cc.js

@@ -1444,6 +1444,138 @@ class ContactCenter extends _webexCore.WebexPlugin {
     }
   }
 
+  /**
+   * Skips a campaign preview contact, requesting the next contact from the campaign.
+   *
+   * When a campaign manager reserves a contact for an agent, the agent receives an
+   * `AgentOfferCampaignReservation` event. Instead of accepting, the agent can skip the
+   * preview contact to move to the next contact in the campaign.
+   *
+   * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
+   * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
+   * @throws {Error} If the operation fails (network error, etc.)
+   *
+   * @example
+   * ```typescript
+   * webex.cc.on('task:campaignPreviewReservation', async (task) => {
+   *   const { interactionId } = task.data;
+   *   const campaignId = task.data.interaction.callProcessingDetails.campaignId;
+   *
+   *   const result = await webex.cc.skipPreviewContact({ interactionId, campaignId });
+   * });
+   * ```
+   */
+  async skipPreviewContact(payload) {
+    const task = this.taskManager.getTask(payload.interactionId);
+    if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewSkipDisabled === 'true') {
+      _loggerProxy.default.warn('Skip action is disabled for this campaign preview contact', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
+        interactionId: payload.interactionId
+      });
+      throw new Error('Skip action is disabled for this campaign preview contact');
+    }
+    _loggerProxy.default.info('Skipping campaign preview contact', {
+      module: _constants.CC_FILE,
+      method: _constants.METHODS.SKIP_PREVIEW_CONTACT
+    });
+    try {
+      this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED]);
+      const result = await this.services.dialer.skipPreviewContact({
+        data: payload
+      });
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_SUCCESS, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      _loggerProxy.default.log('Campaign preview contact skipped successfully', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.SKIP_PREVIEW_CONTACT,
+        trackingId: result.trackingId,
+        interactionId: payload.interactionId
+      });
+      return result;
+    } catch (error) {
+      const failure = error.details;
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_SKIP_FAILED, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      const {
+        error: detailedError
+      } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.SKIP_PREVIEW_CONTACT, _constants.CC_FILE);
+      throw detailedError;
+    }
+  }
+
+  /**
+   * Removes a campaign preview contact from the campaign list entirely.
+   *
+   * When a campaign manager reserves a contact for an agent, the agent receives an
+   * `AgentOfferCampaignReservation` event. Instead of accepting or skipping, the agent can
+   * remove the preview contact to permanently take it out of the campaign contact list.
+   *
+   * @param {PreviewContactPayload} payload - The preview contact payload containing interactionId and campaignId (campaign name, not UUID).
+   * @returns {Promise<TaskResponse>} Promise resolving with agent contact on success.
+   * @throws {Error} If the operation fails (network error, etc.)
+   *
+   * @example
+   * ```typescript
+   * webex.cc.on('task:campaignPreviewReservation', async (task) => {
+   *   const { interactionId } = task.data;
+   *   const campaignId = task.data.interaction.callProcessingDetails.campaignId;
+   *
+   *   const result = await webex.cc.removePreviewContact({ interactionId, campaignId });
+   * });
+   * ```
+   */
+  async removePreviewContact(payload) {
+    const task = this.taskManager.getTask(payload.interactionId);
+    if (task?.data?.interaction?.callProcessingDetails?.campaignPreviewRemoveDisabled === 'true') {
+      _loggerProxy.default.warn('Remove action is disabled for this campaign preview contact', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
+        interactionId: payload.interactionId
+      });
+      throw new Error('Remove action is disabled for this campaign preview contact');
+    }
+    _loggerProxy.default.info('Removing campaign preview contact', {
+      module: _constants.CC_FILE,
+      method: _constants.METHODS.REMOVE_PREVIEW_CONTACT
+    });
+    try {
+      this.metricsManager.timeEvent([_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, _constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED]);
+      const result = await this.services.dialer.removePreviewContact({
+        data: payload
+      });
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_SUCCESS, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponse(result),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      _loggerProxy.default.log('Campaign preview contact removed successfully', {
+        module: _constants.CC_FILE,
+        method: _constants.METHODS.REMOVE_PREVIEW_CONTACT,
+        trackingId: result.trackingId,
+        interactionId: payload.interactionId
+      });
+      return result;
+    } catch (error) {
+      const failure = error.details;
+      this.metricsManager.trackEvent(_constants4.METRIC_EVENT_NAMES.CAMPAIGN_PREVIEW_REMOVE_FAILED, {
+        ..._MetricsManager.default.getCommonTrackingFieldForAQMResponseFailed(failure),
+        interactionId: payload.interactionId,
+        campaignId: payload.campaignId
+      }, ['behavioral', 'business', 'operational']);
+      const {
+        error: detailedError
+      } = (0, _Utils.getErrorDetails)(error, _constants.METHODS.REMOVE_PREVIEW_CONTACT, _constants.CC_FILE);
+      throw detailedError;
+    }
+  }
+
   /**
    * Fetches outdial ANI (Automatic Number Identification) entries for an outdial ANI ID.
    *