@webex/contact-center 3.12.0 → 3.13.0-next.2
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 +64 -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 +388 -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 +1102 -47
- package/dist/cc.js.map +1 -1
- package/dist/config.js +13 -0
- package/dist/config.js.map +1 -1
- package/dist/constants.js +46 -3
- package/dist/constants.js.map +1 -1
- package/dist/index.js +86 -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 +211 -0
- package/dist/metrics/behavioral-events.js.map +1 -1
- package/dist/metrics/constants.js +58 -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 +287 -37
- 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 +57 -79
- 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 +100 -40
- package/dist/services/config/types.js.map +1 -1
- package/dist/services/constants.js +19 -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 +26 -6
- package/dist/services/core/websocket/WebSocketManager.js.map +1 -1
- package/dist/services/core/websocket/connection-service.js +3 -1
- package/dist/services/core/websocket/connection-service.js.map +1 -1
- package/dist/services/core/websocket/types.js.map +1 -1
- package/dist/services/index.js +6 -0
- 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 +1275 -504
- 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 +22 -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/dialer.js +78 -0
- package/dist/services/task/dialer.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 +259 -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 +222 -10
- package/dist/types/config.d.ts +13 -0
- package/dist/types/constants.d.ts +40 -1
- package/dist/types/index.d.ts +58 -22
- package/dist/types/metrics/MetricsManager.d.ts +6 -0
- package/dist/types/metrics/constants.d.ts +52 -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 +252 -114
- package/dist/types/services/constants.d.ts +16 -0
- package/dist/types/services/core/Err.d.ts +6 -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 +2 -0
- package/dist/types/services/core/websocket/types.d.ts +1 -1
- package/dist/types/services/index.d.ts +2 -0
- 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 +20 -0
- package/dist/types/services/task/contact.d.ts +4 -0
- package/dist/types/services/task/dialer.d.ts +30 -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 +790 -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 +258 -11
- package/dist/types/utils/PageCache.d.ts +20 -3
- package/dist/types/webex.d.ts +1 -0
- package/dist/types.js +204 -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 +1439 -105
- package/src/config.ts +13 -0
- package/src/constants.ts +53 -1
- package/src/index.ts +72 -16
- 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 +218 -0
- package/src/metrics/constants.ts +63 -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 +362 -40
- 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 +64 -86
- package/src/services/config/index.ts +116 -277
- package/src/services/config/types.ts +238 -125
- package/src/services/constants.ts +18 -0
- package/src/services/core/Err.ts +3 -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 +37 -8
- package/src/services/core/websocket/connection-service.ts +5 -1
- package/src/services/core/websocket/types.ts +1 -1
- package/src/services/index.ts +4 -0
- package/src/services/task/Task.ts +1211 -0
- package/src/services/task/TaskFactory.ts +82 -0
- package/src/services/task/TaskManager.ts +1551 -584
- 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 +21 -0
- package/src/services/task/contact.ts +30 -0
- package/src/services/task/dialer.ts +80 -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 +974 -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 +323 -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 +4046 -181
- package/test/unit/spec/index.ts +891 -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 +484 -49
- 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 +318 -548
- 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 +132 -56
- package/test/unit/spec/services/core/websocket/connection-service.ts +3 -1
- 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 +4800 -1586
- 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/dialer.ts +190 -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 -1525
- 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 -1801
- package/test/unit/spec/services/task/index.ts +0 -2184
|
@@ -1,4 +1,5 @@
|
|
|
1
1
|
import * as Agent from '../agent/types';
|
|
2
|
+
import {COLLABORATION_ACCESS} from './constants';
|
|
2
3
|
|
|
3
4
|
/**
|
|
4
5
|
* Generic type for converting a const enum object into a union type of its values
|
|
@@ -6,8 +7,13 @@ import * as Agent from '../agent/types';
|
|
|
6
7
|
*/
|
|
7
8
|
type Enum<T extends Record<string, unknown>> = T[keyof T];
|
|
8
9
|
|
|
10
|
+
/** Desktop Profile access level for a collaboration destination category. */
|
|
11
|
+
export type CollaborationAccess = Enum<typeof COLLABORATION_ACCESS>;
|
|
12
|
+
|
|
9
13
|
/**
|
|
10
|
-
*
|
|
14
|
+
* Contact Center backend and realtime event types.
|
|
15
|
+
*
|
|
16
|
+
* Includes task lifecycle, transcript, suggested-response, and AI summary events.
|
|
11
17
|
* @enum {string}
|
|
12
18
|
* @private
|
|
13
19
|
* @ignore
|
|
@@ -57,6 +63,8 @@ export const CC_TASK_EVENTS = {
|
|
|
57
63
|
PARTICIPANT_LEFT_CONFERENCE: 'ParticipantLeftConference',
|
|
58
64
|
/** Event emitted when participant leaving conference fails */
|
|
59
65
|
PARTICIPANT_LEFT_CONFERENCE_FAILED: 'ParticipantLeftConferenceFailed',
|
|
66
|
+
/** Event emitted when dropping another conference participant fails */
|
|
67
|
+
PARTICIPANT_DROP_CONFERENCE_FAILED: 'ParticipantDropConferenceFailed',
|
|
60
68
|
/** Event emitted when consultation conference end fails */
|
|
61
69
|
AGENT_CONSULT_CONFERENCE_END_FAILED: 'AgentConsultConferenceEndFailed',
|
|
62
70
|
/** Event emitted when conference is successfully transferred */
|
|
@@ -65,6 +73,8 @@ export const CC_TASK_EVENTS = {
|
|
|
65
73
|
AGENT_CONFERENCE_TRANSFER_FAILED: 'AgentConferenceTransferFailed',
|
|
66
74
|
/** Event emitted for post-call activity by participant */
|
|
67
75
|
PARTICIPANT_POST_CALL_ACTIVITY: 'ParticipantPostCallActivity',
|
|
76
|
+
/** Event emitted when consulted participant is being moved/transferred */
|
|
77
|
+
CONSULTED_PARTICIPANT_MOVING: 'ConsultedParticipantMoving',
|
|
68
78
|
/** Event emitted when contact is blind transferred */
|
|
69
79
|
AGENT_BLIND_TRANSFERRED: 'AgentBlindTransferred',
|
|
70
80
|
/** Event emitted when blind transfer fails */
|
|
@@ -81,6 +91,8 @@ export const CC_TASK_EVENTS = {
|
|
|
81
91
|
AGENT_CONSULT_TRANSFER_FAILED: 'AgentConsultTransferFailed',
|
|
82
92
|
/** Event emitted when contact recording is paused */
|
|
83
93
|
CONTACT_RECORDING_PAUSED: 'ContactRecordingPaused',
|
|
94
|
+
/** Event emitted when contact recording is started */
|
|
95
|
+
CONTACT_RECORDING_STARTED: 'ContactRecordingStarted',
|
|
84
96
|
/** Event emitted when pausing contact recording fails */
|
|
85
97
|
CONTACT_RECORDING_PAUSE_FAILED: 'ContactRecordingPauseFailed',
|
|
86
98
|
/** Event emitted when contact recording is resumed */
|
|
@@ -91,6 +103,10 @@ export const CC_TASK_EVENTS = {
|
|
|
91
103
|
CONTACT_ENDED: 'ContactEnded',
|
|
92
104
|
/** Event emitted when contact is merged */
|
|
93
105
|
CONTACT_MERGED: 'ContactMerged',
|
|
106
|
+
/** Event emitted when contact payload is updated (routing updates) */
|
|
107
|
+
CONTACT_UPDATED: 'ContactUpdated',
|
|
108
|
+
/** Event emitted when contact owner changes */
|
|
109
|
+
CONTACT_OWNER_CHANGED: 'ContactOwnerChanged',
|
|
94
110
|
/** Event emitted when ending contact fails */
|
|
95
111
|
AGENT_CONTACT_END_FAILED: 'AgentContactEndFailed',
|
|
96
112
|
/** Event emitted when agent enters wrap-up state */
|
|
@@ -117,15 +133,30 @@ export const CC_TASK_EVENTS = {
|
|
|
117
133
|
CAMPAIGN_CONTACT_UPDATED: 'CampaignContactUpdated',
|
|
118
134
|
/** Event emitted when accepting a campaign preview contact fails */
|
|
119
135
|
CAMPAIGN_PREVIEW_ACCEPT_FAILED: 'CampaignPreviewAcceptFailed',
|
|
136
|
+
/** Event emitted when skipping a campaign preview contact fails */
|
|
137
|
+
CAMPAIGN_PREVIEW_SKIP_FAILED: 'CampaignPreviewSkipFailed',
|
|
138
|
+
/** Event emitted when removing a campaign preview contact fails */
|
|
139
|
+
CAMPAIGN_PREVIEW_REMOVE_FAILED: 'CampaignPreviewRemoveFailed',
|
|
120
140
|
/** Event emitted when a real-time transcript chunk is received */
|
|
121
141
|
REAL_TIME_TRANSCRIPTION: 'REAL_TIME_TRANSCRIPTION',
|
|
142
|
+
/** Event emitted when an AI assistant suggested response is available */
|
|
143
|
+
SUGGESTED_RESPONSE: 'SUGGESTED_RESPONSE',
|
|
144
|
+
/** Event emitted when backend acknowledges it is listening for more context */
|
|
145
|
+
SUGGESTED_RESPONSE_ACKNOWLEDGE: 'SUGGESTED_RESPONSE_ACKNOWLEDGE',
|
|
146
|
+
/** Event received when a post-call summary is available through realtime delivery */
|
|
147
|
+
POST_CALL_SUMMARY: 'POST_CALL_SUMMARY',
|
|
148
|
+
/** Event received when a mid-call summary is available through realtime delivery */
|
|
149
|
+
MID_CALL_SUMMARY: 'MID_CALL_SUMMARY',
|
|
150
|
+
/** Event received when AI-summary feature enablement is available through realtime delivery */
|
|
151
|
+
FEATURE_ENABLEMENT: 'FEATURE_ENABLEMENT',
|
|
152
|
+
/** Event received when a subsequent agent receives a mid-call summary */
|
|
153
|
+
MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT: 'MID_CALL_SUMMARY_RESPONSE_SUBSEQUENT_AGENT',
|
|
122
154
|
} as const;
|
|
123
155
|
|
|
124
156
|
/**
|
|
125
157
|
* Events emitted on Contact Center agent operations
|
|
126
158
|
* @enum {string}
|
|
127
|
-
* @
|
|
128
|
-
* @ignore
|
|
159
|
+
* @public
|
|
129
160
|
*/
|
|
130
161
|
export const CC_AGENT_EVENTS = {
|
|
131
162
|
/** Welcome event when agent connects to websocket/backend */
|
|
@@ -164,6 +195,8 @@ export const CC_AGENT_EVENTS = {
|
|
|
164
195
|
AGENT_BUDDY_AGENTS_RETRIEVE_FAILED: 'BuddyAgentsRetrieveFailed',
|
|
165
196
|
/** Event emitted when contact is reserved for agent */
|
|
166
197
|
AGENT_CONTACT_RESERVED: 'AgentContactReserved',
|
|
198
|
+
/** Agent-level Agent Wellness Break notification */
|
|
199
|
+
WELLNESS_BREAK: 'WellnessBreak',
|
|
167
200
|
} as const;
|
|
168
201
|
|
|
169
202
|
/**
|
|
@@ -176,6 +209,11 @@ export const CC_EVENTS = {
|
|
|
176
209
|
...CC_TASK_EVENTS,
|
|
177
210
|
} as const;
|
|
178
211
|
|
|
212
|
+
/** Public Contact Center browser voice event names. */
|
|
213
|
+
export enum VOICE_CONNECTION_EVENTS {
|
|
214
|
+
STATE_CHANGE = 'voice:connectionStateChange',
|
|
215
|
+
}
|
|
216
|
+
|
|
179
217
|
/**
|
|
180
218
|
* Event data received when agent connects to the system
|
|
181
219
|
* @public
|
|
@@ -185,6 +223,15 @@ export type WelcomeEvent = {
|
|
|
185
223
|
agentId: string;
|
|
186
224
|
};
|
|
187
225
|
|
|
226
|
+
/**
|
|
227
|
+
* Available login options for voice channel access
|
|
228
|
+
* 'AGENT_DN' - Login using agent's DN
|
|
229
|
+
* 'EXTENSION' - Login using extension number
|
|
230
|
+
* 'BROWSER' - Login using browser-based WebRTC
|
|
231
|
+
* @public
|
|
232
|
+
*/
|
|
233
|
+
export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
|
|
234
|
+
|
|
188
235
|
/**
|
|
189
236
|
* Response type for welcome events which can be either success or error
|
|
190
237
|
* @public
|
|
@@ -215,7 +262,7 @@ export type WebSocketEvent = {
|
|
|
215
262
|
};
|
|
216
263
|
|
|
217
264
|
/**
|
|
218
|
-
*
|
|
265
|
+
* Agent identity carried by the `user` section of the user desktop-login aggregate.
|
|
219
266
|
*/
|
|
220
267
|
export type AgentResponse = {
|
|
221
268
|
/**
|
|
@@ -248,16 +295,6 @@ export type AgentResponse = {
|
|
|
248
295
|
*/
|
|
249
296
|
email: string;
|
|
250
297
|
|
|
251
|
-
/**
|
|
252
|
-
* Team IDs assigned to the agent.
|
|
253
|
-
*/
|
|
254
|
-
teamIds: string[];
|
|
255
|
-
|
|
256
|
-
/**
|
|
257
|
-
* Multimedia profile ID associated with the agent.
|
|
258
|
-
*/
|
|
259
|
-
multimediaProfileId: string;
|
|
260
|
-
|
|
261
298
|
/**
|
|
262
299
|
* Skill profile ID of the agent.
|
|
263
300
|
*/
|
|
@@ -269,22 +306,25 @@ export type AgentResponse = {
|
|
|
269
306
|
siteId: string;
|
|
270
307
|
|
|
271
308
|
/**
|
|
272
|
-
* Database ID of the agent
|
|
309
|
+
* Database ID of the agent, distinct from `ciUserId`. Passed as `userDbId` to the team lookup,
|
|
310
|
+
* which sends it as the backend's `filter=userId==` value.
|
|
273
311
|
*/
|
|
274
|
-
dbId
|
|
312
|
+
dbId: string;
|
|
275
313
|
|
|
276
314
|
/**
|
|
277
315
|
* The default dialed number of the agent.
|
|
316
|
+
* Note: The API returns this field as "deafultDialledNumber" (with typo).
|
|
278
317
|
*/
|
|
279
|
-
|
|
318
|
+
deafultDialledNumber?: string;
|
|
280
319
|
};
|
|
281
320
|
|
|
282
321
|
/**
|
|
283
|
-
*
|
|
322
|
+
* Desktop Profile settings carried by the `agentProfile` section of the user desktop-login
|
|
323
|
+
* aggregate.
|
|
284
324
|
*/
|
|
285
|
-
export type
|
|
325
|
+
export type AgentProfile = {
|
|
286
326
|
/**
|
|
287
|
-
* Represents the voice options of an agent.
|
|
327
|
+
* Represents the voice options of an agent. The order is nondeterministic; treat as a set.
|
|
288
328
|
*/
|
|
289
329
|
loginVoiceOptions: LoginOption[];
|
|
290
330
|
|
|
@@ -298,16 +338,6 @@ export type DesktopProfileResponse = {
|
|
|
298
338
|
*/
|
|
299
339
|
accessIdleCode: string;
|
|
300
340
|
|
|
301
|
-
/**
|
|
302
|
-
* Wrap-up codes list that the agents can select when they wrap up a contact.
|
|
303
|
-
*/
|
|
304
|
-
wrapUpCodes: string[];
|
|
305
|
-
|
|
306
|
-
/**
|
|
307
|
-
* Idle codes list that the agents can select in Agent Desktop.
|
|
308
|
-
*/
|
|
309
|
-
idleCodes: string[];
|
|
310
|
-
|
|
311
341
|
/**
|
|
312
342
|
* Dial plan enabled for the agent.
|
|
313
343
|
*/
|
|
@@ -324,9 +354,9 @@ export type DesktopProfileResponse = {
|
|
|
324
354
|
autoWrapUp: boolean;
|
|
325
355
|
|
|
326
356
|
/**
|
|
327
|
-
*
|
|
357
|
+
* Whether the agent personal greeting is enabled.
|
|
328
358
|
*/
|
|
329
|
-
|
|
359
|
+
agentPersonalGreeting?: boolean;
|
|
330
360
|
|
|
331
361
|
/**
|
|
332
362
|
* Auto wrap-up after seconds.
|
|
@@ -343,6 +373,21 @@ export type DesktopProfileResponse = {
|
|
|
343
373
|
*/
|
|
344
374
|
allowAutoWrapUpExtension: boolean;
|
|
345
375
|
|
|
376
|
+
/**
|
|
377
|
+
* Access control for queues assigned to the agent (ALL, SPECIFIC, or NONE).
|
|
378
|
+
*/
|
|
379
|
+
accessQueue: CollaborationAccess;
|
|
380
|
+
|
|
381
|
+
/**
|
|
382
|
+
* Access control for entry points assigned to the agent.
|
|
383
|
+
*/
|
|
384
|
+
accessEntryPoint: CollaborationAccess;
|
|
385
|
+
|
|
386
|
+
/**
|
|
387
|
+
* Access control for buddy teams assigned to the agent.
|
|
388
|
+
*/
|
|
389
|
+
accessBuddyTeam: CollaborationAccess;
|
|
390
|
+
|
|
346
391
|
/**
|
|
347
392
|
* Outdial enabled for the agent.
|
|
348
393
|
*/
|
|
@@ -358,6 +403,11 @@ export type DesktopProfileResponse = {
|
|
|
358
403
|
*/
|
|
359
404
|
outdialANIId: string;
|
|
360
405
|
|
|
406
|
+
/**
|
|
407
|
+
* Whether the agent can schedule and manage callbacks.
|
|
408
|
+
*/
|
|
409
|
+
scheduleAndManageCallBack?: boolean;
|
|
410
|
+
|
|
361
411
|
/**
|
|
362
412
|
* Consult to queue allowed.
|
|
363
413
|
*/
|
|
@@ -366,19 +416,14 @@ export type DesktopProfileResponse = {
|
|
|
366
416
|
/**
|
|
367
417
|
* Address book ID of the agent.
|
|
368
418
|
*/
|
|
369
|
-
addressBookId
|
|
419
|
+
addressBookId?: string;
|
|
370
420
|
|
|
371
421
|
/**
|
|
372
422
|
* Viewable statistics of the agent.
|
|
373
423
|
*/
|
|
374
424
|
viewableStatistics: {
|
|
375
|
-
id: string;
|
|
376
425
|
agentStats: boolean;
|
|
377
|
-
|
|
378
|
-
contactServiceQueues: string[];
|
|
379
|
-
loggedInTeamStats: boolean;
|
|
380
|
-
accessTeamStats: string;
|
|
381
|
-
teams: string[];
|
|
426
|
+
aiAgentPerformance?: boolean;
|
|
382
427
|
};
|
|
383
428
|
|
|
384
429
|
/**
|
|
@@ -386,11 +431,6 @@ export type DesktopProfileResponse = {
|
|
|
386
431
|
*/
|
|
387
432
|
agentDNValidation: string;
|
|
388
433
|
|
|
389
|
-
/**
|
|
390
|
-
* Dial plans of the agent.
|
|
391
|
-
*/
|
|
392
|
-
dialPlans: string[];
|
|
393
|
-
|
|
394
434
|
/**
|
|
395
435
|
* Timeout desktop inactivity custom enabled.
|
|
396
436
|
*/
|
|
@@ -399,27 +439,7 @@ export type DesktopProfileResponse = {
|
|
|
399
439
|
/**
|
|
400
440
|
* Timeout desktop inactivity minutes.
|
|
401
441
|
*/
|
|
402
|
-
timeoutDesktopInactivityMins
|
|
403
|
-
|
|
404
|
-
/**
|
|
405
|
-
* Show user details in Microsoft enabled or not.
|
|
406
|
-
*/
|
|
407
|
-
showUserDetailsMS: boolean;
|
|
408
|
-
|
|
409
|
-
/**
|
|
410
|
-
* State synchronization in Microsoft enabled or not.
|
|
411
|
-
*/
|
|
412
|
-
stateSynchronizationMS: boolean;
|
|
413
|
-
|
|
414
|
-
/**
|
|
415
|
-
* Show user details in Webex enabled or not.
|
|
416
|
-
*/
|
|
417
|
-
showUserDetailsWebex: boolean;
|
|
418
|
-
|
|
419
|
-
/**
|
|
420
|
-
* State synchronization in Webex enabled or not.
|
|
421
|
-
*/
|
|
422
|
-
stateSynchronizationWebex: boolean;
|
|
442
|
+
timeoutDesktopInactivityMins?: number;
|
|
423
443
|
};
|
|
424
444
|
|
|
425
445
|
/**
|
|
@@ -579,7 +599,8 @@ export type ListTeamsResponse = {
|
|
|
579
599
|
};
|
|
580
600
|
|
|
581
601
|
/**
|
|
582
|
-
* Basic organization information
|
|
602
|
+
* Basic organization information carried by the `organization` section of the org desktop-login
|
|
603
|
+
* aggregate.
|
|
583
604
|
* @private
|
|
584
605
|
* @ignore
|
|
585
606
|
*/
|
|
@@ -588,12 +609,11 @@ export type OrgInfo = {
|
|
|
588
609
|
tenantId: string;
|
|
589
610
|
/** Organization timezone */
|
|
590
611
|
timezone: string;
|
|
591
|
-
/** Current environment (e.g., 'produs1', 'intgus1') */
|
|
592
|
-
environment: string;
|
|
593
612
|
};
|
|
594
613
|
|
|
595
614
|
/**
|
|
596
|
-
* Organization-wide feature settings
|
|
615
|
+
* Organization-wide feature settings carried by the `organizationSetting` section of the org
|
|
616
|
+
* desktop-login aggregate.
|
|
597
617
|
* @private
|
|
598
618
|
*/
|
|
599
619
|
export type OrgSettings = {
|
|
@@ -603,6 +623,8 @@ export type OrgSettings = {
|
|
|
603
623
|
maskSensitiveData: boolean;
|
|
604
624
|
/** Whether campaign manager features are enabled */
|
|
605
625
|
campaignManagerEnabled: boolean;
|
|
626
|
+
/** Number of AI Assistant licenses assigned to the organization */
|
|
627
|
+
aiAssistantQuantity?: number | null;
|
|
606
628
|
};
|
|
607
629
|
|
|
608
630
|
/**
|
|
@@ -623,12 +645,13 @@ export type SiteInfo = {
|
|
|
623
645
|
};
|
|
624
646
|
|
|
625
647
|
/**
|
|
626
|
-
* Tenant-level configuration
|
|
648
|
+
* Tenant-level configuration carried by the `tenantConfiguration` section of the org
|
|
649
|
+
* desktop-login aggregate.
|
|
627
650
|
* @private
|
|
628
651
|
*/
|
|
629
652
|
export type TenantData = {
|
|
630
|
-
/** Desktop inactivity timeout in minutes */
|
|
631
|
-
timeoutDesktopInactivityMins
|
|
653
|
+
/** Desktop inactivity timeout in minutes. Omitted when the timeout is not enabled. */
|
|
654
|
+
timeoutDesktopInactivityMins?: number;
|
|
632
655
|
/** Whether default DN is enforced */
|
|
633
656
|
forceDefaultDn: boolean;
|
|
634
657
|
/** Regex pattern for default DN validation */
|
|
@@ -652,16 +675,46 @@ export type TenantData = {
|
|
|
652
675
|
};
|
|
653
676
|
|
|
654
677
|
/**
|
|
655
|
-
* URL
|
|
678
|
+
* URL mappings carried by the `urlMappings` section of the org desktop-login aggregate, keyed by
|
|
679
|
+
* mapping name. The aggregate returns `{}` when the organization has no Acqueon configuration.
|
|
656
680
|
* @public
|
|
657
681
|
*/
|
|
658
|
-
export type
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
682
|
+
export type OrgUrlMappings = {
|
|
683
|
+
/** Acqueon API endpoint URL */
|
|
684
|
+
ACQUEON_API_URL?: string;
|
|
685
|
+
/** Acqueon console URL */
|
|
686
|
+
ACQUEON_CONSOLE_URL?: string;
|
|
687
|
+
};
|
|
688
|
+
|
|
689
|
+
/**
|
|
690
|
+
* Organization-level Microsoft Teams integration configuration carried by the `microsoftConfig`
|
|
691
|
+
* section of the org desktop-login aggregate. The whole section is absent when the organization
|
|
692
|
+
* has no Microsoft integration.
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
export type MicrosoftConfig = {
|
|
696
|
+
/** Whether to show user details in Teams */
|
|
697
|
+
showUserDetails?: boolean;
|
|
698
|
+
/** Whether to sync agent state with Teams */
|
|
699
|
+
stateSynchronization?: boolean;
|
|
700
|
+
/** Whether the integration is enabled organization-wide */
|
|
701
|
+
active?: boolean;
|
|
702
|
+
/** Idle codes mapped to Teams presence states */
|
|
703
|
+
idleCodes?: Record<string, string>;
|
|
704
|
+
};
|
|
705
|
+
|
|
706
|
+
/**
|
|
707
|
+
* Organization-level Webex integration configuration carried by the `webexConfig` section of the
|
|
708
|
+
* org desktop-login aggregate.
|
|
709
|
+
* @public
|
|
710
|
+
*/
|
|
711
|
+
export type WebexConfig = {
|
|
712
|
+
/** Whether to show user details in Webex */
|
|
713
|
+
showUserDetails?: boolean;
|
|
714
|
+
/** Whether to sync agent state with Webex */
|
|
715
|
+
stateSynchronization?: boolean;
|
|
716
|
+
/** Idle codes mapped to Webex presence states */
|
|
717
|
+
idleCodes?: Record<string, string>;
|
|
665
718
|
};
|
|
666
719
|
|
|
667
720
|
/**
|
|
@@ -759,6 +812,8 @@ export type DialPlanEntity = {
|
|
|
759
812
|
strippedChars: string;
|
|
760
813
|
/** Name of the dial plan */
|
|
761
814
|
name: string;
|
|
815
|
+
/** Whether the dial plan is active */
|
|
816
|
+
active: boolean;
|
|
762
817
|
};
|
|
763
818
|
|
|
764
819
|
/**
|
|
@@ -866,28 +921,6 @@ export type WrapupData = {
|
|
|
866
921
|
};
|
|
867
922
|
};
|
|
868
923
|
|
|
869
|
-
/**
|
|
870
|
-
* Available login options for voice channel access
|
|
871
|
-
* 'AGENT_DN' - Login using agent's DN
|
|
872
|
-
* 'EXTENSION' - Login using extension number
|
|
873
|
-
* 'BROWSER' - Login using browser-based WebRTC
|
|
874
|
-
* @public
|
|
875
|
-
*/
|
|
876
|
-
export type LoginOption = 'AGENT_DN' | 'EXTENSION' | 'BROWSER';
|
|
877
|
-
|
|
878
|
-
/**
|
|
879
|
-
* Team configuration information
|
|
880
|
-
* @public
|
|
881
|
-
*/
|
|
882
|
-
export type Team = {
|
|
883
|
-
/** Unique team identifier */
|
|
884
|
-
teamId: string;
|
|
885
|
-
/** Team display name */
|
|
886
|
-
teamName: string;
|
|
887
|
-
/** Optional desktop layout configuration identifier */
|
|
888
|
-
desktopLayoutId?: string;
|
|
889
|
-
};
|
|
890
|
-
|
|
891
924
|
/**
|
|
892
925
|
* Basic queue configuration information
|
|
893
926
|
* @public
|
|
@@ -911,11 +944,12 @@ export type URLMappings = {
|
|
|
911
944
|
};
|
|
912
945
|
|
|
913
946
|
/**
|
|
914
|
-
* AI feature
|
|
947
|
+
* AI feature flags carried by the `aiFeature` section of the org desktop-login aggregate.
|
|
915
948
|
* @public
|
|
916
949
|
*/
|
|
917
950
|
export type AIFeatureFlags = {
|
|
918
|
-
id
|
|
951
|
+
/** Not carried by the aggregate; retained for responses that still supply a record id. */
|
|
952
|
+
id?: string;
|
|
919
953
|
realtimeTranscripts?: {
|
|
920
954
|
enable?: boolean;
|
|
921
955
|
agentInclusionType?: string;
|
|
@@ -940,27 +974,42 @@ export type AIFeatureFlags = {
|
|
|
940
974
|
queuesInclusionType?: string;
|
|
941
975
|
surveyDataSource?: string;
|
|
942
976
|
};
|
|
943
|
-
links?: string[];
|
|
944
|
-
createdTime?: number;
|
|
945
|
-
lastUpdatedTime?: number;
|
|
946
977
|
};
|
|
947
978
|
|
|
948
979
|
/**
|
|
949
|
-
*
|
|
980
|
+
* Aggregated organization configuration returned by `organization/{orgId}/desktop-login`.
|
|
981
|
+
* Replaces the separate organization, organization-setting, tenant-configuration,
|
|
982
|
+
* org-url-mapping and ai-feature calls.
|
|
950
983
|
* @public
|
|
951
984
|
*/
|
|
952
|
-
export type
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
985
|
+
export type OrgDesktopLoginResponse = {
|
|
986
|
+
/** Organization identity and timezone */
|
|
987
|
+
organization: OrgInfo;
|
|
988
|
+
/** Organization-wide feature settings */
|
|
989
|
+
organizationSetting: OrgSettings;
|
|
990
|
+
/** Tenant-level configuration */
|
|
991
|
+
tenantConfiguration: TenantData;
|
|
992
|
+
/** External integration URLs, keyed by mapping name */
|
|
993
|
+
urlMappings?: OrgUrlMappings;
|
|
994
|
+
/** AI feature flags */
|
|
995
|
+
aiFeature?: AIFeatureFlags;
|
|
996
|
+
/** Microsoft Teams integration configuration; absent when not configured */
|
|
997
|
+
microsoftConfig?: MicrosoftConfig;
|
|
998
|
+
/** Webex integration configuration */
|
|
999
|
+
webexConfig?: WebexConfig;
|
|
1000
|
+
};
|
|
1001
|
+
|
|
1002
|
+
/**
|
|
1003
|
+
* Aggregated user configuration returned by
|
|
1004
|
+
* `organization/{orgId}/v2/user/by-ci-user-id/{ciUserId}/desktop-login`.
|
|
1005
|
+
* Replaces the separate user and agent-profile calls.
|
|
1006
|
+
* @public
|
|
1007
|
+
*/
|
|
1008
|
+
export type UserDesktopLoginResponse = {
|
|
1009
|
+
/** Agent identity */
|
|
1010
|
+
user: AgentResponse;
|
|
1011
|
+
/** Desktop Profile settings for the agent */
|
|
1012
|
+
agentProfile: AgentProfile;
|
|
964
1013
|
};
|
|
965
1014
|
|
|
966
1015
|
/**
|
|
@@ -983,8 +1032,8 @@ export type Profile = {
|
|
|
983
1032
|
/** Whether to sync agent state with Webex */
|
|
984
1033
|
stateSynchronizationWebex?: boolean;
|
|
985
1034
|
};
|
|
986
|
-
/** List of teams the agent belongs to */
|
|
987
|
-
teams:
|
|
1035
|
+
/** List of teams the agent belongs to, as returned by the team API */
|
|
1036
|
+
teams: TeamList[];
|
|
988
1037
|
/** Agent's default dial number */
|
|
989
1038
|
defaultDn: string;
|
|
990
1039
|
dn?: string;
|
|
@@ -1047,7 +1096,7 @@ export type Profile = {
|
|
|
1047
1096
|
/** Outbound entry point */
|
|
1048
1097
|
outDialEp: string;
|
|
1049
1098
|
/** Whether ending calls is enabled */
|
|
1050
|
-
|
|
1099
|
+
isEndTaskEnabled: boolean;
|
|
1051
1100
|
/** Whether ending consultations is enabled */
|
|
1052
1101
|
isEndConsultEnabled: boolean;
|
|
1053
1102
|
/** Optional lifecycle manager URL */
|
|
@@ -1058,6 +1107,12 @@ export type Profile = {
|
|
|
1058
1107
|
agentAnalyzerId?: string;
|
|
1059
1108
|
/** Whether consult to queue is allowed */
|
|
1060
1109
|
allowConsultToQueue: boolean;
|
|
1110
|
+
/** Access control for queues on Desktop Profile Collaboration tab */
|
|
1111
|
+
accessQueue?: CollaborationAccess;
|
|
1112
|
+
/** Access control for entry points on Desktop Profile Collaboration tab */
|
|
1113
|
+
accessEntryPoint?: CollaborationAccess;
|
|
1114
|
+
/** Access control for buddy teams on Desktop Profile Collaboration tab */
|
|
1115
|
+
accessBuddyTeam?: CollaborationAccess;
|
|
1061
1116
|
/** Additional campaign manager information */
|
|
1062
1117
|
campaignManagerAdditionalInfo?: string;
|
|
1063
1118
|
/** Whether personal statistics are enabled */
|
|
@@ -1094,8 +1149,6 @@ export type Profile = {
|
|
|
1094
1149
|
isAnalyzerEnabled?: boolean;
|
|
1095
1150
|
/** Tenant timezone */
|
|
1096
1151
|
tenantTimezone?: string;
|
|
1097
|
-
/** Current environment (e.g., 'produs1', 'intgus1') */
|
|
1098
|
-
environment?: string;
|
|
1099
1152
|
/** Available voice login options */
|
|
1100
1153
|
loginVoiceOptions?: LoginOption[];
|
|
1101
1154
|
/** Current login device type */
|
|
@@ -1114,6 +1167,8 @@ export type Profile = {
|
|
|
1114
1167
|
maskSensitiveData?: boolean;
|
|
1115
1168
|
/** Whether agent is currently logged in */
|
|
1116
1169
|
isAgentLoggedIn?: boolean;
|
|
1170
|
+
/** Active station session after a successful registered relogin. */
|
|
1171
|
+
agentSessionId?: string;
|
|
1117
1172
|
/** Last auxiliary code ID used for state change */
|
|
1118
1173
|
lastStateAuxCodeId?: string;
|
|
1119
1174
|
/** Timestamp of last state change */
|
|
@@ -1122,6 +1177,12 @@ export type Profile = {
|
|
|
1122
1177
|
lastIdleCodeChangeTimestamp?: number;
|
|
1123
1178
|
/** AI feature flags resolved from organization config */
|
|
1124
1179
|
aiFeature?: AIFeatureFlags;
|
|
1180
|
+
/**
|
|
1181
|
+
* Whether Agent Wellness Break is effectively enabled for this profile.
|
|
1182
|
+
* This combines the organization wellbeing configuration with AI Assistant licensing;
|
|
1183
|
+
* Server-side rollout remains enforced by the backend configuration and notification delivery.
|
|
1184
|
+
*/
|
|
1185
|
+
isWellnessBreakEnabled?: boolean;
|
|
1125
1186
|
};
|
|
1126
1187
|
|
|
1127
1188
|
/**
|
|
@@ -1183,3 +1244,55 @@ export type OutdialAniParams = {
|
|
|
1183
1244
|
/** Comma-separated list of attributes to include in response (optional) */
|
|
1184
1245
|
attributes?: string;
|
|
1185
1246
|
};
|
|
1247
|
+
|
|
1248
|
+
/**
|
|
1249
|
+
* User preference data structure
|
|
1250
|
+
* @public
|
|
1251
|
+
*/
|
|
1252
|
+
export type UserPreference = {
|
|
1253
|
+
/** Unique identifier for the user preference */
|
|
1254
|
+
id: string;
|
|
1255
|
+
/** Organization ID */
|
|
1256
|
+
organizationId: string;
|
|
1257
|
+
/** User ID (CI user ID) */
|
|
1258
|
+
userId: string;
|
|
1259
|
+
/** User preference data as key-value pairs */
|
|
1260
|
+
preferences: Record<string, unknown>;
|
|
1261
|
+
/** Timestamp when this preference was created (Unix timestamp in milliseconds) */
|
|
1262
|
+
createdTime?: number;
|
|
1263
|
+
/** Timestamp when this preference was last updated (Unix timestamp in milliseconds) */
|
|
1264
|
+
lastUpdatedTime?: number;
|
|
1265
|
+
};
|
|
1266
|
+
|
|
1267
|
+
/**
|
|
1268
|
+
* Request payload for creating user preferences
|
|
1269
|
+
* @public
|
|
1270
|
+
*/
|
|
1271
|
+
export type CreateUserPreferenceRequest = {
|
|
1272
|
+
/** User ID (CI user ID) */
|
|
1273
|
+
userId: string;
|
|
1274
|
+
/** Desktop preference data as a JSON string (required) */
|
|
1275
|
+
desktopPreference: string;
|
|
1276
|
+
};
|
|
1277
|
+
|
|
1278
|
+
/**
|
|
1279
|
+
* Request payload for updating user preferences
|
|
1280
|
+
* @public
|
|
1281
|
+
*/
|
|
1282
|
+
export type UpdateUserPreferenceRequest = {
|
|
1283
|
+
/** Desktop preference data as a JSON string (required) */
|
|
1284
|
+
desktopPreference: string;
|
|
1285
|
+
};
|
|
1286
|
+
|
|
1287
|
+
/**
|
|
1288
|
+
* Query parameters for fetching user preferences
|
|
1289
|
+
* @public
|
|
1290
|
+
*/
|
|
1291
|
+
export type GetUserPreferenceParams = {
|
|
1292
|
+
/** User ID to fetch preferences for. Defaults to current user's CI user ID. */
|
|
1293
|
+
userId?: string;
|
|
1294
|
+
/** Page number (0-indexed). Default: 0 */
|
|
1295
|
+
page?: number;
|
|
1296
|
+
/** Number of items per page. Default: 100 */
|
|
1297
|
+
pageSize?: number;
|
|
1298
|
+
};
|
|
@@ -32,6 +32,16 @@ export const WCC_CALLING_RTMS_DOMAIN = 'wcc-calling-rtms-domain';
|
|
|
32
32
|
*/
|
|
33
33
|
export const DEFAULT_RTMS_DOMAIN = 'rtw.prod-us1.rtmsprod.net';
|
|
34
34
|
|
|
35
|
+
/**
|
|
36
|
+
* Trusted domain suffix for RTMS hosts returned by the u2c service catalog. A catalog-provided
|
|
37
|
+
* RTMS host is only used when its hostname is, or is a subdomain of, this domain; otherwise
|
|
38
|
+
* `DEFAULT_RTMS_DOMAIN` is used.
|
|
39
|
+
* @type {string}
|
|
40
|
+
* @public
|
|
41
|
+
* @ignore
|
|
42
|
+
*/
|
|
43
|
+
export const ALLOWED_RTMS_DOMAIN = 'rtmsprod.net';
|
|
44
|
+
|
|
35
45
|
/**
|
|
36
46
|
* Timeout in milliseconds for WebSocket events.
|
|
37
47
|
* @type {number}
|
|
@@ -59,6 +69,14 @@ export const AGENT = 'agent';
|
|
|
59
69
|
*/
|
|
60
70
|
export const SUBSCRIBE_API = 'v1/notification/subscribe';
|
|
61
71
|
|
|
72
|
+
/**
|
|
73
|
+
* API path for realtime transcription subscription.
|
|
74
|
+
* @type {string}
|
|
75
|
+
* @public
|
|
76
|
+
* @ignore
|
|
77
|
+
*/
|
|
78
|
+
export const RTD_SUBSCRIBE_API = 'v1/realtime/subscribe';
|
|
79
|
+
|
|
62
80
|
/**
|
|
63
81
|
* API path for agent login.
|
|
64
82
|
* @type {string}
|
package/src/services/core/Err.ts
CHANGED
|
@@ -30,6 +30,7 @@ export type TaskErrorIds =
|
|
|
30
30
|
| {'Service.aqm.err.trackingId': {trackingId: string}}
|
|
31
31
|
| {'Service.aqm.task.consultAccept': Failure}
|
|
32
32
|
| {'Service.aqm.task.consultConference': Failure}
|
|
33
|
+
| {'Service.aqm.task.dropConferenceParticipant': Failure}
|
|
33
34
|
| {'Service.aqm.task.consultEnd': Failure}
|
|
34
35
|
| {'Service.aqm.task.cancelCtq': Failure}
|
|
35
36
|
| {'Service.aqm.task.hold': Failure}
|
|
@@ -39,6 +40,8 @@ export type TaskErrorIds =
|
|
|
39
40
|
| {'Service.aqm.task.resumeRecording': Failure}
|
|
40
41
|
| {'Service.aqm.dialer.startOutdial': Failure}
|
|
41
42
|
| {'Service.aqm.dialer.acceptPreviewContact': Failure}
|
|
43
|
+
| {'Service.aqm.dialer.skipPreviewContact': Failure}
|
|
44
|
+
| {'Service.aqm.dialer.removePreviewContact': Failure}
|
|
42
45
|
| {'Service.reqs.generic.failure': {trackingId: string}};
|
|
43
46
|
|
|
44
47
|
export type ReqError =
|