@webex/contact-center 3.12.0-next.16 → 3.12.0-next.161
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.sdd/manifest.json +887 -0
- package/AGENTS.md +94 -0
- package/ai-docs/ARCHITECTURE.md +168 -0
- package/ai-docs/CONTRACTS.md +62 -0
- package/ai-docs/GETTING_STARTED.md +168 -0
- package/ai-docs/GLOSSARY.md +43 -0
- package/ai-docs/README.md +138 -0
- package/ai-docs/REVIEW_CHECKLIST.md +41 -0
- package/ai-docs/RULES.md +444 -0
- package/ai-docs/SECURITY.md +52 -0
- package/ai-docs/SERVICE_STATE.md +52 -0
- package/ai-docs/SPEC_INDEX.md +65 -0
- package/ai-docs/adr/0001-spec-source-policy.md +55 -0
- package/ai-docs/adr/README.md +8 -0
- package/ai-docs/adr/_adr-template.md +31 -0
- package/ai-docs/contact-center-spec.md +385 -0
- package/ai-docs/features/consult-transfer-list-policy/spec/feature-spec.md +362 -0
- package/ai-docs/features/contact-owner-change-refactor.md +78 -0
- package/ai-docs/features/generated-spec-conformance-fidelity-remediation/spec/feature-spec.md +117 -0
- package/ai-docs/features/residual-warning-coverage-completion/spec/feature-spec.md +203 -0
- package/ai-docs/features/validator-code-fidelity-drift-fix/spec/feature-spec.md +315 -0
- package/ai-docs/patterns/event-driven-patterns.md +485 -0
- package/ai-docs/patterns/testing-patterns.md +480 -0
- package/ai-docs/patterns/typescript-patterns.md +365 -0
- package/ai-docs/templates/README.md +102 -0
- package/ai-docs/templates/documentation/create-agents-md.md +240 -0
- package/ai-docs/templates/documentation/create-architecture-md.md +295 -0
- package/ai-docs/templates/existing-service/bug-fix.md +254 -0
- package/ai-docs/templates/existing-service/feature-enhancement.md +450 -0
- package/ai-docs/templates/new-method/00-master.md +80 -0
- package/ai-docs/templates/new-method/01-requirements.md +232 -0
- package/ai-docs/templates/new-method/02-implementation.md +295 -0
- package/ai-docs/templates/new-method/03-tests.md +201 -0
- package/ai-docs/templates/new-method/04-validation.md +141 -0
- package/ai-docs/templates/new-service/00-master.md +109 -0
- package/ai-docs/templates/new-service/01-pre-questions.md +159 -0
- package/ai-docs/templates/new-service/02-code-generation.md +346 -0
- package/ai-docs/templates/new-service/03-integration.md +178 -0
- package/ai-docs/templates/new-service/04-test-generation.md +205 -0
- package/ai-docs/templates/new-service/05-validation.md +145 -0
- package/dist/cc.js +888 -49
- package/dist/cc.js.map +1 -1
- package/dist/config.js +13 -0
- package/dist/config.js.map +1 -1
- package/dist/constants.js +38 -3
- package/dist/constants.js.map +1 -1
- package/dist/index.js +54 -17
- package/dist/index.js.map +1 -1
- package/dist/metrics/MetricsManager.js +16 -0
- package/dist/metrics/MetricsManager.js.map +1 -1
- package/dist/metrics/behavioral-events.js +185 -0
- package/dist/metrics/behavioral-events.js.map +1 -1
- package/dist/metrics/constants.js +54 -4
- package/dist/metrics/constants.js.map +1 -1
- package/dist/services/AddressBook.js +18 -15
- package/dist/services/AddressBook.js.map +1 -1
- package/dist/services/AnswerCallOnWebexService.js +202 -0
- package/dist/services/AnswerCallOnWebexService.js.map +1 -0
- package/dist/services/ApiAiAssistant.js +369 -14
- package/dist/services/ApiAiAssistant.js.map +1 -1
- package/dist/services/EntryPoint.js +46 -68
- package/dist/services/EntryPoint.js.map +1 -1
- package/dist/services/Queue.js +27 -22
- package/dist/services/Queue.js.map +1 -1
- package/dist/services/UserPreference.js +427 -0
- package/dist/services/UserPreference.js.map +1 -0
- package/dist/services/WebCallingService.js +10 -2
- package/dist/services/WebCallingService.js.map +1 -1
- package/dist/services/WebexCrossClientService.js +225 -0
- package/dist/services/WebexCrossClientService.js.map +1 -0
- package/dist/services/WxAppTelephonyMercurySync.js +111 -0
- package/dist/services/WxAppTelephonyMercurySync.js.map +1 -0
- package/dist/services/config/Util.js +48 -48
- package/dist/services/config/Util.js.map +1 -1
- package/dist/services/config/constants.js +56 -78
- package/dist/services/config/constants.js.map +1 -1
- package/dist/services/config/index.js +100 -226
- package/dist/services/config/index.js.map +1 -1
- package/dist/services/config/types.js +93 -24
- package/dist/services/config/types.js.map +1 -1
- package/dist/services/constants.js +11 -1
- package/dist/services/constants.js.map +1 -1
- package/dist/services/core/Err.js.map +1 -1
- package/dist/services/core/Utils.js +131 -32
- package/dist/services/core/Utils.js.map +1 -1
- package/dist/services/core/WebexRequest.js +6 -2
- package/dist/services/core/WebexRequest.js.map +1 -1
- package/dist/services/core/aqm-reqs.js +17 -11
- package/dist/services/core/aqm-reqs.js.map +1 -1
- package/dist/services/core/constants.js +9 -1
- package/dist/services/core/constants.js.map +1 -1
- package/dist/services/core/types.js.map +1 -1
- package/dist/services/core/websocket/WebSocketManager.js +19 -2
- package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
- package/dist/services/core/websocket/types.js.map +1 -1
- package/dist/services/index.js +1 -1
- package/dist/services/index.js.map +1 -1
- package/dist/services/task/Task.js +955 -0
- package/dist/services/task/Task.js.map +1 -0
- package/dist/services/task/TaskFactory.js +50 -0
- package/dist/services/task/TaskFactory.js.map +1 -0
- package/dist/services/task/TaskManager.js +1272 -605
- package/dist/services/task/TaskManager.js.map +1 -1
- package/dist/services/task/TaskUtils.js +221 -27
- package/dist/services/task/TaskUtils.js.map +1 -1
- package/dist/services/task/WebexCallingUtils.js +70 -0
- package/dist/services/task/WebexCallingUtils.js.map +1 -0
- package/dist/services/task/constants.js +19 -2
- package/dist/services/task/constants.js.map +1 -1
- package/dist/services/task/contact.js +29 -0
- package/dist/services/task/contact.js.map +1 -1
- package/dist/services/task/digital/Digital.js +78 -0
- package/dist/services/task/digital/Digital.js.map +1 -0
- package/dist/services/task/state-machine/TaskStateMachine.js +982 -0
- package/dist/services/task/state-machine/TaskStateMachine.js.map +1 -0
- package/dist/services/task/state-machine/actions.js +572 -0
- package/dist/services/task/state-machine/actions.js.map +1 -0
- package/dist/services/task/state-machine/constants.js +161 -0
- package/dist/services/task/state-machine/constants.js.map +1 -0
- package/dist/services/task/state-machine/guards.js +379 -0
- package/dist/services/task/state-machine/guards.js.map +1 -0
- package/dist/services/task/state-machine/index.js +53 -0
- package/dist/services/task/state-machine/index.js.map +1 -0
- package/dist/services/task/state-machine/types.js +54 -0
- package/dist/services/task/state-machine/types.js.map +1 -0
- package/dist/services/task/state-machine/uiControlsComputer.js +703 -0
- package/dist/services/task/state-machine/uiControlsComputer.js.map +1 -0
- package/dist/services/task/taskDataNormalizer.js +99 -0
- package/dist/services/task/taskDataNormalizer.js.map +1 -0
- package/dist/services/task/types.js +215 -5
- package/dist/services/task/types.js.map +1 -1
- package/dist/services/task/voice/Voice.js +1504 -0
- package/dist/services/task/voice/Voice.js.map +1 -0
- package/dist/services/task/voice/WebRTC.js +152 -0
- package/dist/services/task/voice/WebRTC.js.map +1 -0
- package/dist/services/task/voice/wxAppOfferObservability.js +145 -0
- package/dist/services/task/voice/wxAppOfferObservability.js.map +1 -0
- package/dist/services/task/voice/wxAppVoiceMethods.js +395 -0
- package/dist/services/task/voice/wxAppVoiceMethods.js.map +1 -0
- package/dist/services/wxAppDiagnosticLogging.js +159 -0
- package/dist/services/wxAppDiagnosticLogging.js.map +1 -0
- package/dist/services/wxAppTelephonyUtils.js +19 -0
- package/dist/services/wxAppTelephonyUtils.js.map +1 -0
- package/dist/types/cc.d.ts +152 -9
- package/dist/types/config.d.ts +13 -0
- package/dist/types/constants.d.ts +36 -1
- package/dist/types/index.d.ts +54 -20
- package/dist/types/metrics/MetricsManager.d.ts +6 -0
- package/dist/types/metrics/constants.d.ts +48 -1
- package/dist/types/services/AddressBook.d.ts +2 -1
- package/dist/types/services/AnswerCallOnWebexService.d.ts +38 -0
- package/dist/types/services/ApiAiAssistant.d.ts +67 -5
- package/dist/types/services/EntryPoint.d.ts +7 -5
- package/dist/types/services/Queue.d.ts +5 -3
- package/dist/types/services/UserPreference.d.ts +118 -0
- package/dist/types/services/WebexCrossClientService.d.ts +32 -0
- package/dist/types/services/WxAppTelephonyMercurySync.d.ts +28 -0
- package/dist/types/services/config/Util.d.ts +4 -8
- package/dist/types/services/config/constants.d.ts +49 -76
- package/dist/types/services/config/index.d.ts +16 -64
- package/dist/types/services/config/types.d.ts +240 -114
- package/dist/types/services/constants.d.ts +9 -0
- package/dist/types/services/core/Err.d.ts +2 -0
- package/dist/types/services/core/Utils.d.ts +43 -13
- package/dist/types/services/core/WebexRequest.d.ts +1 -0
- package/dist/types/services/core/constants.d.ts +7 -0
- package/dist/types/services/core/types.d.ts +2 -0
- package/dist/types/services/core/websocket/WebSocketManager.d.ts +1 -0
- package/dist/types/services/core/websocket/types.d.ts +1 -1
- package/dist/types/services/index.d.ts +1 -1
- package/dist/types/services/task/Task.d.ts +186 -0
- package/dist/types/services/task/TaskFactory.d.ts +14 -0
- package/dist/types/services/task/TaskUtils.d.ts +54 -2
- package/dist/types/services/task/WebexCallingUtils.d.ts +11 -0
- package/dist/types/services/task/constants.d.ts +17 -0
- package/dist/types/services/task/contact.d.ts +4 -0
- package/dist/types/services/task/digital/Digital.d.ts +23 -0
- package/dist/types/services/task/state-machine/TaskStateMachine.d.ts +1442 -0
- package/dist/types/services/task/state-machine/actions.d.ts +10 -0
- package/dist/types/services/task/state-machine/constants.d.ts +107 -0
- package/dist/types/services/task/state-machine/guards.d.ts +103 -0
- package/dist/types/services/task/state-machine/index.d.ts +13 -0
- package/dist/types/services/task/state-machine/types.d.ts +277 -0
- package/dist/types/services/task/state-machine/uiControlsComputer.d.ts +9 -0
- package/dist/types/services/task/taskDataNormalizer.d.ts +10 -0
- package/dist/types/services/task/types.d.ts +738 -66
- package/dist/types/services/task/voice/Voice.d.ts +241 -0
- package/dist/types/services/task/voice/WebRTC.d.ts +54 -0
- package/dist/types/services/task/voice/wxAppOfferObservability.d.ts +39 -0
- package/dist/types/services/task/voice/wxAppVoiceMethods.d.ts +68 -0
- package/dist/types/services/wxAppDiagnosticLogging.d.ts +63 -0
- package/dist/types/services/wxAppTelephonyUtils.d.ts +5 -0
- package/dist/types/types.d.ts +213 -11
- package/dist/types/utils/PageCache.d.ts +20 -3
- package/dist/types/webex.d.ts +1 -0
- package/dist/types.js +168 -6
- package/dist/types.js.map +1 -1
- package/dist/utils/PageCache.js +19 -5
- package/dist/utils/PageCache.js.map +1 -1
- package/dist/webex.js +22 -2
- package/dist/webex.js.map +1 -1
- package/package.json +16 -12
- package/src/cc.ts +1137 -67
- package/src/config.ts +13 -0
- package/src/constants.ts +39 -1
- package/src/index.ts +62 -15
- package/src/metrics/MetricsManager.ts +16 -0
- package/src/metrics/ai-docs/AGENTS.md +350 -0
- package/src/metrics/ai-docs/ARCHITECTURE.md +338 -0
- package/src/metrics/ai-docs/metrics-spec.md +971 -0
- package/src/metrics/behavioral-events.ts +190 -0
- package/src/metrics/constants.ts +59 -4
- package/src/services/AddressBook.ts +17 -6
- package/src/services/AnswerCallOnWebexService.ts +239 -0
- package/src/services/ApiAiAssistant.ts +494 -15
- package/src/services/EntryPoint.ts +59 -60
- package/src/services/Queue.ts +29 -12
- package/src/services/UserPreference.ts +509 -0
- package/src/services/WebCallingService.ts +16 -2
- package/src/services/WebexCrossClientService.ts +298 -0
- package/src/services/WxAppTelephonyMercurySync.ts +142 -0
- package/src/services/agent/ai-docs/AGENTS.md +240 -0
- package/src/services/agent/ai-docs/ARCHITECTURE.md +304 -0
- package/src/services/agent/ai-docs/agent-spec.md +505 -0
- package/src/services/ai-docs/AGENTS.md +386 -0
- package/src/services/ai-docs/services-spec.md +512 -0
- package/src/services/config/Util.ts +54 -84
- package/src/services/config/ai-docs/AGENTS.md +250 -0
- package/src/services/config/ai-docs/ARCHITECTURE.md +413 -0
- package/src/services/config/ai-docs/config-spec.md +669 -0
- package/src/services/config/constants.ts +63 -85
- package/src/services/config/index.ts +116 -277
- package/src/services/config/types.ts +229 -125
- package/src/services/constants.ts +10 -0
- package/src/services/core/Err.ts +1 -0
- package/src/services/core/Utils.ts +151 -37
- package/src/services/core/WebexRequest.ts +3 -1
- package/src/services/core/ai-docs/AGENTS.md +381 -0
- package/src/services/core/ai-docs/ARCHITECTURE.md +698 -0
- package/src/services/core/ai-docs/core-spec.md +797 -0
- package/src/services/core/aqm-reqs.ts +18 -12
- package/src/services/core/constants.ts +8 -0
- package/src/services/core/types.ts +33 -1
- package/src/services/core/websocket/WebSocketManager.ts +28 -2
- package/src/services/core/websocket/types.ts +1 -1
- package/src/services/index.ts +1 -1
- package/src/services/task/Task.ts +1211 -0
- package/src/services/task/TaskFactory.ts +82 -0
- package/src/services/task/TaskManager.ts +1585 -724
- package/src/services/task/TaskUtils.ts +316 -25
- package/src/services/task/WebexCallingUtils.ts +136 -0
- package/src/services/task/ai-docs/AGENTS.md +457 -0
- package/src/services/task/ai-docs/ARCHITECTURE.md +595 -0
- package/src/services/task/ai-docs/task-spec.md +1501 -0
- package/src/services/task/constants.ts +18 -0
- package/src/services/task/contact.ts +30 -0
- package/src/services/task/digital/Digital.ts +102 -0
- package/src/services/task/state-machine/TaskStateMachine.ts +1320 -0
- package/src/services/task/state-machine/actions.ts +741 -0
- package/src/services/task/state-machine/ai-docs/AGENTS.md +460 -0
- package/src/services/task/state-machine/ai-docs/ARCHITECTURE.md +1156 -0
- package/src/services/task/state-machine/ai-docs/task-state-machine-spec.md +2247 -0
- package/src/services/task/state-machine/constants.ts +172 -0
- package/src/services/task/state-machine/guards.ts +442 -0
- package/src/services/task/state-machine/index.ts +28 -0
- package/src/services/task/state-machine/types.ts +258 -0
- package/src/services/task/state-machine/uiControlsComputer.ts +1135 -0
- package/src/services/task/taskDataNormalizer.ts +137 -0
- package/src/services/task/types.ts +918 -70
- package/src/services/task/voice/Voice.ts +1878 -0
- package/src/services/task/voice/WebRTC.ts +194 -0
- package/src/services/task/voice/wxAppOfferObservability.ts +204 -0
- package/src/services/task/voice/wxAppVoiceMethods.ts +575 -0
- package/src/services/wxAppDiagnosticLogging.ts +286 -0
- package/src/services/wxAppTelephonyUtils.ts +14 -0
- package/src/types.ts +272 -13
- package/src/utils/AGENTS.md +289 -0
- package/src/utils/PageCache.ts +38 -5
- package/src/utils/ai-docs/utils-spec.md +391 -0
- package/src/webex.js +10 -0
- package/test/unit/fixtures/aiSummaryTestUtils.ts +40 -0
- package/test/unit/spec/cc.ts +3553 -107
- package/test/unit/spec/index.ts +885 -0
- package/test/unit/spec/logger-proxy.ts +70 -0
- package/test/unit/spec/metrics/MetricsManager.ts +25 -0
- package/test/unit/spec/metrics/behavioral-events.ts +60 -0
- package/test/unit/spec/services/AddressBook.ts +37 -6
- package/test/unit/spec/services/AnswerCallOnWebexService.ts +264 -0
- package/test/unit/spec/services/ApiAiAssistant.ts +442 -23
- package/test/unit/spec/services/EntryPoint.ts +87 -40
- package/test/unit/spec/services/Queue.ts +123 -12
- package/test/unit/spec/services/UserPreference.ts +401 -0
- package/test/unit/spec/services/WebCallingService.ts +45 -1
- package/test/unit/spec/services/WebexCrossClientService.ts +509 -0
- package/test/unit/spec/services/WxAppTelephonyMercurySync.ts +136 -0
- package/test/unit/spec/services/config/Util.ts +501 -0
- package/test/unit/spec/services/config/index.ts +317 -547
- package/test/unit/spec/services/core/Utils.ts +447 -8
- package/test/unit/spec/services/core/WebexRequest.ts +8 -7
- package/test/unit/spec/services/core/aqm-reqs.ts +142 -1
- package/test/unit/spec/services/core/websocket/WebSocketManager.ts +129 -53
- package/test/unit/spec/services/task/AutoWrapup.ts +63 -0
- package/test/unit/spec/services/task/Task.ts +2723 -0
- package/test/unit/spec/services/task/TaskFactory.ts +116 -0
- package/test/unit/spec/services/task/TaskManager.ts +4734 -1769
- package/test/unit/spec/services/task/TaskUtils.ts +307 -0
- package/test/unit/spec/services/task/WebexCallingUtils.ts +153 -0
- package/test/unit/spec/services/task/contact.ts +33 -0
- package/test/unit/spec/services/task/digital/Digital.ts +105 -0
- package/test/unit/spec/services/task/state-machine/TaskStateMachine.ts +4060 -0
- package/test/unit/spec/services/task/state-machine/guards.ts +839 -0
- package/test/unit/spec/services/task/state-machine/types.ts +18 -0
- package/test/unit/spec/services/task/state-machine/uiControlsComputer.ts +3101 -0
- package/test/unit/spec/services/task/taskTestUtils.ts +87 -0
- package/test/unit/spec/services/task/voice/Voice.ts +2355 -0
- package/test/unit/spec/services/task/voice/WebRTC.ts +235 -0
- package/test/unit/spec/services/task/voice/wxAppOfferObservability.ts +361 -0
- package/test/unit/spec/services/task/voice/wxAppVoiceMethods.ts +719 -0
- package/test/unit/spec/services/wxAppDiagnosticLogging.ts +179 -0
- package/test/unit/spec/wellnessSampleUtils.ts +288 -0
- package/typedoc.md +1 -1
- package/umd/contact-center.min.js +2 -2
- package/umd/contact-center.min.js.map +1 -1
- package/dist/services/task/index.js +0 -1530
- package/dist/services/task/index.js.map +0 -1
- package/dist/types/services/task/index.d.ts +0 -650
- package/src/services/task/index.ts +0 -1806
- package/test/unit/spec/services/task/index.ts +0 -2205
|
@@ -1,6 +1,11 @@
|
|
|
1
1
|
import * as Agent from '../agent/types';
|
|
2
|
+
import { COLLABORATION_ACCESS } from './constants';
|
|
3
|
+
/** Desktop Profile access level for a collaboration destination category. */
|
|
4
|
+
export type CollaborationAccess = Enum<typeof COLLABORATION_ACCESS>;
|
|
2
5
|
/**
|
|
3
|
-
*
|
|
6
|
+
* Contact Center backend and realtime event types.
|
|
7
|
+
*
|
|
8
|
+
* Includes task lifecycle, transcript, suggested-response, and AI summary events.
|
|
4
9
|
* @enum {string}
|
|
5
10
|
* @private
|
|
6
11
|
* @ignore
|
|
@@ -50,6 +55,8 @@ export declare const CC_TASK_EVENTS: {
|
|
|
50
55
|
readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
|
|
51
56
|
/** Event emitted when participant leaving conference fails */
|
|
52
57
|
readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
|
|
58
|
+
/** Event emitted when dropping another conference participant fails */
|
|
59
|
+
readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
|
|
53
60
|
/** Event emitted when consultation conference end fails */
|
|
54
61
|
readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
|
|
55
62
|
/** Event emitted when conference is successfully transferred */
|
|
@@ -58,6 +65,8 @@ export declare const CC_TASK_EVENTS: {
|
|
|
58
65
|
readonly AGENT_CONFERENCE_TRANSFER_FAILED: "AgentConferenceTransferFailed";
|
|
59
66
|
/** Event emitted for post-call activity by participant */
|
|
60
67
|
readonly PARTICIPANT_POST_CALL_ACTIVITY: "ParticipantPostCallActivity";
|
|
68
|
+
/** Event emitted when consulted participant is being moved/transferred */
|
|
69
|
+
readonly CONSULTED_PARTICIPANT_MOVING: "ConsultedParticipantMoving";
|
|
61
70
|
/** Event emitted when contact is blind transferred */
|
|
62
71
|
readonly AGENT_BLIND_TRANSFERRED: "AgentBlindTransferred";
|
|
63
72
|
/** Event emitted when blind transfer fails */
|
|
@@ -74,6 +83,8 @@ export declare const CC_TASK_EVENTS: {
|
|
|
74
83
|
readonly AGENT_CONSULT_TRANSFER_FAILED: "AgentConsultTransferFailed";
|
|
75
84
|
/** Event emitted when contact recording is paused */
|
|
76
85
|
readonly CONTACT_RECORDING_PAUSED: "ContactRecordingPaused";
|
|
86
|
+
/** Event emitted when contact recording is started */
|
|
87
|
+
readonly CONTACT_RECORDING_STARTED: "ContactRecordingStarted";
|
|
77
88
|
/** Event emitted when pausing contact recording fails */
|
|
78
89
|
readonly CONTACT_RECORDING_PAUSE_FAILED: "ContactRecordingPauseFailed";
|
|
79
90
|
/** Event emitted when contact recording is resumed */
|
|
@@ -84,6 +95,10 @@ export declare const CC_TASK_EVENTS: {
|
|
|
84
95
|
readonly CONTACT_ENDED: "ContactEnded";
|
|
85
96
|
/** Event emitted when contact is merged */
|
|
86
97
|
readonly CONTACT_MERGED: "ContactMerged";
|
|
98
|
+
/** Event emitted when contact payload is updated (routing updates) */
|
|
99
|
+
readonly CONTACT_UPDATED: "ContactUpdated";
|
|
100
|
+
/** Event emitted when contact owner changes */
|
|
101
|
+
readonly CONTACT_OWNER_CHANGED: "ContactOwnerChanged";
|
|
87
102
|
/** Event emitted when ending contact fails */
|
|
88
103
|
readonly AGENT_CONTACT_END_FAILED: "AgentContactEndFailed";
|
|
89
104
|
/** Event emitted when agent enters wrap-up state */
|
|
@@ -116,12 +131,23 @@ export declare const CC_TASK_EVENTS: {
|
|
|
116
131
|
readonly CAMPAIGN_PREVIEW_REMOVE_FAILED: "CampaignPreviewRemoveFailed";
|
|
117
132
|
/** Event emitted when a real-time transcript chunk is received */
|
|
118
133
|
readonly REAL_TIME_TRANSCRIPTION: "REAL_TIME_TRANSCRIPTION";
|
|
134
|
+
/** Event emitted when an AI assistant suggested response is available */
|
|
135
|
+
readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
|
|
136
|
+
/** Event emitted when backend acknowledges it is listening for more context */
|
|
137
|
+
readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
|
|
138
|
+
/** Event received when a post-call summary is available through realtime delivery */
|
|
139
|
+
readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
|
|
140
|
+
/** Event received when a mid-call summary is available through realtime delivery */
|
|
141
|
+
readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
|
|
142
|
+
/** Event received when AI-summary feature enablement is available through realtime delivery */
|
|
143
|
+
readonly FEATURE_ENABLEMENT: "FEATURE_ENABLEMENT";
|
|
144
|
+
/** Event received when a subsequent agent receives a mid-call summary */
|
|
145
|
+
readonly MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: "MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT";
|
|
119
146
|
};
|
|
120
147
|
/**
|
|
121
148
|
* Events emitted on Contact Center agent operations
|
|
122
149
|
* @enum {string}
|
|
123
|
-
* @
|
|
124
|
-
* @ignore
|
|
150
|
+
* @public
|
|
125
151
|
*/
|
|
126
152
|
export declare const CC_AGENT_EVENTS: {
|
|
127
153
|
/** Welcome event when agent connects to websocket/backend */
|
|
@@ -160,6 +186,8 @@ export declare const CC_AGENT_EVENTS: {
|
|
|
160
186
|
readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
|
|
161
187
|
/** Event emitted when contact is reserved for agent */
|
|
162
188
|
readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
|
|
189
|
+
/** Agent-level Agent Wellness Break notification */
|
|
190
|
+
readonly WELLNESS_BREAK: "WellnessBreak";
|
|
163
191
|
};
|
|
164
192
|
/**
|
|
165
193
|
* Combined Contact Center events including both agent and task events
|
|
@@ -211,6 +239,8 @@ export declare const CC_EVENTS: {
|
|
|
211
239
|
readonly PARTICIPANT_LEFT_CONFERENCE: "ParticipantLeftConference";
|
|
212
240
|
/** Event emitted when participant leaving conference fails */
|
|
213
241
|
readonly PARTICIPANT_LEFT_CONFERENCE_FAILED: "ParticipantLeftConferenceFailed";
|
|
242
|
+
/** Event emitted when dropping another conference participant fails */
|
|
243
|
+
readonly PARTICIPANT_DROP_CONFERENCE_FAILED: "ParticipantDropConferenceFailed";
|
|
214
244
|
/** Event emitted when consultation conference end fails */
|
|
215
245
|
readonly AGENT_CONSULT_CONFERENCE_END_FAILED: "AgentConsultConferenceEndFailed";
|
|
216
246
|
/** Event emitted when conference is successfully transferred */
|
|
@@ -219,6 +249,8 @@ export declare const CC_EVENTS: {
|
|
|
219
249
|
readonly AGENT_CONFERENCE_TRANSFER_FAILED: "AgentConferenceTransferFailed";
|
|
220
250
|
/** Event emitted for post-call activity by participant */
|
|
221
251
|
readonly PARTICIPANT_POST_CALL_ACTIVITY: "ParticipantPostCallActivity";
|
|
252
|
+
/** Event emitted when consulted participant is being moved/transferred */
|
|
253
|
+
readonly CONSULTED_PARTICIPANT_MOVING: "ConsultedParticipantMoving";
|
|
222
254
|
/** Event emitted when contact is blind transferred */
|
|
223
255
|
readonly AGENT_BLIND_TRANSFERRED: "AgentBlindTransferred";
|
|
224
256
|
/** Event emitted when blind transfer fails */
|
|
@@ -235,6 +267,8 @@ export declare const CC_EVENTS: {
|
|
|
235
267
|
readonly AGENT_CONSULT_TRANSFER_FAILED: "AgentConsultTransferFailed";
|
|
236
268
|
/** Event emitted when contact recording is paused */
|
|
237
269
|
readonly CONTACT_RECORDING_PAUSED: "ContactRecordingPaused";
|
|
270
|
+
/** Event emitted when contact recording is started */
|
|
271
|
+
readonly CONTACT_RECORDING_STARTED: "ContactRecordingStarted";
|
|
238
272
|
/** Event emitted when pausing contact recording fails */
|
|
239
273
|
readonly CONTACT_RECORDING_PAUSE_FAILED: "ContactRecordingPauseFailed";
|
|
240
274
|
/** Event emitted when contact recording is resumed */
|
|
@@ -245,6 +279,10 @@ export declare const CC_EVENTS: {
|
|
|
245
279
|
readonly CONTACT_ENDED: "ContactEnded";
|
|
246
280
|
/** Event emitted when contact is merged */
|
|
247
281
|
readonly CONTACT_MERGED: "ContactMerged";
|
|
282
|
+
/** Event emitted when contact payload is updated (routing updates) */
|
|
283
|
+
readonly CONTACT_UPDATED: "ContactUpdated";
|
|
284
|
+
/** Event emitted when contact owner changes */
|
|
285
|
+
readonly CONTACT_OWNER_CHANGED: "ContactOwnerChanged";
|
|
248
286
|
/** Event emitted when ending contact fails */
|
|
249
287
|
readonly AGENT_CONTACT_END_FAILED: "AgentContactEndFailed";
|
|
250
288
|
/** Event emitted when agent enters wrap-up state */
|
|
@@ -277,6 +315,18 @@ export declare const CC_EVENTS: {
|
|
|
277
315
|
readonly CAMPAIGN_PREVIEW_REMOVE_FAILED: "CampaignPreviewRemoveFailed";
|
|
278
316
|
/** Event emitted when a real-time transcript chunk is received */
|
|
279
317
|
readonly REAL_TIME_TRANSCRIPTION: "REAL_TIME_TRANSCRIPTION";
|
|
318
|
+
/** Event emitted when an AI assistant suggested response is available */
|
|
319
|
+
readonly SUGGESTED_RESPONSE: "SUGGESTED_RESPONSE";
|
|
320
|
+
/** Event emitted when backend acknowledges it is listening for more context */
|
|
321
|
+
readonly SUGGESTED_RESPONSE_ACKNOWLEDGE: "SUGGESTED_RESPONSE_ACKNOWLEDGE";
|
|
322
|
+
/** Event received when a post-call summary is available through realtime delivery */
|
|
323
|
+
readonly POST_CALL_SUMMARY: "POST_CALL_SUMMARY";
|
|
324
|
+
/** Event received when a mid-call summary is available through realtime delivery */
|
|
325
|
+
readonly MID_CALL_SUMMARY: "MID_CALL_SUMMARY";
|
|
326
|
+
/** Event received when AI-summary feature enablement is available through realtime delivery */
|
|
327
|
+
readonly FEATURE_ENABLEMENT: "FEATURE_ENABLEMENT";
|
|
328
|
+
/** Event received when a subsequent agent receives a mid-call summary */
|
|
329
|
+
readonly MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: "MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT";
|
|
280
330
|
/** Welcome event when agent connects to websocket/backend */
|
|
281
331
|
readonly WELCOME: "Welcome";
|
|
282
332
|
/** Event emitted when agent re-login is successful */
|
|
@@ -313,6 +363,8 @@ export declare const CC_EVENTS: {
|
|
|
313
363
|
readonly AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: "BuddyAgentsRetrieveFailed";
|
|
314
364
|
/** Event emitted when contact is reserved for agent */
|
|
315
365
|
readonly AGENT_CONTACT_RESERVED: "AgentContactReserved";
|
|
366
|
+
/** Agent-level Agent Wellness Break notification */
|
|
367
|
+
readonly WELLNESS_BREAK: "WellnessBreak";
|
|
316
368
|
};
|
|
317
369
|
/**
|
|
318
370
|
* Event data received when agent connects to the system
|
|
@@ -322,6 +374,14 @@ export type WelcomeEvent = {
|
|
|
322
374
|
/** ID of the agent that connected */
|
|
323
375
|
agentId: string;
|
|
324
376
|
};
|
|
377
|
+
/**
|
|
378
|
+
* Available login options for voice channel access
|
|
379
|
+
* 'AGENT_DN' - Login using agent's DN
|
|
380
|
+
* 'EXTENSION' - Login using extension number
|
|
381
|
+
* 'BROWSER' - Login using browser-based WebRTC
|
|
382
|
+
* @public
|
|
383
|
+
*/
|
|
384
|
+
export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
|
|
325
385
|
/**
|
|
326
386
|
* Response type for welcome events which can be either success or error
|
|
327
387
|
* @public
|
|
@@ -343,7 +403,7 @@ export type WebSocketEvent = {
|
|
|
343
403
|
data: WelcomeEvent | Agent.StationLoginSuccess | Agent.LogoutSuccess | Agent.ReloginSuccess | Agent.StateChangeSuccess | Agent.BuddyAgentsSuccess;
|
|
344
404
|
};
|
|
345
405
|
/**
|
|
346
|
-
*
|
|
406
|
+
* Agent identity carried by the `user` section of the user desktop-login aggregate.
|
|
347
407
|
*/
|
|
348
408
|
export type AgentResponse = {
|
|
349
409
|
/**
|
|
@@ -370,14 +430,6 @@ export type AgentResponse = {
|
|
|
370
430
|
* The email address of the agent.
|
|
371
431
|
*/
|
|
372
432
|
email: string;
|
|
373
|
-
/**
|
|
374
|
-
* Team IDs assigned to the agent.
|
|
375
|
-
*/
|
|
376
|
-
teamIds: string[];
|
|
377
|
-
/**
|
|
378
|
-
* Multimedia profile ID associated with the agent.
|
|
379
|
-
*/
|
|
380
|
-
multimediaProfileId: string;
|
|
381
433
|
/**
|
|
382
434
|
* Skill profile ID of the agent.
|
|
383
435
|
*/
|
|
@@ -387,20 +439,23 @@ export type AgentResponse = {
|
|
|
387
439
|
*/
|
|
388
440
|
siteId: string;
|
|
389
441
|
/**
|
|
390
|
-
* Database ID of the agent
|
|
442
|
+
* Database ID of the agent, distinct from `ciUserId`. Passed as `userDbId` to the team lookup,
|
|
443
|
+
* which sends it as the backend's `filter=userId==` value.
|
|
391
444
|
*/
|
|
392
|
-
dbId
|
|
445
|
+
dbId: string;
|
|
393
446
|
/**
|
|
394
447
|
* The default dialed number of the agent.
|
|
448
|
+
* Note: The API returns this field as "deafultDialledNumber" (with typo).
|
|
395
449
|
*/
|
|
396
|
-
|
|
450
|
+
deafultDialledNumber?: string;
|
|
397
451
|
};
|
|
398
452
|
/**
|
|
399
|
-
*
|
|
453
|
+
* Desktop Profile settings carried by the `agentProfile` section of the user desktop-login
|
|
454
|
+
* aggregate.
|
|
400
455
|
*/
|
|
401
|
-
export type
|
|
456
|
+
export type AgentProfile = {
|
|
402
457
|
/**
|
|
403
|
-
* Represents the voice options of an agent.
|
|
458
|
+
* Represents the voice options of an agent. The order is nondeterministic; treat as a set.
|
|
404
459
|
*/
|
|
405
460
|
loginVoiceOptions: LoginOption[];
|
|
406
461
|
/**
|
|
@@ -411,14 +466,6 @@ export type DesktopProfileResponse = {
|
|
|
411
466
|
* Idle codes that the agents can select in Agent Desktop. It can take one of these values: ALL - To make all idle codes available. SPECIFIC - To make specific codes available.
|
|
412
467
|
*/
|
|
413
468
|
accessIdleCode: string;
|
|
414
|
-
/**
|
|
415
|
-
* Wrap-up codes list that the agents can select when they wrap up a contact.
|
|
416
|
-
*/
|
|
417
|
-
wrapUpCodes: string[];
|
|
418
|
-
/**
|
|
419
|
-
* Idle codes list that the agents can select in Agent Desktop.
|
|
420
|
-
*/
|
|
421
|
-
idleCodes: string[];
|
|
422
469
|
/**
|
|
423
470
|
* Dial plan enabled for the agent.
|
|
424
471
|
*/
|
|
@@ -432,9 +479,9 @@ export type DesktopProfileResponse = {
|
|
|
432
479
|
*/
|
|
433
480
|
autoWrapUp: boolean;
|
|
434
481
|
/**
|
|
435
|
-
*
|
|
482
|
+
* Whether the agent personal greeting is enabled.
|
|
436
483
|
*/
|
|
437
|
-
|
|
484
|
+
agentPersonalGreeting?: boolean;
|
|
438
485
|
/**
|
|
439
486
|
* Auto wrap-up after seconds.
|
|
440
487
|
*/
|
|
@@ -447,6 +494,18 @@ export type DesktopProfileResponse = {
|
|
|
447
494
|
* Allow auto wrap-up extension.
|
|
448
495
|
*/
|
|
449
496
|
allowAutoWrapUpExtension: boolean;
|
|
497
|
+
/**
|
|
498
|
+
* Access control for queues assigned to the agent (ALL, SPECIFIC, or NONE).
|
|
499
|
+
*/
|
|
500
|
+
accessQueue: CollaborationAccess;
|
|
501
|
+
/**
|
|
502
|
+
* Access control for entry points assigned to the agent.
|
|
503
|
+
*/
|
|
504
|
+
accessEntryPoint: CollaborationAccess;
|
|
505
|
+
/**
|
|
506
|
+
* Access control for buddy teams assigned to the agent.
|
|
507
|
+
*/
|
|
508
|
+
accessBuddyTeam: CollaborationAccess;
|
|
450
509
|
/**
|
|
451
510
|
* Outdial enabled for the agent.
|
|
452
511
|
*/
|
|
@@ -459,6 +518,10 @@ export type DesktopProfileResponse = {
|
|
|
459
518
|
* Outdial ANI ID of the agent.
|
|
460
519
|
*/
|
|
461
520
|
outdialANIId: string;
|
|
521
|
+
/**
|
|
522
|
+
* Whether the agent can schedule and manage callbacks.
|
|
523
|
+
*/
|
|
524
|
+
scheduleAndManageCallBack?: boolean;
|
|
462
525
|
/**
|
|
463
526
|
* Consult to queue allowed.
|
|
464
527
|
*/
|
|
@@ -466,27 +529,18 @@ export type DesktopProfileResponse = {
|
|
|
466
529
|
/**
|
|
467
530
|
* Address book ID of the agent.
|
|
468
531
|
*/
|
|
469
|
-
addressBookId
|
|
532
|
+
addressBookId?: string;
|
|
470
533
|
/**
|
|
471
534
|
* Viewable statistics of the agent.
|
|
472
535
|
*/
|
|
473
536
|
viewableStatistics: {
|
|
474
|
-
id: string;
|
|
475
537
|
agentStats: boolean;
|
|
476
|
-
|
|
477
|
-
contactServiceQueues: string[];
|
|
478
|
-
loggedInTeamStats: boolean;
|
|
479
|
-
accessTeamStats: string;
|
|
480
|
-
teams: string[];
|
|
538
|
+
aiAgentPerformance?: boolean;
|
|
481
539
|
};
|
|
482
540
|
/**
|
|
483
541
|
* Agent DN validation of the agent.
|
|
484
542
|
*/
|
|
485
543
|
agentDNValidation: string;
|
|
486
|
-
/**
|
|
487
|
-
* Dial plans of the agent.
|
|
488
|
-
*/
|
|
489
|
-
dialPlans: string[];
|
|
490
544
|
/**
|
|
491
545
|
* Timeout desktop inactivity custom enabled.
|
|
492
546
|
*/
|
|
@@ -494,23 +548,7 @@ export type DesktopProfileResponse = {
|
|
|
494
548
|
/**
|
|
495
549
|
* Timeout desktop inactivity minutes.
|
|
496
550
|
*/
|
|
497
|
-
timeoutDesktopInactivityMins
|
|
498
|
-
/**
|
|
499
|
-
* Show user details in Microsoft enabled or not.
|
|
500
|
-
*/
|
|
501
|
-
showUserDetailsMS: boolean;
|
|
502
|
-
/**
|
|
503
|
-
* State synchronization in Microsoft enabled or not.
|
|
504
|
-
*/
|
|
505
|
-
stateSynchronizationMS: boolean;
|
|
506
|
-
/**
|
|
507
|
-
* Show user details in Webex enabled or not.
|
|
508
|
-
*/
|
|
509
|
-
showUserDetailsWebex: boolean;
|
|
510
|
-
/**
|
|
511
|
-
* State synchronization in Webex enabled or not.
|
|
512
|
-
*/
|
|
513
|
-
stateSynchronizationWebex: boolean;
|
|
551
|
+
timeoutDesktopInactivityMins?: number;
|
|
514
552
|
};
|
|
515
553
|
/**
|
|
516
554
|
* Response containing multimedia profile configuration for an agent
|
|
@@ -657,7 +695,8 @@ export type ListTeamsResponse = {
|
|
|
657
695
|
};
|
|
658
696
|
};
|
|
659
697
|
/**
|
|
660
|
-
* Basic organization information
|
|
698
|
+
* Basic organization information carried by the `organization` section of the org desktop-login
|
|
699
|
+
* aggregate.
|
|
661
700
|
* @private
|
|
662
701
|
* @ignore
|
|
663
702
|
*/
|
|
@@ -666,11 +705,10 @@ export type OrgInfo = {
|
|
|
666
705
|
tenantId: string;
|
|
667
706
|
/** Organization timezone */
|
|
668
707
|
timezone: string;
|
|
669
|
-
/** Current environment (e.g., 'produs1', 'intgus1') */
|
|
670
|
-
environment: string;
|
|
671
708
|
};
|
|
672
709
|
/**
|
|
673
|
-
* Organization-wide feature settings
|
|
710
|
+
* Organization-wide feature settings carried by the `organizationSetting` section of the org
|
|
711
|
+
* desktop-login aggregate.
|
|
674
712
|
* @private
|
|
675
713
|
*/
|
|
676
714
|
export type OrgSettings = {
|
|
@@ -680,6 +718,8 @@ export type OrgSettings = {
|
|
|
680
718
|
maskSensitiveData: boolean;
|
|
681
719
|
/** Whether campaign manager features are enabled */
|
|
682
720
|
campaignManagerEnabled: boolean;
|
|
721
|
+
/** Number of AI Assistant licenses assigned to the organization */
|
|
722
|
+
aiAssistantQuantity?: number | null;
|
|
683
723
|
};
|
|
684
724
|
/**
|
|
685
725
|
* Contact center site configuration information
|
|
@@ -698,12 +738,13 @@ export type SiteInfo = {
|
|
|
698
738
|
systemDefault: boolean;
|
|
699
739
|
};
|
|
700
740
|
/**
|
|
701
|
-
* Tenant-level configuration
|
|
741
|
+
* Tenant-level configuration carried by the `tenantConfiguration` section of the org
|
|
742
|
+
* desktop-login aggregate.
|
|
702
743
|
* @private
|
|
703
744
|
*/
|
|
704
745
|
export type TenantData = {
|
|
705
|
-
/** Desktop inactivity timeout in minutes */
|
|
706
|
-
timeoutDesktopInactivityMins
|
|
746
|
+
/** Desktop inactivity timeout in minutes. Omitted when the timeout is not enabled. */
|
|
747
|
+
timeoutDesktopInactivityMins?: number;
|
|
707
748
|
/** Whether default DN is enforced */
|
|
708
749
|
forceDefaultDn: boolean;
|
|
709
750
|
/** Regex pattern for default DN validation */
|
|
@@ -726,16 +767,44 @@ export type TenantData = {
|
|
|
726
767
|
lostConnectionRecoveryTimeout: number;
|
|
727
768
|
};
|
|
728
769
|
/**
|
|
729
|
-
* URL
|
|
770
|
+
* URL mappings carried by the `urlMappings` section of the org desktop-login aggregate, keyed by
|
|
771
|
+
* mapping name. The aggregate returns `{}` when the organization has no Acqueon configuration.
|
|
730
772
|
* @public
|
|
731
773
|
*/
|
|
732
|
-
export type
|
|
733
|
-
|
|
734
|
-
|
|
735
|
-
|
|
736
|
-
|
|
737
|
-
|
|
738
|
-
|
|
774
|
+
export type OrgUrlMappings = {
|
|
775
|
+
/** Acqueon API endpoint URL */
|
|
776
|
+
ACQUEON_API_URL?: string;
|
|
777
|
+
/** Acqueon console URL */
|
|
778
|
+
ACQUEON_CONSOLE_URL?: string;
|
|
779
|
+
};
|
|
780
|
+
/**
|
|
781
|
+
* Organization-level Microsoft Teams integration configuration carried by the `microsoftConfig`
|
|
782
|
+
* section of the org desktop-login aggregate. The whole section is absent when the organization
|
|
783
|
+
* has no Microsoft integration.
|
|
784
|
+
* @public
|
|
785
|
+
*/
|
|
786
|
+
export type MicrosoftConfig = {
|
|
787
|
+
/** Whether to show user details in Teams */
|
|
788
|
+
showUserDetails?: boolean;
|
|
789
|
+
/** Whether to sync agent state with Teams */
|
|
790
|
+
stateSynchronization?: boolean;
|
|
791
|
+
/** Whether the integration is enabled organization-wide */
|
|
792
|
+
active?: boolean;
|
|
793
|
+
/** Idle codes mapped to Teams presence states */
|
|
794
|
+
idleCodes?: Record<string, string>;
|
|
795
|
+
};
|
|
796
|
+
/**
|
|
797
|
+
* Organization-level Webex integration configuration carried by the `webexConfig` section of the
|
|
798
|
+
* org desktop-login aggregate.
|
|
799
|
+
* @public
|
|
800
|
+
*/
|
|
801
|
+
export type WebexConfig = {
|
|
802
|
+
/** Whether to show user details in Webex */
|
|
803
|
+
showUserDetails?: boolean;
|
|
804
|
+
/** Whether to sync agent state with Webex */
|
|
805
|
+
stateSynchronization?: boolean;
|
|
806
|
+
/** Idle codes mapped to Webex presence states */
|
|
807
|
+
idleCodes?: Record<string, string>;
|
|
739
808
|
};
|
|
740
809
|
/**
|
|
741
810
|
* Constant representing idle code
|
|
@@ -805,6 +874,8 @@ export type DialPlanEntity = {
|
|
|
805
874
|
strippedChars: string;
|
|
806
875
|
/** Name of the dial plan */
|
|
807
876
|
name: string;
|
|
877
|
+
/** Whether the dial plan is active */
|
|
878
|
+
active: boolean;
|
|
808
879
|
};
|
|
809
880
|
/**
|
|
810
881
|
* Complete dial plan configuration for number handling
|
|
@@ -906,26 +977,6 @@ export type WrapupData = {
|
|
|
906
977
|
allowCancelAutoWrapup?: boolean;
|
|
907
978
|
};
|
|
908
979
|
};
|
|
909
|
-
/**
|
|
910
|
-
* Available login options for voice channel access
|
|
911
|
-
* 'AGENT_DN' - Login using agent's DN
|
|
912
|
-
* 'EXTENSION' - Login using extension number
|
|
913
|
-
* 'BROWSER' - Login using browser-based WebRTC
|
|
914
|
-
* @public
|
|
915
|
-
*/
|
|
916
|
-
export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
|
|
917
|
-
/**
|
|
918
|
-
* Team configuration information
|
|
919
|
-
* @public
|
|
920
|
-
*/
|
|
921
|
-
export type Team = {
|
|
922
|
-
/** Unique team identifier */
|
|
923
|
-
teamId: string;
|
|
924
|
-
/** Team display name */
|
|
925
|
-
teamName: string;
|
|
926
|
-
/** Optional desktop layout configuration identifier */
|
|
927
|
-
desktopLayoutId?: string;
|
|
928
|
-
};
|
|
929
980
|
/**
|
|
930
981
|
* Basic queue configuration information
|
|
931
982
|
* @public
|
|
@@ -947,11 +998,12 @@ export type URLMappings = {
|
|
|
947
998
|
acqueonConsoleUrl: string;
|
|
948
999
|
};
|
|
949
1000
|
/**
|
|
950
|
-
* AI feature
|
|
1001
|
+
* AI feature flags carried by the `aiFeature` section of the org desktop-login aggregate.
|
|
951
1002
|
* @public
|
|
952
1003
|
*/
|
|
953
1004
|
export type AIFeatureFlags = {
|
|
954
|
-
id
|
|
1005
|
+
/** Not carried by the aggregate; retained for responses that still supply a record id. */
|
|
1006
|
+
id?: string;
|
|
955
1007
|
realtimeTranscripts?: {
|
|
956
1008
|
enable?: boolean;
|
|
957
1009
|
agentInclusionType?: string;
|
|
@@ -976,26 +1028,40 @@ export type AIFeatureFlags = {
|
|
|
976
1028
|
queuesInclusionType?: string;
|
|
977
1029
|
surveyDataSource?: string;
|
|
978
1030
|
};
|
|
979
|
-
links?: string[];
|
|
980
|
-
createdTime?: number;
|
|
981
|
-
lastUpdatedTime?: number;
|
|
982
1031
|
};
|
|
983
1032
|
/**
|
|
984
|
-
*
|
|
1033
|
+
* Aggregated organization configuration returned by `organization/{orgId}/desktop-login`.
|
|
1034
|
+
* Replaces the separate organization, organization-setting, tenant-configuration,
|
|
1035
|
+
* org-url-mapping and ai-feature calls.
|
|
985
1036
|
* @public
|
|
986
1037
|
*/
|
|
987
|
-
export type
|
|
988
|
-
|
|
989
|
-
|
|
990
|
-
|
|
991
|
-
|
|
992
|
-
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
|
|
996
|
-
|
|
997
|
-
|
|
998
|
-
|
|
1038
|
+
export type OrgDesktopLoginResponse = {
|
|
1039
|
+
/** Organization identity and timezone */
|
|
1040
|
+
organization: OrgInfo;
|
|
1041
|
+
/** Organization-wide feature settings */
|
|
1042
|
+
organizationSetting: OrgSettings;
|
|
1043
|
+
/** Tenant-level configuration */
|
|
1044
|
+
tenantConfiguration: TenantData;
|
|
1045
|
+
/** External integration URLs, keyed by mapping name */
|
|
1046
|
+
urlMappings?: OrgUrlMappings;
|
|
1047
|
+
/** AI feature flags */
|
|
1048
|
+
aiFeature?: AIFeatureFlags;
|
|
1049
|
+
/** Microsoft Teams integration configuration; absent when not configured */
|
|
1050
|
+
microsoftConfig?: MicrosoftConfig;
|
|
1051
|
+
/** Webex integration configuration */
|
|
1052
|
+
webexConfig?: WebexConfig;
|
|
1053
|
+
};
|
|
1054
|
+
/**
|
|
1055
|
+
* Aggregated user configuration returned by
|
|
1056
|
+
* `organization/{orgId}/v2/user/by-ci-user-id/{ciUserId}/desktop-login`.
|
|
1057
|
+
* Replaces the separate user and agent-profile calls.
|
|
1058
|
+
* @public
|
|
1059
|
+
*/
|
|
1060
|
+
export type UserDesktopLoginResponse = {
|
|
1061
|
+
/** Agent identity */
|
|
1062
|
+
user: AgentResponse;
|
|
1063
|
+
/** Desktop Profile settings for the agent */
|
|
1064
|
+
agentProfile: AgentProfile;
|
|
999
1065
|
};
|
|
1000
1066
|
/**
|
|
1001
1067
|
* Comprehensive agent profile configuration in the contact center system
|
|
@@ -1017,8 +1083,8 @@ export type Profile = {
|
|
|
1017
1083
|
/** Whether to sync agent state with Webex */
|
|
1018
1084
|
stateSynchronizationWebex?: boolean;
|
|
1019
1085
|
};
|
|
1020
|
-
/** List of teams the agent belongs to */
|
|
1021
|
-
teams:
|
|
1086
|
+
/** List of teams the agent belongs to, as returned by the team API */
|
|
1087
|
+
teams: TeamList[];
|
|
1022
1088
|
/** Agent's default dial number */
|
|
1023
1089
|
defaultDn: string;
|
|
1024
1090
|
dn?: string;
|
|
@@ -1081,7 +1147,7 @@ export type Profile = {
|
|
|
1081
1147
|
/** Outbound entry point */
|
|
1082
1148
|
outDialEp: string;
|
|
1083
1149
|
/** Whether ending calls is enabled */
|
|
1084
|
-
|
|
1150
|
+
isEndTaskEnabled: boolean;
|
|
1085
1151
|
/** Whether ending consultations is enabled */
|
|
1086
1152
|
isEndConsultEnabled: boolean;
|
|
1087
1153
|
/** Optional lifecycle manager URL */
|
|
@@ -1092,6 +1158,12 @@ export type Profile = {
|
|
|
1092
1158
|
agentAnalyzerId?: string;
|
|
1093
1159
|
/** Whether consult to queue is allowed */
|
|
1094
1160
|
allowConsultToQueue: boolean;
|
|
1161
|
+
/** Access control for queues on Desktop Profile Collaboration tab */
|
|
1162
|
+
accessQueue?: CollaborationAccess;
|
|
1163
|
+
/** Access control for entry points on Desktop Profile Collaboration tab */
|
|
1164
|
+
accessEntryPoint?: CollaborationAccess;
|
|
1165
|
+
/** Access control for buddy teams on Desktop Profile Collaboration tab */
|
|
1166
|
+
accessBuddyTeam?: CollaborationAccess;
|
|
1095
1167
|
/** Additional campaign manager information */
|
|
1096
1168
|
campaignManagerAdditionalInfo?: string;
|
|
1097
1169
|
/** Whether personal statistics are enabled */
|
|
@@ -1128,8 +1200,6 @@ export type Profile = {
|
|
|
1128
1200
|
isAnalyzerEnabled?: boolean;
|
|
1129
1201
|
/** Tenant timezone */
|
|
1130
1202
|
tenantTimezone?: string;
|
|
1131
|
-
/** Current environment (e.g., 'produs1', 'intgus1') */
|
|
1132
|
-
environment?: string;
|
|
1133
1203
|
/** Available voice login options */
|
|
1134
1204
|
loginVoiceOptions?: LoginOption[];
|
|
1135
1205
|
/** Current login device type */
|
|
@@ -1148,6 +1218,8 @@ export type Profile = {
|
|
|
1148
1218
|
maskSensitiveData?: boolean;
|
|
1149
1219
|
/** Whether agent is currently logged in */
|
|
1150
1220
|
isAgentLoggedIn?: boolean;
|
|
1221
|
+
/** Active station session after a successful registered relogin. */
|
|
1222
|
+
agentSessionId?: string;
|
|
1151
1223
|
/** Last auxiliary code ID used for state change */
|
|
1152
1224
|
lastStateAuxCodeId?: string;
|
|
1153
1225
|
/** Timestamp of last state change */
|
|
@@ -1156,6 +1228,12 @@ export type Profile = {
|
|
|
1156
1228
|
lastIdleCodeChangeTimestamp?: number;
|
|
1157
1229
|
/** AI feature flags resolved from organization config */
|
|
1158
1230
|
aiFeature?: AIFeatureFlags;
|
|
1231
|
+
/**
|
|
1232
|
+
* Whether Agent Wellness Break is effectively enabled for this profile.
|
|
1233
|
+
* This combines the organization wellbeing configuration with AI Assistant licensing;
|
|
1234
|
+
* Server-side rollout remains enforced by the backend configuration and notification delivery.
|
|
1235
|
+
*/
|
|
1236
|
+
isWellnessBreakEnabled?: boolean;
|
|
1159
1237
|
};
|
|
1160
1238
|
/**
|
|
1161
1239
|
* Contact distribution group configuration for routing logic
|
|
@@ -1213,3 +1291,51 @@ export type OutdialAniParams = {
|
|
|
1213
1291
|
/** Comma-separated list of attributes to include in response (optional) */
|
|
1214
1292
|
attributes?: string;
|
|
1215
1293
|
};
|
|
1294
|
+
/**
|
|
1295
|
+
* User preference data structure
|
|
1296
|
+
* @public
|
|
1297
|
+
*/
|
|
1298
|
+
export type UserPreference = {
|
|
1299
|
+
/** Unique identifier for the user preference */
|
|
1300
|
+
id: string;
|
|
1301
|
+
/** Organization ID */
|
|
1302
|
+
organizationId: string;
|
|
1303
|
+
/** User ID (CI user ID) */
|
|
1304
|
+
userId: string;
|
|
1305
|
+
/** User preference data as key-value pairs */
|
|
1306
|
+
preferences: Record<string, unknown>;
|
|
1307
|
+
/** Timestamp when this preference was created (Unix timestamp in milliseconds) */
|
|
1308
|
+
createdTime?: number;
|
|
1309
|
+
/** Timestamp when this preference was last updated (Unix timestamp in milliseconds) */
|
|
1310
|
+
lastUpdatedTime?: number;
|
|
1311
|
+
};
|
|
1312
|
+
/**
|
|
1313
|
+
* Request payload for creating user preferences
|
|
1314
|
+
* @public
|
|
1315
|
+
*/
|
|
1316
|
+
export type CreateUserPreferenceRequest = {
|
|
1317
|
+
/** User ID (CI user ID) */
|
|
1318
|
+
userId: string;
|
|
1319
|
+
/** Desktop preference data as a JSON string (required) */
|
|
1320
|
+
desktopPreference: string;
|
|
1321
|
+
};
|
|
1322
|
+
/**
|
|
1323
|
+
* Request payload for updating user preferences
|
|
1324
|
+
* @public
|
|
1325
|
+
*/
|
|
1326
|
+
export type UpdateUserPreferenceRequest = {
|
|
1327
|
+
/** Desktop preference data as a JSON string (required) */
|
|
1328
|
+
desktopPreference: string;
|
|
1329
|
+
};
|
|
1330
|
+
/**
|
|
1331
|
+
* Query parameters for fetching user preferences
|
|
1332
|
+
* @public
|
|
1333
|
+
*/
|
|
1334
|
+
export type GetUserPreferenceParams = {
|
|
1335
|
+
/** User ID to fetch preferences for. Defaults to current user's CI user ID. */
|
|
1336
|
+
userId?: string;
|
|
1337
|
+
/** Page number (0-indexed). Default: 0 */
|
|
1338
|
+
page?: number;
|
|
1339
|
+
/** Number of items per page. Default: 100 */
|
|
1340
|
+
pageSize?: number;
|
|
1341
|
+
};
|
|
@@ -28,6 +28,15 @@ export declare const WCC_CALLING_RTMS_DOMAIN = "wcc-calling-rtms-domain";
|
|
|
28
28
|
* @ignore
|
|
29
29
|
*/
|
|
30
30
|
export declare const DEFAULT_RTMS_DOMAIN = "rtw.prod-us1.rtmsprod.net";
|
|
31
|
+
/**
|
|
32
|
+
* Trusted domain suffix for RTMS hosts returned by the u2c service catalog. A catalog-provided
|
|
33
|
+
* RTMS host is only used when its hostname is, or is a subdomain of, this domain; otherwise
|
|
34
|
+
* `DEFAULT_RTMS_DOMAIN` is used.
|
|
35
|
+
* @type {string}
|
|
36
|
+
* @public
|
|
37
|
+
* @ignore
|
|
38
|
+
*/
|
|
39
|
+
export declare const ALLOWED_RTMS_DOMAIN = "rtmsprod.net";
|
|
31
40
|
/**
|
|
32
41
|
* Timeout in milliseconds for WebSocket events.
|
|
33
42
|
* @type {number}
|
|
@@ -49,6 +49,8 @@ export type TaskErrorIds = {
|
|
|
49
49
|
'Service.aqm.task.consultAccept': Failure;
|
|
50
50
|
} | {
|
|
51
51
|
'Service.aqm.task.consultConference': Failure;
|
|
52
|
+
} | {
|
|
53
|
+
'Service.aqm.task.dropConferenceParticipant': Failure;
|
|
52
54
|
} | {
|
|
53
55
|
'Service.aqm.task.consultEnd': Failure;
|
|
54
56
|
} | {
|