@webex/contact-center 3.12.0-next.13 → 3.12.0-next.130

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

@@ -1,4 +1,7 @@
 import * as Agent from '../agent/types';
+import { COLLABORATION_ACCESS } from './constants';
+/** Desktop Profile access level for a collaboration destination category. */
+export type CollaborationAccess = Enum<typeof COLLABORATION_ACCESS>;
 /**
  * Events emitted on task objects
  * @enum {string}
@@ -50,6 +53,8 @@ export declare const CC_TASK_EVENTS: {
     readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
     /** Event emitted when participant leaving conference fails */
     readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
+    /** Event emitted when dropping another conference participant fails */
+    readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
     /** Event emitted when consultation conference end fails */
     readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
     /** Event emitted when conference is successfully transferred */
@@ -58,6 +63,8 @@ export declare const CC_TASK_EVENTS: {
     readonly AGENT_CONFERENCE_TRANSFER_FAILED: "AgentConferenceTransferFailed";
     /** Event emitted for post-call activity by participant */
     readonly PARTICIPANT_POST_CALL_ACTIVITY: "ParticipantPostCallActivity";
+    /** Event emitted when consulted participant is being moved/transferred */
+    readonly CONSULTED_PARTICIPANT_MOVING: "ConsultedParticipantMoving";
     /** Event emitted when contact is blind transferred */
     readonly AGENT_BLIND_TRANSFERRED: "AgentBlindTransferred";
     /** Event emitted when blind transfer fails */
@@ -74,6 +81,8 @@ export declare const CC_TASK_EVENTS: {
     readonly AGENT_CONSULT_TRANSFER_FAILED: "AgentConsultTransferFailed";
     /** Event emitted when contact recording is paused */
     readonly CONTACT_RECORDING_PAUSED: "ContactRecordingPaused";
+    /** Event emitted when contact recording is started */
+    readonly CONTACT_RECORDING_STARTED: "ContactRecordingStarted";
     /** Event emitted when pausing contact recording fails */
     readonly CONTACT_RECORDING_PAUSE_FAILED: "ContactRecordingPauseFailed";
     /** Event emitted when contact recording is resumed */
@@ -84,6 +93,10 @@ export declare const CC_TASK_EVENTS: {
     readonly CONTACT_ENDED: "ContactEnded";
     /** Event emitted when contact is merged */
     readonly CONTACT_MERGED: "ContactMerged";
+    /** Event emitted when contact payload is updated (routing updates) */
+    readonly CONTACT_UPDATED: "ContactUpdated";
+    /** Event emitted when contact owner changes */
+    readonly CONTACT_OWNER_CHANGED: "ContactOwnerChanged";
     /** Event emitted when ending contact fails */
     readonly AGENT_CONTACT_END_FAILED: "AgentContactEndFailed";
     /** Event emitted when agent enters wrap-up state */
@@ -110,14 +123,25 @@ export declare const CC_TASK_EVENTS: {
     readonly CAMPAIGN_CONTACT_UPDATED: "CampaignContactUpdated";
     /** Event emitted when accepting a campaign preview contact fails */
     readonly CAMPAIGN_PREVIEW_ACCEPT_FAILED: "CampaignPreviewAcceptFailed";
+    /** Event emitted when skipping a campaign preview contact fails */
+    readonly CAMPAIGN_PREVIEW_SKIP_FAILED: "CampaignPreviewSkipFailed";
+    /** Event emitted when removing a campaign preview contact fails */
+    readonly CAMPAIGN_PREVIEW_REMOVE_FAILED: "CampaignPreviewRemoveFailed";
     /** Event emitted when a real-time transcript chunk is received */
     readonly REAL_TIME_TRANSCRIPTION: "REAL_TIME_TRANSCRIPTION";
+    /** Event emitted when an AI assistant suggested response is available */
+    readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
+    /** Event emitted when backend acknowledges it is listening for more context */
+    readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
+    /** Event emitted when a mid-call summary is available */
+    readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
+    /** Event emitted when a post-call summary is available */
+    readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
 };
 /**
  * Events emitted on Contact Center agent operations
  * @enum {string}
- * @private
- * @ignore
+ * @public
  */
 export declare const CC_AGENT_EVENTS: {
     /** Welcome event when agent connects to websocket/backend */
@@ -156,6 +180,8 @@ export declare const CC_AGENT_EVENTS: {
     readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
     /** Event emitted when contact is reserved for agent */
     readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
+    /** Agent-level Agent Wellness Break notification */
+    readonly WELLNESS_BREAK: "WellnessBreak";
 };
 /**
  * Combined Contact Center events including both agent and task events
@@ -207,6 +233,8 @@ export declare const CC_EVENTS: {
     readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
     /** Event emitted when participant leaving conference fails */
     readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
+    /** Event emitted when dropping another conference participant fails */
+    readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
     /** Event emitted when consultation conference end fails */
     readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
     /** Event emitted when conference is successfully transferred */
@@ -215,6 +243,8 @@ export declare const CC_EVENTS: {
     readonly AGENT_CONFERENCE_TRANSFER_FAILED: "AgentConferenceTransferFailed";
     /** Event emitted for post-call activity by participant */
     readonly PARTICIPANT_POST_CALL_ACTIVITY: "ParticipantPostCallActivity";
+    /** Event emitted when consulted participant is being moved/transferred */
+    readonly CONSULTED_PARTICIPANT_MOVING: "ConsultedParticipantMoving";
     /** Event emitted when contact is blind transferred */
     readonly AGENT_BLIND_TRANSFERRED: "AgentBlindTransferred";
     /** Event emitted when blind transfer fails */
@@ -231,6 +261,8 @@ export declare const CC_EVENTS: {
     readonly AGENT_CONSULT_TRANSFER_FAILED: "AgentConsultTransferFailed";
     /** Event emitted when contact recording is paused */
     readonly CONTACT_RECORDING_PAUSED: "ContactRecordingPaused";
+    /** Event emitted when contact recording is started */
+    readonly CONTACT_RECORDING_STARTED: "ContactRecordingStarted";
     /** Event emitted when pausing contact recording fails */
     readonly CONTACT_RECORDING_PAUSE_FAILED: "ContactRecordingPauseFailed";
     /** Event emitted when contact recording is resumed */
@@ -241,6 +273,10 @@ export declare const CC_EVENTS: {
     readonly CONTACT_ENDED: "ContactEnded";
     /** Event emitted when contact is merged */
     readonly CONTACT_MERGED: "ContactMerged";
+    /** Event emitted when contact payload is updated (routing updates) */
+    readonly CONTACT_UPDATED: "ContactUpdated";
+    /** Event emitted when contact owner changes */
+    readonly CONTACT_OWNER_CHANGED: "ContactOwnerChanged";
     /** Event emitted when ending contact fails */
     readonly AGENT_CONTACT_END_FAILED: "AgentContactEndFailed";
     /** Event emitted when agent enters wrap-up state */
@@ -267,8 +303,20 @@ export declare const CC_EVENTS: {
     readonly CAMPAIGN_CONTACT_UPDATED: "CampaignContactUpdated";
     /** Event emitted when accepting a campaign preview contact fails */
     readonly CAMPAIGN_PREVIEW_ACCEPT_FAILED: "CampaignPreviewAcceptFailed";
+    /** Event emitted when skipping a campaign preview contact fails */
+    readonly CAMPAIGN_PREVIEW_SKIP_FAILED: "CampaignPreviewSkipFailed";
+    /** Event emitted when removing a campaign preview contact fails */
+    readonly CAMPAIGN_PREVIEW_REMOVE_FAILED: "CampaignPreviewRemoveFailed";
     /** Event emitted when a real-time transcript chunk is received */
     readonly REAL_TIME_TRANSCRIPTION: "REAL_TIME_TRANSCRIPTION";
+    /** Event emitted when an AI assistant suggested response is available */
+    readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
+    /** Event emitted when backend acknowledges it is listening for more context */
+    readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
+    /** Event emitted when a mid-call summary is available */
+    readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
+    /** Event emitted when a post-call summary is available */
+    readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
     /** Welcome event when agent connects to websocket/backend */
     readonly WELCOME: "Welcome";
     /** Event emitted when agent re-login is successful */
@@ -305,6 +353,8 @@ export declare const CC_EVENTS: {
     readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
     /** Event emitted when contact is reserved for agent */
     readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
+    /** Agent-level Agent Wellness Break notification */
+    readonly WELLNESS_BREAK: "WellnessBreak";
 };
 /**
  * Event data received when agent connects to the system
@@ -314,6 +364,14 @@ export type WelcomeEvent = {
     /** ID of the agent that connected */
     agentId: string;
 };
+/**
+ * Available login options for voice channel access
+ * 'AGENT_DN' - Login using agent's DN
+ * 'EXTENSION' - Login using extension number
+ * 'BROWSER' - Login using browser-based WebRTC
+ * @public
+ */
+export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
 /**
  * Response type for welcome events which can be either success or error
  * @public
@@ -384,13 +442,34 @@ export type AgentResponse = {
     dbId?: string;
     /**
      * The default dialed number of the agent.
+     * Note: The API returns this field as "deafultDialledNumber" (with typo).
      */
-    defaultDialledNumber?: string;
+    deafultDialledNumber?: string;
 };
 /**
  * Represents the response from getDesktopProfileById method.
  */
 export type DesktopProfileResponse = {
+    /**
+     * Unique identifier of the agent profile configuration.
+     */
+    id: string;
+    /**
+     * Display name for the agent profile.
+     */
+    name: string;
+    /**
+     * Description of the agent profile.
+     */
+    description: string;
+    /**
+     * Parent entity type for the profile (for example ORGANIZATION).
+     */
+    parentType: string;
+    /**
+     * Indicates whether screen pop is enabled.
+     */
+    screenPopup: boolean;
     /**
      * Represents the voice options of an agent.
      */
@@ -423,6 +502,10 @@ export type DesktopProfileResponse = {
      * Auto wrap-up allowed.
      */
     autoWrapUp: boolean;
+    /**
+     * Whether the agent personal greeting is enabled.
+     */
+    agentPersonalGreeting: boolean;
     /**
      * Auto answer allowed.
      */
@@ -439,6 +522,30 @@ export type DesktopProfileResponse = {
      * Allow auto wrap-up extension.
      */
     allowAutoWrapUpExtension: boolean;
+    /**
+     * Access control for queues assigned to the agent (ALL, SPECIFIC, or NONE).
+     */
+    accessQueue: CollaborationAccess;
+    /**
+     * Queue identifiers available to the agent when access is SPECIFIC.
+     */
+    queues: string[];
+    /**
+     * Access control for entry points assigned to the agent.
+     */
+    accessEntryPoint: CollaborationAccess;
+    /**
+     * Entry point identifiers available to the agent when access is SPECIFIC.
+     */
+    entryPoints: string[];
+    /**
+     * Access control for buddy teams assigned to the agent.
+     */
+    accessBuddyTeam: CollaborationAccess;
+    /**
+     * Buddy team identifiers available to the agent when access is SPECIFIC.
+     */
+    buddyTeams: string[];
     /**
      * Outdial enabled for the agent.
      */
@@ -475,6 +582,10 @@ export type DesktopProfileResponse = {
      * Agent DN validation of the agent.
      */
     agentDNValidation: string;
+    /**
+     * Additional DN validation criteria configured for the agent.
+     */
+    agentDNValidationCriterions: string[];
     /**
      * Dial plans of the agent.
      */
@@ -503,6 +614,26 @@ export type DesktopProfileResponse = {
      * State synchronization in Webex enabled or not.
      */
     stateSynchronizationWebex: boolean;
+    /**
+     * Threshold rules configured for the agent profile.
+     */
+    thresholdRules: Array<Record<string, string | number>>;
+    /**
+     * Whether the agent profile is currently active.
+     */
+    active: boolean;
+    /**
+     * Whether this profile is the system default.
+     */
+    systemDefault: boolean;
+    /**
+     * Timestamp when the profile was created.
+     */
+    createdTime: number;
+    /**
+     * Timestamp when the profile was last updated.
+     */
+    lastUpdatedTime: number;
 };
 /**
  * Response containing multimedia profile configuration for an agent
@@ -672,6 +803,8 @@ export type OrgSettings = {
     maskSensitiveData: boolean;
     /** Whether campaign manager features are enabled */
     campaignManagerEnabled: boolean;
+    /** Number of AI Assistant licenses assigned to the organization */
+    aiAssistantQuantity?: number | null;
 };
 /**
  * Contact center site configuration information
@@ -898,14 +1031,6 @@ export type WrapupData = {
         allowCancelAutoWrapup?: boolean;
     };
 };
-/**
- * Available login options for voice channel access
- * 'AGENT_DN' - Login using agent's DN
- * 'EXTENSION' - Login using extension number
- * 'BROWSER' - Login using browser-based WebRTC
- * @public
- */
-export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
 /**
  * Team configuration information
  * @public
@@ -1073,7 +1198,7 @@ export type Profile = {
     /** Outbound entry point */
     outDialEp: string;
     /** Whether ending calls is enabled */
-    isEndCallEnabled: boolean;
+    isEndTaskEnabled: boolean;
     /** Whether ending consultations is enabled */
     isEndConsultEnabled: boolean;
     /** Optional lifecycle manager URL */
@@ -1084,6 +1209,12 @@ export type Profile = {
     agentAnalyzerId?: string;
     /** Whether consult to queue is allowed */
     allowConsultToQueue: boolean;
+    /** Access control for queues on Desktop Profile Collaboration tab */
+    accessQueue?: CollaborationAccess;
+    /** Access control for entry points on Desktop Profile Collaboration tab */
+    accessEntryPoint?: CollaborationAccess;
+    /** Access control for buddy teams on Desktop Profile Collaboration tab */
+    accessBuddyTeam?: CollaborationAccess;
     /** Additional campaign manager information */
     campaignManagerAdditionalInfo?: string;
     /** Whether personal statistics are enabled */
@@ -1148,6 +1279,12 @@ export type Profile = {
     lastIdleCodeChangeTimestamp?: number;
     /** AI feature flags resolved from organization config */
     aiFeature?: AIFeatureFlags;
+    /**
+     * Whether Agent Wellness Break is effectively enabled for this profile.
+     * This combines the organization wellbeing configuration with AI Assistant licensing;
+     * Server-side rollout remains enforced by the backend configuration and notification delivery.
+     */
+    isWellnessBreakEnabled?: boolean;
 };
 /**
  * Contact distribution group configuration for routing logic
@@ -1205,3 +1342,51 @@ export type OutdialAniParams = {
     /** Comma-separated list of attributes to include in response (optional) */
     attributes?: string;
 };
+/**
+ * User preference data structure
+ * @public
+ */
+export type UserPreference = {
+    /** Unique identifier for the user preference */
+    id: string;
+    /** Organization ID */
+    organizationId: string;
+    /** User ID (CI user ID) */
+    userId: string;
+    /** User preference data as key-value pairs */
+    preferences: Record<string, unknown>;
+    /** Timestamp when this preference was created (Unix timestamp in milliseconds) */
+    createdTime?: number;
+    /** Timestamp when this preference was last updated (Unix timestamp in milliseconds) */
+    lastUpdatedTime?: number;
+};
+/**
+ * Request payload for creating user preferences
+ * @public
+ */
+export type CreateUserPreferenceRequest = {
+    /** User ID (CI user ID) */
+    userId: string;
+    /** Desktop preference data as a JSON string (required) */
+    desktopPreference: string;
+};
+/**
+ * Request payload for updating user preferences
+ * @public
+ */
+export type UpdateUserPreferenceRequest = {
+    /** Desktop preference data as a JSON string (required) */
+    desktopPreference: string;
+};
+/**
+ * Query parameters for fetching user preferences
+ * @public
+ */
+export type GetUserPreferenceParams = {
+    /** User ID to fetch preferences for. Defaults to current user's CI user ID. */
+    userId?: string;
+    /** Page number (0-indexed). Default: 0 */
+    page?: number;
+    /** Number of items per page. Default: 100 */
+    pageSize?: number;
+};

package/dist/types/services/core/Err.d.ts

@@ -49,6 +49,8 @@ export type TaskErrorIds = {
     'Service.aqm.task.consultAccept': Failure;
 } | {
     'Service.aqm.task.consultConference': Failure;
+} | {
+    'Service.aqm.task.dropConferenceParticipant': Failure;
 } | {
     'Service.aqm.task.consultEnd': Failure;
 } | {
@@ -67,6 +69,10 @@ export type TaskErrorIds = {
     'Service.aqm.dialer.startOutdial': Failure;
 } | {
     'Service.aqm.dialer.acceptPreviewContact': Failure;
+} | {
+    'Service.aqm.dialer.skipPreviewContact': Failure;
+} | {
+    'Service.aqm.dialer.removePreviewContact': Failure;
 } | {
     'Service.reqs.generic.failure': {
         trackingId: string;

package/dist/types/services/core/Utils.d.ts

@@ -1,17 +1,26 @@
 import * as Err from './Err';
 import { LoginOption, WebexRequestPayload } from '../../types';
 import { Failure, AugmentedError } from './GlobalTypes';
-import { TaskData, ConsultTransferPayLoad, Interaction } from '../task/types';
+import { ConsultConferenceData, consultConferencePayloadData, ConsultTransferDestinationType, TaskData, Interaction } from '../task/types';
 import { DialPlan } from '../config/types';
-export declare const FALLBACK_DIAL_NUMBER_REGEX: RegExp;
+/** Returns whether a value is a non-null object with string keys. */
+export declare const isRecord: (value: unknown) => value is Record<string, unknown>;
+/**
+ * Strips characters defined in the dial plan entry from the input string.
+ *
+ * @param input - The dial number to sanitize
+ * @param strippedChars - String of characters to remove from the input
+ * @returns The sanitized input with specified characters removed
+ */
+export declare const stripDialPlanChars: (input: string, strippedChars: string) => string;
 /**
  * Validates a dial number against the provided dial plan regex patterns.
  * A number is valid if it matches at least one regex pattern in the dial plans.
- * Falls back to US/Canada regex validation if no dial plan entries are configured.
+ * Skips validation when no dial plan entries are configured, deferring to the server.
  *
  * @param input - The dial number to validate
  * @param dialPlanEntries - Array of dial plan entries containing regex patterns
- * @returns true if the input matches at least one dial plan regex pattern, false otherwise
+ * @returns true if the input matches at least one dial plan regex pattern or no entries are configured, false otherwise
  */
 export declare const isValidDialNumber: (input: string, dialPlanEntries: DialPlan['dialPlanEntity']) => boolean;
 export declare const getStationLoginErrorData: (failure: Failure, loginOption: LoginOption) => {
@@ -61,14 +70,6 @@ export declare const generateTaskErrorObject: (error: any, methodName: string, m
  * @ignore
  */
 export declare const createErrDetailsObject: (errObj: WebexRequestPayload) => Err.Details<"Service.reqs.generic.failure">;
-/**
- * Gets the consulted agent ID from the media object by finding the agent
- * in the consult media participants (excluding the current agent).
- *
- * @param media - The media object from the interaction
- * @param agentId - The current agent's ID to exclude from the search
- * @returns The consulted agent ID, or empty string if none found
- */
 export declare const getConsultedAgentId: (media: Interaction['media'], agentId: string) => string;
 /**
  * Gets the destination agent ID for CBT (Capacity Based Team) scenarios.
@@ -98,4 +99,25 @@ export declare const calculateDestAgentId: (interaction: Interaction, agentId: s
  * @returns The destination agent ID for determining destination type
  */
 export declare const calculateDestType: (interaction: Interaction, agentId: string) => string;
-export declare const deriveConsultTransferDestinationType: (taskData?: TaskData) => ConsultTransferPayLoad['destinationType'];
+/**
+ * Gets the destination agent ID from participants.
+ * Finds a participant who is not the current agent and is an agent type.
+ *
+ * @param participants - The participants object from interaction
+ * @param agentId - The current agent's ID
+ * @returns The destination agent ID, or undefined if none found
+ */
+export declare const buildConsultConferenceParamData: (dataPassed: consultConferencePayloadData, interactionIdPassed: string) => {
+    interactionId: string;
+    data: ConsultConferenceData;
+};
+/**
+ * Derives the consult transfer destination type based on task data.
+ * This function determines the appropriate destination type for a consult transfer
+ * by examining the destination type stored in the task data.
+ *
+ * @param taskData - The task data containing destination information
+ * @returns The derived consult transfer destination type
+ * @public
+ */
+export declare const deriveConsultTransferDestinationType: (taskData: TaskData) => ConsultTransferDestinationType;

package/dist/types/services/core/WebexRequest.d.ts

@@ -11,6 +11,7 @@ declare class WebexRequest {
         resource: string;
         method: HTTP_METHODS;
         body?: RequestBody;
+        headers?: Record<string, string | null>;
     }): Promise<IHttpResponse>;
     /**
      * This is used for uploading the logs to backend/mats.

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

@@ -18,6 +18,8 @@ export type Req<TRes, TErr> = {
     url: string;
     host?: string;
     method?: HTTP_METHODS;
+    /** Suppress request URLs and routing payloads from AQM logs for sensitive operations. */
+    redactSensitiveLogs?: boolean;
     err?: ((errObj: WebexRequestPayload) => Err.Details<'Service.reqs.generic.failure'>) | Err.IdsMessage | ((e: WebexRequestPayload) => Err.Message | Err.Details<Err.IdsDetails>);
     notifSuccess: {
         bind: Bind;

package/dist/types/services/core/websocket/WebSocketManager.d.ts

@@ -33,3 +33,4 @@ export declare class WebSocketManager extends EventEmitter {
     private connect;
     private webSocketOnCloseHandler;
 }
+export default WebSocketManager;

package/dist/types/services/core/websocket/types.d.ts

@@ -1,5 +1,5 @@
 import { SubscribeRequest } from '../../../types';
-import { WebSocketManager } from './WebSocketManager';
+import type WebSocketManager from './WebSocketManager';
 /**
  * Options for initializing a connection service.
  * @typedef ConnectionServiceOptions

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

@@ -23,7 +23,7 @@ export default class Services {
     readonly dialer: ReturnType<typeof aqmDialer>;
     /** WebSocket manager for handling real-time communications */
     readonly webSocketManager: WebSocketManager;
-    /** RTD WebSocket manager for handling realtime transcription */
+    /** RTD WebSocket manager for handling real-time transcription */
     readonly rtdWebSocketManager: WebSocketManager;
     /** Connection service for managing websocket connections */
     readonly connectionService: ConnectionService;